Documentation
¶
Overview ¶
These functions are coming from consul/lib/cluster.go
These functions are coming from consul/lib/eof.go
These functions are coming from consul/lib/math.go
These functions are coming from consul/path.go
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 EnsurePath(path string, dir bool) error
- func HashUUID(input string) (output string, hashed bool)
- func IsErrEOF(err error) 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 MaxInt(a, b int) int
- func MergeMapStringString(m map[string]string, n map[string]string) map[string]string
- func Min[T constraints.Ordered](a, b T) T
- func MinInt(a, b int) int
- func PathEscapesSandbox(sandboxDir, path string) bool
- func RandomStagger(intv time.Duration) time.Duration
- func RateScaledInterval(rate float64, min time.Duration, n int) time.Duration
- func RemoveEqualFold(xs *[]string, search string)
- func SetToSliceString(set map[string]struct{}) []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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckNamespaceScope ¶ added in v0.12.2
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 ¶ added in v0.5.5
CleanEnvVar replaces all occurrences of illegal characters in an environment variable with the specified byte.
func CleanFilename ¶ added in v1.0.0
CleanFilename replaces invalid characters in filename
func CleanFilenameASCIIOnly ¶ added in v1.0.0
CleanFilenameASCIIOnly replaces invalid and non-ASCII characters in filename
func CleanFilenameStrict ¶ added in v1.0.0
CleanFilenameStrict replaces invalid and punctuation characters in filename
func CompareMapStringString ¶ added in v0.9.0
CompareMapStringString returns true if the maps are equivalent. A nil and empty map are considered not equal.
func CompareSliceSetString ¶ added in v0.10.0
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 ¶ added in v0.12.4
CompareTimePtrs return true if a is the same as b.
func CopyMap ¶ added in v1.2.11
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 ¶
CopyMapStringFloat64 creates a copy of m.
Deprecated; use CopyMap instead.
func CopyMapStringInterface ¶ added in v0.12.4
CopyMapStringInterface creates a copy of m.
Deprecated; use CopyMap instead.
func CopyMapStringSliceString ¶ added in v0.6.1
CopyMapStringSliceString copies a map of strings to string slices such as http.Header
func CopyMapStringString ¶
CopyMapStringString creates a copy of m.
Deprecated; use CopyMap instead.
func CopyMapStringStruct ¶ added in v0.6.1
CopyMapStringStruct creates a copy of m.
Deprecated; use CopyMap instead.
func ElementsEquals ¶ added in v1.2.11
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 EnsurePath ¶ added in v1.3.0
EnsurePath is used to make sure a path exists
func HashUUID ¶ added in v0.6.0
HashUUID takes an input UUID and returns a hashed version of the UUID to ensure it is well distributed.
func IsErrEOF ¶ added in v1.3.0
IsErrEOF returns true if we get an EOF error from the socket itself, or an EOF equivalent error from yamux.
func IsMethodHTTP ¶ added in v1.2.11
IsMethodHTTP returns whether s is a known HTTP method, ignoring case.
func IsValidInterpVariable ¶ added in v0.9.0
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 ¶
MapStringStringSliceValueSet returns the set of values in a map[string][]string
func Max ¶ added in v1.2.11
func Max[T constraints.Ordered](a, b T) T
Max returns the maximum of a and b.
func MergeMapStringString ¶ added in v1.2.13
MergeMapStringString will merge two maps into one. If a duplicate key exists the value in the second map will replace the value in the first map. If both maps are empty or nil this returns an empty map.
func Min ¶ added in v1.2.11
func Min[T constraints.Ordered](a, b T) T
Min returns the minimum of a and b.
func PathEscapesSandbox ¶ added in v0.10.7
PathEscapesSandbox returns whether previously cleaned path inside the sandbox directory (typically this will be the allocation directory) escapes.
func RandomStagger ¶ added in v1.3.0
RandomStagger returns an interval between 0 and the duration
func RateScaledInterval ¶ added in v1.3.0
RateScaledInterval is used to choose an interval to perform an action in order to target an aggregate number of actions per second across the whole cluster.
func RemoveEqualFold ¶ added in v0.11.0
RemoveEqualFold removes the first string that EqualFold matches. It updates xs in place
func SetToSliceString ¶ added in v1.3.0
func SliceSetDisjoint ¶
func SliceStringContains ¶ added in v0.12.2
SliceStringContains returns whether item exists at least once in list.
func SliceStringHasPrefix ¶ added in v1.0.13
SliceStringHasPrefix returns true if any string in list starts with prefix
func SliceStringIsSubset ¶
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 StringHasPrefixInSlice ¶ added in v1.0.13
StringHasPrefixInSlice returns true if string starts with any prefix in list
func UnusedKeys ¶ added in v0.11.0
func UnusedKeys(obj interface{}) error
UnusedKeys returns a pretty-printed error if any `hcl:",unusedKeys"` is not empty
Types ¶
type EqualsFunc ¶ added in v1.2.11
EqualsFunc represents a type implementing the Equals method.
type StopFunc ¶ added in v1.1.13
type StopFunc func()
StopFunc is used to stop a time.Timer created with NewSafeTimer
func NewSafeTimer ¶ added in v1.1.13
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.
Directories
¶
Path | Synopsis |
---|---|
Package boltdd contains a wrapper around BBoltDB to deduplicate writes and encode values using mgspack.
|
Package boltdd contains a wrapper around BBoltDB to deduplicate writes and encode values using mgspack. |
constraints
|
|
semver
semver is a Semver Constraints package copied from github.com/hashicorp/go-version @ 2046c9d0f0b03c779670f5186a2a4b2c85493a71
|
semver is a Semver Constraints package copied from github.com/hashicorp/go-version @ 2046c9d0f0b03c779670f5186a2a4b2c85493a71 |
Package envoy provides a high level view of the variables that go into selecting an envoy version.
|
Package envoy provides a high level view of the variables that go into selecting an envoy version. |
Copied from github.com/hashicorp/consul/sdk/freeport
|
Copied from github.com/hashicorp/consul/sdk/freeport |
grpc-middleware
|
|
Package noxssrw (No XSS ResponseWriter) behaves like the Go standard library's ResponseWriter by detecting the Content-Type of a response if it has not been explicitly set.
|
Package noxssrw (No XSS ResponseWriter) behaves like the Go standard library's ResponseWriter by detecting the Content-Type of a response if it has not been explicitly set. |
pluginutils
|
|
catalog
Package catalog is used to register internal plugins such that they can be loaded.
|
Package catalog is used to register internal plugins such that they can be loaded. |
Package pointer provides helper functions related to Go pointers.
|
Package pointer provides helper functions related to Go pointers. |
Code generated by go generate; DO NOT EDIT.
|
Code generated by go generate; DO NOT EDIT. |
The archive utilities manage the internal format of a snapshot, which is a tar file with the following contents:
|
The archive utilities manage the internal format of a snapshot, which is a tar file with the following contents: |
Package testlog creates a *log.Logger backed by *testing.T to ease logging in tests.
|
Package testlog creates a *log.Logger backed by *testing.T to ease logging in tests. |
Package testtask implements a portable set of commands useful as stand-ins for user tasks.
|
Package testtask implements a portable set of commands useful as stand-ins for user tasks. |