merr

Documentation

Index

• func IsCode(err error, code Code) bool
• type Code
  • func (c Code) Error() string
  • func (c Code) String() string
• type E
  • func New(ctx context.Context, code Code, meta M, reasons ...error) E
  • func (e E) Equal(e2 E) bool
  • func (e E) Error() string
  • func (e E) Fields() map[string]any
  • func (e E) GetStack() []stacktrace.Frame
  • func (e E) Is(err error) bool
  • func (e E) Merr() E
  • func (e E) String() string
  • func (e E) Unwrap() []error
• type M
• type Merrer
• type StackError

Functions

func IsCode

func IsCode(err error, code Code) bool

IsCode is a convenience wrapper for `errors.Is`

`errors.Is(err, "foo")` does not work

`IsCode(err, "foo")` does - as the string is automatically converted

Types

type Code

type Code string

func (Code) Error

func (c Code) Error() string

func (Code) String

func (c Code) String() string

type E

type E struct {
	Code Code `json:"code"`
	Meta M    `json:"meta"`

	TraceID trace.TraceID `json:"trace_id"`
	SpanID  trace.SpanID  `json:"span_id"`

	Stack []stacktrace.Frame `json:"stack"`

	Reasons []error `json:"reasons"`
}

func New

func New(ctx context.Context, code Code, meta M, reasons ...error) E

func (E) Equal

func (e E) Equal(e2 E) bool

func (E) Error

func (e E) Error() string

Error implements the error interface

Provides a simple string representation of the error, but cannot include the complete data contained in the error

No compatibility guarantees are made with its output - it may change at any time

func (E) Fields

func (e E) Fields() map[string]any

func (E) GetStack

func (e E) GetStack() []stacktrace.Frame

func (E) Is

func (e E) Is(err error) bool

Is enables the use of `errors.Is`

func (E) Merr

func (e E) Merr() E

func (E) String

func (e E) String() string

func (E) Unwrap

func (e E) Unwrap() []error

Unwrap enables the use of `errors.Unwrap`

type M

type M map[string]any

type Merrer

type Merrer interface {
	error
	Merr() E
}

Merrer (merr-er) represents a merr-compatible error

It primarily exists to allow `Wrap` to return nil without forcing us to use pointers for `E`, but also allows other structs to offer a merr.E option

type StackError

type StackError interface {
	GetStack() []stacktrace.Frame
}