errors

Documentation

Overview

Package errors extends the errors package in the stdlib.

Index

• func Recover(r interface{}) (err error)
• type ErrorCollection
• type MultiError
  • func (e *MultiError) Error() string
  • func (e *MultiError) Errors() []error
• type MultiErrorBuilder
  • func NewMultiErrorBuilder() *MultiErrorBuilder
  • func (b *MultiErrorBuilder) Add(err error)
  • func (b *MultiErrorBuilder) ErrOrNil() error
• type SingleWrapMode

Functions

func Recover

func Recover(r interface{}) (err error)

Recover accepts a recovered panic (if any) and converts it to an error (if necessary).

Types

type ErrorCollection

type ErrorCollection interface {
	Errors() []error
}

ErrorCollection holds a list of errors.

type MultiError

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

MultiError aggregates multiple errors into a single value.

While ErrorCollection is only an interface for listing errors, MultiError actually implements the error interface so it can be returned as an error.

func (*MultiError) Error

func (e *MultiError) Error() string

Error implements the error interface.

func (*MultiError) Errors

func (e *MultiError) Errors() []error

Errors returns the list of wrapped errors.

type MultiErrorBuilder

type MultiErrorBuilder struct {
	SingleWrapMode SingleWrapMode
	// contains filtered or unexported fields
}

MultiErrorBuilder provides an interface for aggregating errors and exposing them as a single value.

func NewMultiErrorBuilder

func NewMultiErrorBuilder() *MultiErrorBuilder

NewMultiErrorBuilder returns a new MultiErrorBuilder.

func (*MultiErrorBuilder) Add

func (b *MultiErrorBuilder) Add(err error)

Add adds an error to the list.

Calling this method concurrently is not safe.

func (*MultiErrorBuilder) ErrOrNil

func (b *MultiErrorBuilder) ErrOrNil() error

ErrOrNil returns a MultiError the builder aggregates a list of errors, or returns nil if the list of errors is empty.

It is useful to avoid checking if there are any errors added to the list.

type SingleWrapMode

type SingleWrapMode int

SingleWrapMode defines how MultiErrorBuilder behaves when there is only one error in the list.

const (
	AlwaysWrap   SingleWrapMode = iota // Always return a MultiError.
	ReturnSingle                       // Return the single error.
)

These constants cause MultiErrorBuilder to behave as described if there is only one error in the list.