helper

Documentation

Index

• func CheckHCLKeys(node ast.Node, valid []string) error
• func CheckNamespaceScope(provided string, requested []string) []string
• func CleanEnvVar(s string, r byte) string
• func CleanFilename(filename string, replace string) string
• func CleanFilenameASCIIOnly(filename string, replace string) string
• func CleanFilenameStrict(filename string, replace string) string
• func CompareMapStringString(a, b map[string]string) bool
• func CompareSliceSetString(a, b []string) bool
• func CompareTimePtrs(a, b *time.Duration) bool
• func CopyMap[M ~map[K]V, K comparable, V any](m M) M
• func CopyMapStringFloat64(m map[string]float64) map[string]float64
• func CopyMapStringInt(m map[string]int) map[string]int
• func CopyMapStringInterface(m map[string]interface{}) map[string]interface{}
• func CopyMapStringSliceString(m map[string][]string) map[string][]string
• func CopyMapStringString(m map[string]string) map[string]string
• func CopyMapStringStruct(m map[string]struct{}) map[string]struct{}
• func CopySliceInt(s []int) []int
• func CopySliceString(s []string) []string
• func ElementsEquals[T EqualsFunc[T]](a, b []T) bool
• func HashUUID(input string) (output string, hashed bool)
• func IsMethodHTTP(s string) bool
• func IsUUID(str string) bool
• func IsValidInterpVariable(str string) bool
• func MapStringStringSliceValueSet(m map[string][]string) []string
• func Max[T constraints.Ordered](a, b T) T
• func Min[T constraints.Ordered](a, b T) T
• func PathEscapesSandbox(sandboxDir, path string) bool
• func RemoveEqualFold(xs *[]string, search string)
• func SliceSetDisjoint(first, second []string) (bool, []string)
• func SliceStringContains(list []string, item string) bool
• func SliceStringHasPrefix(list []string, prefix string) bool
• func SliceStringIsSubset(larger, smaller []string) (bool, []string)
• func SliceStringToSet(s []string) map[string]struct{}
• func StringHasPrefixInSlice(s string, prefixes []string) bool
• func UnusedKeys(obj interface{}) error
• type EqualsFunc
• type StopFunc
  • func NewSafeTimer(duration time.Duration) (*time.Timer, StopFunc)

Functions

func CheckHCLKeys

func CheckHCLKeys(node ast.Node, valid []string) error

func CheckNamespaceScope

func CheckNamespaceScope(provided string, requested []string) []string

CheckNamespaceScope ensures that the provided namespace is equal to or a parent of the requested namespaces. Returns requested namespaces which are not equal to or a child of the provided namespace.

func CleanEnvVar

func CleanEnvVar(s string, r byte) string

CleanEnvVar replaces all occurrences of illegal characters in an environment variable with the specified byte.

func CleanFilename

func CleanFilename(filename string, replace string) string

CleanFilename replaces invalid characters in filename

func CleanFilenameASCIIOnly

func CleanFilenameASCIIOnly(filename string, replace string) string

CleanFilenameASCIIOnly replaces invalid and non-ASCII characters in filename

func CleanFilenameStrict

func CleanFilenameStrict(filename string, replace string) string

CleanFilenameStrict replaces invalid and punctuation characters in filename

func CompareMapStringString

func CompareMapStringString(a, b map[string]string) bool

CompareMapStringString returns true if the maps are equivalent. A nil and empty map are considered not equal.

func CompareSliceSetString

func CompareSliceSetString(a, b []string) bool

CompareSliceSetString returns true if the slices contain the same strings. Order is ignored. The slice may be copied but is never altered. The slice is assumed to be a set. Multiple instances of an entry are treated the same as a single instance.

func CompareTimePtrs

func CompareTimePtrs(a, b *time.Duration) bool

CompareTimePtrs return true if a is the same as b.

func CopyMap

func CopyMap[M ~map[K]V, K comparable, V any](m M) M

CopyMap creates a copy of m. Struct values are not deep copies.

If m is nil or contains no elements, the return value is nil.

func CopyMapStringFloat64

func CopyMapStringFloat64(m map[string]float64) map[string]float64

CopyMapStringFloat64 creates a copy of m.

Deprecated; use CopyMap instead.

func CopyMapStringInt

func CopyMapStringInt(m map[string]int) map[string]int

func CopyMapStringInterface

