errors

Documentation

Index

• func Cancelled(err error) error
• func IsCancelledError(err error) bool
• func IsSystemError(err error) bool
• func IsUserError(err error) bool
• func User(err error) error
• type CancelledError
  • func (err CancelledError) Error() string
  • func (err CancelledError) Unwrap() error
• type UserError
  • func (err UserError) Error() string
  • func (err UserError) Unwrap() error

Functions

func Cancelled

func Cancelled(err error) error

User annotates err as a context cancelled error.

func IsCancelledError

func IsCancelledError(err error) bool

IsCancelledError returns whether err is annotated as a context cancelled error.

func IsSystemError

func IsSystemError(err error) bool

IsSystemError returns whether err is not annotated as a user error.

func IsUserError

func IsUserError(err error) bool

IsUserError returns whether err is annotated as a user error.

func User

func User(err error) error

User annotates err as a user error.

Types

type CancelledError

type CancelledError struct {
	// contains filtered or unexported fields
}

A CancelledError wraps an underlying error to annotite at as being caused by the cancellation of a context. CancelledErrors are also annotated as UserErrors.

func (CancelledError) Error

func (err CancelledError) Error() string

Error returns err's underlying error string.

func (CancelledError) Unwrap

func (err CancelledError) Unwrap() error

Unwrap returns err's underlying error.

type UserError

type UserError struct {
	// contains filtered or unexported fields
}

A UserError wraps an underlying error to annotate it as being caused by user error. The underlying error string is returned directly, meaning the annotation can be detected using errors.As without the annotation affecting how the errors are communicated.

func (UserError) Error

func (err UserError) Error() string

Error returns err's underlying error string.

func (UserError) Unwrap

func (err UserError) Unwrap() error

Unwrap returns err's underlying error.