errors

Documentation

Index

• Variables
• func Is(err1 error, err2 error) bool
• func Wrap(newErr error, nestedErr error) error
• type NestedError
  • func (e NestedError) Error() string

Variables

var (
	// ErrIO is returned when underlying IO error is received.
	ErrIO = errors.New("IO error")

	// ErrMarshal is returned when an item can't be marshaled into JSON/YAML.
	ErrMarshal = errors.New("marshalling error")

	// ErrUnmarshal is returned when an item can't be unmarshaled from JSON/YAML.
	ErrUnmarshal = errors.New("unmarshalling error")
)

Functions

func Is

func Is(err1 error, err2 error) bool

Is compares two errors and returns true if they have the same message. If either is a NestedError, only the top-level message is checked.

func Wrap

func Wrap(newErr error, nestedErr error) error

Wrap will return a new error of the specified type, but wrapping the specified sub-error.

Types

type NestedError

type NestedError struct {
	Message string
	Err     error
}

NestedError contains an error inside another error (which may also be nested)

func (NestedError) Error

func (e NestedError) Error() string

Error returns the error message and the message of any wrapped error.