util

Documentation

Index

• Variables
• func CombineErrors(errs ...error) error
• func EnvVarBoolean(value string) bool
• func FilterOut(err error, fns ...Matcher) error
• func Reduce(err error) error
• func StringArrayIndex(array []string, value string) int
• func StringMatchesAny(text string, includes, excludes []string) bool
• func StringMatchesPattern(text, pattern string) bool
• type Aggregate
  • func AggregateGoroutines(funcs ...func() error) Aggregate
  • func CreateAggregateFromMessageCountMap(m MessageCountMap) Aggregate
  • func Flatten(agg Aggregate) Aggregate
  • func NewAggregate(errlist []error) Aggregate
• type Matcher
• type MessageCountMap

Variables

var (
	// ColorInfo returns a new function that returns info-colorized (green) strings for the
	// given arguments with fmt.Sprint().
	ColorInfo = color.New(color.FgGreen).SprintFunc()
)

Functions

func CombineErrors

func CombineErrors(errs ...error) error

CombineErrors combines the non null errors into a single error or returns null

func EnvVarBoolean

func EnvVarBoolean(value string) bool

func FilterOut

func FilterOut(err error, fns ...Matcher) error

FilterOut removes all errors that match any of the matchers from the input error. If the input is a singular error, only that error is tested. If the input implements the Aggregate interface, the list of errors will be processed recursively.

This can be used, for example, to remove known-OK errors (such as io.EOF or os.PathNotFound) from a list of errors.

func Reduce

func Reduce(err error) error

Reduce will return err or, if err is an Aggregate and only has one item, the first item in the aggregate.

func StringArrayIndex

func StringArrayIndex(array []string, value string) int

StringArrayIndex returns the index in the slice which equals the given value

func StringMatchesAny

func StringMatchesAny(text string, includes, excludes []string) bool

StringMatchesAny returns true if the given text matches the includes/excludes lists

func StringMatchesPattern

func StringMatchesPattern(text, pattern string) bool

StringMatchesPattern returns true if the given text matches the includes/excludes lists

Types

type Aggregate

type Aggregate interface {
	error
	Errors() []error
}

Aggregate represents an object that contains multiple errors, but does not necessarily have singular semantic meaning.

func AggregateGoroutines

func AggregateGoroutines(funcs ...func() error) Aggregate

AggregateGoroutines runs the provided functions in parallel, stuffing all non-nil errors into the returned Aggregate. Returns nil if all the functions complete successfully.

func CreateAggregateFromMessageCountMap

func CreateAggregateFromMessageCountMap(m MessageCountMap) Aggregate

CreateAggregateFromMessageCountMap converts MessageCountMap Aggregate

func Flatten

func Flatten(agg Aggregate) Aggregate

Flatten takes an Aggregate, which may hold other Aggregates in arbitrary nesting, and flattens them all into a single Aggregate, recursively.

func NewAggregate

func NewAggregate(errlist []error) Aggregate

NewAggregate converts a slice of errors into an Aggregate interface, which is itself an implementation of the error interface. If the slice is empty, this returns nil. It will check if any of the element of input error list is nil, to avoid nil pointer panic when call Error().

type Matcher

type Matcher func(error) bool

Matcher is used to match errors. Returns true if the error matches.

type MessageCountMap

type MessageCountMap map[string]int

MessageCountMap contains occurrence for each error message.