errors

Documentation

Overview

Package errors provides lightweight error handling and classification primitives.

The package provides simple error handling interfaces and functions. It allows to create simple and detailed classified errors.

Index

• Variables
• func As(err error, target interface{}) bool
• func Is(err, target error) bool
• func New(msg string) error
• func Unwrap(err error) error
• func Wrap(err error, msg string) error
• func Wrapf(err error, format string, args ...interface{}) error
• type DetailedError
  • func WrapDet(err error, message string) *DetailedError
  • func WrapDetf(err error, format string, args ...interface{}) *DetailedError
  • func (e *DetailedError) Error() string
  • func (e *DetailedError) Unwrap() error
  • func (e *DetailedError) WithDetail(detail string) *DetailedError
  • func (e *DetailedError) WithDetailf(format string, values ...interface{}) *DetailedError
• type MultiError
  • func (m MultiError) Error() string
  • func (m MultiError) Is(err error) bool

Variables

var ErrInternal = errors.New("internal error")

ErrInternal is an internal neuron error definition.

Functions

func As

func As(err error, target interface{}) bool

As executes errors.As function.

func Is

func Is(err, target error) bool

Is checks if any of the chained errors is of 'target' type.

func New

func New(msg string) error

New creates new error.

func Unwrap

func Unwrap(err error) error

Unwrap unwraps provided error.

func Wrap

func Wrap(err error, msg string) error

Wrap creates simple ClassError for provided 'c' Class and 'msg' message.

func Wrapf

func Wrapf(err error, format string, args ...interface{}) error

Wrapf creates simple formatted ClassError for provided 'c' Class, 'format' and arguments 'args'.

Types

type DetailedError

type DetailedError struct {
	// ID is a unique error instance identification number.
	ID uuid.UUID
	// details contains the detailed information.
	Details string
	// message is a message used as a string for the
	// golang error interface implementation.
	Message string
	// Operation is the operation name when the error occurred.
	Operation string
	// contains filtered or unexported fields
}

DetailedError is the class based error definition. Each instance has it's own traceable ID. It contains also a Class variable that might be comparable in logic.

func WrapDet

func WrapDet(err error, message string) *DetailedError

WrapDet wraps 'err' error and creates DetailedError with given 'message'.

func WrapDetf

func WrapDetf(err error, format string, args ...interface{}) *DetailedError

WrapDetf wraps 'err' error and created DetailedError with formatted message.

func (*DetailedError) Error

func (e *DetailedError) Error() string

DetailedError implements error interface.

func (*DetailedError) Unwrap

func (e *DetailedError) Unwrap() error

Unwrap unwraps provided error.

func (*DetailedError) WithDetail

func (e *DetailedError) WithDetail(detail string) *DetailedError

WithDetail sets error detail.

func (*DetailedError) WithDetailf

func (e *DetailedError) WithDetailf(format string, values ...interface{}) *DetailedError

WithDetailf sets error detail.

type MultiError

type MultiError []error

MultiError is the slice of errors parsable into a single error.

func (MultiError) Error

func (m MultiError) Error() string

Error implements error interface.

func (MultiError) Is

func (m MultiError) Is(err error) bool

Is checks if one of the errors is equal to 'err'.