func CopyMapStringInterface(m map[string]interface{}) map[string]interface{}

CopyMapStringInterface creates a copy of m.

Deprecated; use CopyMap instead.

func CopyMapStringSliceString

func CopyMapStringSliceString(m map[string][]string) map[string][]string

CopyMapStringSliceString copies a map of strings to string slices such as http.Header

func CopyMapStringString

func CopyMapStringString(m map[string]string) map[string]string

CopyMapStringString creates a copy of m.

Deprecated; use CopyMap instead.

func CopyMapStringStruct

func CopyMapStringStruct(m map[string]struct{}) map[string]struct{}

CopyMapStringStruct creates a copy of m.

Deprecated; use CopyMap instead.

func CopySliceInt

func CopySliceInt(s []int) []int

CopySliceInt creates a copy of s.

Deprecated; use slices.Clone instead.

func CopySliceString

func CopySliceString(s []string) []string

CopySliceString creates a copy of s.

Deprecated; use slices.Clone instead.

func ElementsEquals

func ElementsEquals[T EqualsFunc[T]](a, b []T) bool

ElementsEquals returns true if slices a and b contain the same elements (in no particular order) using the Equals function defined on their type for comparison.

func HashUUID

func HashUUID(input string) (output string, hashed bool)

HashUUID takes an input UUID and returns a hashed version of the UUID to ensure it is well distributed.

func IsMethodHTTP

func IsMethodHTTP(s string) bool

IsMethodHTTP returns whether s is a known HTTP method, ignoring case.

func IsUUID

func IsUUID(str string) bool

IsUUID returns true if the given string is a valid UUID.

func IsValidInterpVariable

func IsValidInterpVariable(str string) bool

IsValidInterpVariable returns true if a valid dotted variable names for interpolation. The string must begin with one or more non-dot characters which may be followed by sequences containing a dot followed by a one or more non-dot characters.

func MapStringStringSliceValueSet

func MapStringStringSliceValueSet(m map[string][]string) []string

MapStringStringSliceValueSet returns the set of values in a map[string][]string

func Max

func Max[T constraints.Ordered](a, b T) T

Max returns the maximum of a and b.

func Min

func Min[T constraints.Ordered](a, b T) T

Min returns the minimum of a and b.

func PathEscapesSandbox

func PathEscapesSandbox(sandboxDir, path string) bool

PathEscapesSandbox returns whether previously cleaned path inside the sandbox directory (typically this will be the allocation directory) escapes.

func RemoveEqualFold

func RemoveEqualFold(xs *[]string, search string)

RemoveEqualFold removes the first string that EqualFold matches. It updates xs in place

func SliceSetDisjoint

func SliceSetDisjoint(first, second []string) (bool, []string)

func SliceStringContains

func SliceStringContains(list []string, item string) bool

SliceStringContains returns whether item exists at least once in list.

func SliceStringHasPrefix

func SliceStringHasPrefix(list []string, prefix string) bool

SliceStringHasPrefix returns true if any string in list starts with prefix

func SliceStringIsSubset

func SliceStringIsSubset(larger, smaller []string) (bool, []string)

SliceStringIsSubset returns whether the smaller set of strings is a subset of the larger. If the smaller slice is not a subset, the offending elements are returned.

func SliceStringToSet

func SliceStringToSet(s []string) map[string]struct{}

func StringHasPrefixInSlice

func StringHasPrefixInSlice(s string, prefixes []string) bool

StringHasPrefixInSlice returns true if string starts with any prefix in list

func UnusedKeys

func UnusedKeys(obj interface{}) error

UnusedKeys returns a pretty-printed error if any `hcl:",unusedKeys"` is not empty

Types

type EqualsFunc

type EqualsFunc[A any] interface {
	Equals(A) bool
}

EqualsFunc represents a type implementing the Equals method.

type StopFunc

type StopFunc func()

StopFunc is used to stop a time.Timer created with NewSafeTimer

func NewSafeTimer

func NewSafeTimer(duration time.Duration) (*time.Timer, StopFunc)

NewSafeTimer creates a time.Timer but does not panic if duration is <= 0.

Using a time.Timer is recommended instead of time.After when it is necessary to avoid leaking goroutines (e.g. in a select inside a loop).

Returns the time.Timer and also a StopFunc, forcing the caller to deal with stopping the time.Timer to avoid leaking a goroutine.