errors

README

errors

Contains helper to wrap error by another error

Documentation

Index

• func Combine(errs ...error) (err error)
• func New(text string) error
• func Wrap(cause error, effect error) error
• func WrapBoundary(kind string, operation string, err error) error
• func Wrapf(err error, format string, args ...any) error
• type BoundaryError
  • func (e BoundaryError) Error() string
  • func (e BoundaryError) Unwrap() error
• type MultipleError
  • func (s MultipleError) As(target any) bool
  • func (s MultipleError) Error() string
  • func (s MultipleError) Is(err error) bool
  • func (s MultipleError) Unwrap() error

Functions

func Combine

func Combine(errs ...error) (err error)

Combine receive multiple errors and return one

func New

func New(text string) error

New return new error

func Wrap

func Wrap(cause error, effect error) error

Wrap wrap error with error

func WrapBoundary

func WrapBoundary(kind string, operation string, err error) error

WrapBoundary returns nil for nil errors or a BoundaryError for non-nil errors.

func Wrapf

func Wrapf(err error, format string, args ...any) error

Wrapf wrap by format

Types

type BoundaryError

type BoundaryError struct {
	Kind      string
	Operation string
	Err       error
}

BoundaryError wraps an infrastructure or SDK error at a core-owned package boundary.

func (BoundaryError) Error

func (e BoundaryError) Error() string

Error returns the boundary error message.

func (BoundaryError) Unwrap

func (e BoundaryError) Unwrap() error

Unwrap returns the wrapped SDK or infrastructure error.

type MultipleError

type MultipleError struct {
	Cause  error
	Effect error
}

MultipleError type for wrap error around error

func (MultipleError) As

func (s MultipleError) As(target any) bool

As finds the first error in err's chain that matches target, and if so, sets target to that error value and returns true. Otherwise, it returns false.

func (MultipleError) Error

func (s MultipleError) Error() string

Error return string based on error

func (MultipleError) Is

func (s MultipleError) Is(err error) bool

Is reports whether any error in err's chain matches target.

func (MultipleError) Unwrap

func (s MultipleError) Unwrap() error