errz

Documentation

Index

• func ContextDone(err error) bool
• func DiscardAndClose(r io.ReadCloser, e *error)
• func NewUserError(msg string) error
• func NewUserErrorWithCause(cause error, msg string) error
• func SafeCall(toCall func() error, err *error)
• func SafeClose(toClose io.Closer, err *error)
• type ErrReporter
• type UserError
  • func (e UserError) Error() string
  • func (e UserError) Unwrap() error

Functions

func ContextDone

func ContextDone(err error) bool

func DiscardAndClose

func DiscardAndClose(r io.ReadCloser, e *error)

func NewUserError

func NewUserError(msg string) error

func NewUserErrorWithCause

func NewUserErrorWithCause(cause error, msg string) error

func SafeCall

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

func SafeClose

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

Types

type ErrReporter

type ErrReporter interface {
	// HandleProcessingError can be used to handle errors occurring while processing a request.
	// If err is a (or wraps a) errz.UserError, it might be handled specially.
	HandleProcessingError(ctx context.Context, log *zap.Logger, msg string, err error, fields ...fieldz.Field)
}

ErrReporter provides a way to report errors.

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