errs

Documentation

Index

• func Fatal(err error)
• func Log(err error) error
• func LogError(task string, err error) error
• func LogErrorWithHint(task string, err error, hint string) error
• func LogWith(err error, logger log.Logger) error
• func RootCause(err error) error
• type Err
  • func NewError(task string, err error) Err
  • func NewErrorWithHint(task string, err error, hint string) Err
  • func Wrap(task string, err error) Err

Functions

func Fatal

func Fatal(err error)

Fatal logs the error and exists the program with os.Exit(1).

func Log

func Log(err error) error

Log just calls LogWith(err, log.V(log.Info)).

func LogError

func LogError(task string, err error) error

LogError is a wrapper that calls Log(NewError(task, err)).

func LogErrorWithHint

func LogErrorWithHint(task string, err error, hint string) error

LogErrorWithHint is a wrapper that calls Log(NewErrorWithHint(task, err, hint)).

func LogWith

func LogWith(err error, logger log.Logger) error

LogWith logs the given error using the given logger.

func RootCause

func RootCause(err error) error

RootCause returns the error deepest in the error chain.

Types

type Err

type Err interface {
	error
	Task() string
	Err() error
	Hint() string
}

func NewError

func NewError(task string, err error) Err

func NewErrorWithHint

func NewErrorWithHint(task string, err error, hint string) Err

func Wrap

func Wrap(task string, err error) Err

Wrap is equal to

if err == nil { return nil } else { return NewError(task, err) }

It is particularly handy to get rid of all these if statements when you want to wrap and error in Err in case the error is not nil.