helper

Documentation

Index

• func BoolToPtr(b bool) *bool
• 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 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 Float64ToPtr(f float64) *float64
• func HashUUID(input string) (output string, hashed bool)
• func Int64ToPtr(i int64) *int64
• func Int8ToPtr(i int8) *int8
• func IntMax(a, b int) int
• func IntMin(a, b int) int
• func IntToPtr(i int) *int
• func IsUUID(str string) bool
• func IsValidInterpVariable(str string) bool
• func MapStringStringSliceValueSet(m map[string][]string) []string
• 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 StringToPtr(str string) *string
• func TimeToPtr(t time.Duration) *time.Duration
• func Uint64Max(a, b uint64) uint64
• func Uint64ToPtr(u uint64) *uint64
• func UintToPtr(u uint) *uint
• func UnusedKeys(obj interface{}) error
• type StopFunc
  • func NewSafeTimer(duration time.Duration) (*time.Timer, StopFunc)

Functions

func BoolToPtr

func BoolToPtr(b bool) *bool

boolToPtr returns the pointer to a boolean

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 CopyMapStringFloat64

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

func CopyMapStringInt

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

func CopyMapStringInterface

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

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

Helpers for copying generic structures.

func CopyMapStringStruct

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

func CopySliceInt

func CopySliceInt(s []int) []int

func CopySliceString

func CopySliceString(s []string) []string

func Float64ToPtr

func Float64ToPtr(f float64) *float64

Float64ToPtr returns the pointer to an float64

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 Int64ToPtr

func Int64ToPtr(i int64) *int64

Int64ToPtr returns the pointer to an int

func Int8ToPtr

func Int8ToPtr(i int8) *int8

Int8ToPtr returns the pointer to an int8

func IntMax

func IntMax(a, b int) int

func IntMin

func IntMin(a, b int) int

func IntToPtr

func IntToPtr(i int) *int

IntToPtr returns the pointer to an int

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 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 StringToPtr

func StringToPtr(str string) *string

StringToPtr returns the pointer to a string

func TimeToPtr

func TimeToPtr(t time.Duration) *time.Duration

TimeToPtr returns the pointer to a time.Duration.

func Uint64Max

func Uint64Max(a, b uint64) uint64

func Uint64ToPtr

func Uint64ToPtr(u uint64) *uint64

Uint64ToPtr returns the pointer to an uint64

func UintToPtr

func UintToPtr(u uint) *uint

UintToPtr returns the pointer to an uint

func UnusedKeys

func UnusedKeys(obj interface{}) error

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

Types

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.