collections

Documentation

Index

• func Exists(root map[string]interface{}, path string) bool
• func ForEach(root map[string]interface{}, path string, ...) error
• func GetMap(root map[string]interface{}, path string) (map[string]interface{}, error)
• func GetSlice(root map[string]interface{}, path string) ([]interface{}, error)
• func GetString(root map[string]interface{}, path string) (string, error)
• func GetValue(root map[string]interface{}, path string) (interface{}, error)
• func MergeMaps(first, second map[string]string) map[string]string
• func ValidateIncludesExcludes(includesList, excludesList []string) []error
• type IncludesExcludes
  • func GenerateIncludesExcludes(includes, excludes []string, mapFunc func(string) string) *IncludesExcludes
  • func NewIncludesExcludes() *IncludesExcludes
  • func (ie *IncludesExcludes) Excludes(excludes ...string) *IncludesExcludes
  • func (ie *IncludesExcludes) ExcludesString() string
  • func (ie *IncludesExcludes) GetExcludes() []string
  • func (ie *IncludesExcludes) GetIncludes() []string
  • func (ie *IncludesExcludes) IncludeEverything() bool
  • func (ie *IncludesExcludes) Includes(includes ...string) *IncludesExcludes
  • func (ie *IncludesExcludes) IncludesString() string
  • func (ie *IncludesExcludes) ShouldInclude(s string) bool

Functions

func Exists

func Exists(root map[string]interface{}, path string) bool

Exists returns true if root[path] exists, or false otherwise.

func ForEach

func ForEach(root map[string]interface{}, path string, fn func(obj map[string]interface{}) error) error

ForEach calls fn on each object in the root[path] array, where path is a dot separated string.

func GetMap

func GetMap(root map[string]interface{}, path string) (map[string]interface{}, error)

GetMap returns the map at root[path], where path is a dot separated string.

func GetSlice

func GetSlice(root map[string]interface{}, path string) ([]interface{}, error)

GetSlice returns the slice at root[path], where path is a dot separated string.

func GetString

func GetString(root map[string]interface{}, path string) (string, error)

GetString returns the string at root[path], where path is a dot separated string.

func GetValue

func GetValue(root map[string]interface{}, path string) (interface{}, error)

GetValue returns the object at root[path], where path is a dot separated string.

func MergeMaps

func MergeMaps(first, second map[string]string) map[string]string

MergeMaps takes two map[string]string and merges missing keys from the second into the first. If a key already exists, its value is not overwritten.

func ValidateIncludesExcludes

func ValidateIncludesExcludes(includesList, excludesList []string) []error

ValidateIncludesExcludes checks provided lists of included and excluded items to ensure they are a valid set of IncludesExcludes data.

Types

type IncludesExcludes

type IncludesExcludes struct {
	// contains filtered or unexported fields
}

IncludesExcludes is a type that manages lists of included and excluded items. The logic implemented is that everything in the included list except those items in the excluded list should be included. '*' in the includes list means "include everything", but it is not valid in the exclude list.

func GenerateIncludesExcludes

func GenerateIncludesExcludes(includes, excludes []string, mapFunc func(string) string) *IncludesExcludes

GenerateIncludesExcludes constructs an IncludesExcludes struct by taking the provided include/exclude slices, applying the specified mapping function to each item in them, and adding the output of the function to the new struct. If the mapping function returns an empty string for an item, it is omitted from the result.

func NewIncludesExcludes

func NewIncludesExcludes() *IncludesExcludes

func (*IncludesExcludes) Excludes

func (ie *IncludesExcludes) Excludes(excludes ...string) *IncludesExcludes

Excludes adds items to the excludes list

func (*IncludesExcludes) ExcludesString

func (ie *IncludesExcludes) ExcludesString() string

ExcludesString returns a string containing all of the excludes, separated by commas, or <none> if the list is empty.

func (*IncludesExcludes) GetExcludes

func (ie *IncludesExcludes) GetExcludes() []string

GetExcludes returns the items in the excludes list

func (*IncludesExcludes) GetIncludes

func (ie *IncludesExcludes) GetIncludes() []string

GetIncludes returns the items in the includes list

func (*IncludesExcludes) IncludeEverything

func (ie *IncludesExcludes) IncludeEverything() bool

IncludeEverything returns true if the includes list is empty or '*' and the excludes list is empty, or false otherwise.

func (*IncludesExcludes) Includes

func (ie *IncludesExcludes) Includes(includes ...string) *IncludesExcludes

Includes adds items to the includes list. '*' is a wildcard value meaning "include everything".

func (*IncludesExcludes) IncludesString

func (ie *IncludesExcludes) IncludesString() string

IncludesString returns a string containing all of the includes, separated by commas, or * if the list is empty.

func (*IncludesExcludes) ShouldInclude

func (ie *IncludesExcludes) ShouldInclude(s string) bool

ShouldInclude returns whether the specified item should be included or not. Everything in the includes list except those items in the excludes list should be included.