error2

Documentation

Index

• func DotFormatFunc(es []error) string
• func ListFormatFunc(es []error) string
• type Array
  • func (e *Array) Err() error
  • func (e Array) Error() string
  • func (e *Array) GoString() string
  • func (e *Array) Push(err error)
  • func (e *Array) WrappedErrors() []error
• type ErrorFormatFunc

Functions

func DotFormatFunc

func DotFormatFunc(es []error) string

func ListFormatFunc

func ListFormatFunc(es []error) string

ListFormatFunc is a basic formatter that outputs the number of errors that occurred along with a bullet point list of the errors.

Types

type Array

type Array struct {
	Errors      []error
	ErrorFormat ErrorFormatFunc
}

Error is an error type to track multiple errors. This is used to accumulate errors in cases and return them as a single "error".

func (*Array) Err

func (e *Array) Err() error

ErrorOrNil returns an error interface if this Error represents a list of errors, or returns nil if the list of errors is empty. This function is useful at the end of accumulation to make sure that the value returned represents the existence of errors.

func (Array) Error

func (e Array) Error() string

func (*Array) GoString

func (e *Array) GoString() string

func (*Array) Push

func (e *Array) Push(err error)

func (*Array) WrappedErrors

func (e *Array) WrappedErrors() []error

WrappedErrors returns the list of errors that this Error is wrapping. It is an implementation of the errwrap.Wrapper interface so that multierror.Error can be used with that library.

This method is not safe to be called concurrently and is no different than accessing the Errors field directly. It is implemented only to satisfy the errwrap.Wrapper interface.

type ErrorFormatFunc

type ErrorFormatFunc func([]error) string

ErrorFormatFunc is a function callback that is called by Error to turn the list of errors into a string.