errz

Documentation

Index

• func ContextDone(err error) bool
• func MaybeWrapWithCorrelationId(err error, correlationId string) error
• func NewUserError(msg string) error
• func NewUserErrorWithCause(cause error, msg string) error
• func NewUserErrorWithCausef(cause error, format string, args ...interface{}) error
• func NewUserErrorf(format string, args ...interface{}) error
• func SafeCall(toCall func() error, err *error)
• func SafeClose(toClose io.Closer, err *error)
• func SafeDrainAndClose(toClose io.ReadCloser, err *error)
• type CorrelationError
  • func (e CorrelationError) Error() string
  • func (e CorrelationError) Unwrap() error
• type UserError
  • func (e UserError) Error() string
  • func (e UserError) Unwrap() error

Functions

func ContextDone

func ContextDone(err error) bool

func MaybeWrapWithCorrelationId

func MaybeWrapWithCorrelationId(err error, correlationId string) error

func NewUserError

func NewUserError(msg string) error

func NewUserErrorWithCause

func NewUserErrorWithCause(cause error, msg string) error

func NewUserErrorWithCausef

func NewUserErrorWithCausef(cause error, format string, args ...interface{}) error

func NewUserErrorf

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

func SafeCall

func SafeCall(toCall func() error, err *error)

func SafeClose

func SafeClose(toClose io.Closer, err *error)

func SafeDrainAndClose

func SafeDrainAndClose(toClose io.ReadCloser, err *error)

Types

type CorrelationError

type CorrelationError struct {
	// Err holds the wrapped error.
	Err error
	// CorrelationId holds the correlation id.
	CorrelationId string
}

CorrelationError wraps an error to add a correlation id.

func (CorrelationError) Error

func (e CorrelationError) Error() string

func (CorrelationError) Unwrap

func (e CorrelationError) Unwrap() error

type UserError

type UserError struct {
	// Message is a textual description of what's wrong.
	// Must be suitable to show to the user.
	Message string
	// Cause optionally holds an underlying error.
	Cause error
}

UserError is an error that happened because the user messed something up: - invalid syntax - invalid configuration

func (UserError) Error

func (e UserError) Error() string

func (UserError) Unwrap

func (e UserError) Unwrap() error