errors

Documentation

Overview

Contains utilities to use to create and consume simple errors.

Index

• func Errorf(errorCode ErrorCode, msgFmt string, args ...interface{}) error
• func IsCausedBy(e error, errCode ErrorCode) bool
• func IsCausedByError(e, e2 error) bool
• func Wrapf(code ErrorCode, cause error, msgFmt string, args ...interface{}) error
• type ErrorCode
  • func GetErrorCode(e error) (code ErrorCode, found bool)
• type ErrorCollection
  • func (e *ErrorCollection) Append(err error) bool
  • func (e ErrorCollection) Error() string
  • func (e ErrorCollection) ErrorOrDefault() error

Functions

func Errorf

func Errorf(errorCode ErrorCode, msgFmt string, args ...interface{}) error

Creates a new error using an error code and a message.

func IsCausedBy

func IsCausedBy(e error, errCode ErrorCode) bool

Gets whether error is caused by another error with errCode.

func IsCausedByError

func IsCausedByError(e, e2 error) bool

func Wrapf

func Wrapf(code ErrorCode, cause error, msgFmt string, args ...interface{}) error

Wraps a root cause error with another. This is useful to unify an error type in a package.

Types

type ErrorCode

type ErrorCode = string

A generic error code type.

func GetErrorCode

func GetErrorCode(e error) (code ErrorCode, found bool)

Gets the error code of the passed error if it has one.

type ErrorCollection

type ErrorCollection []error

A helper object that collects errors.

func (*ErrorCollection) Append

func (e *ErrorCollection) Append(err error) bool

func (ErrorCollection) Error

func (e ErrorCollection) Error() string

func (ErrorCollection) ErrorOrDefault

func (e ErrorCollection) ErrorOrDefault() error