err

Documentation

Index

• func Collect[T any, Err error, Arg any, Func func(Arg) (T, Err)](eb *Builder, fn Func, arg Arg) T
• func Collect2[T any, Err error, Arg1 any, Arg2 any, Func func(Arg1, Arg2) (T, Err)](eb *Builder, fn Func, arg1 Arg1, arg2 Arg2) T
• func LogDebug(msg string, err error, logger ...*zerolog.Logger)
• func LogError(msg string, err error, logger ...*zerolog.Logger)
• func LogFatal(msg string, err error, logger ...*zerolog.Logger)
• func LogInfo(msg string, err error, logger ...*zerolog.Logger)
• func LogPanic(msg string, err error, logger ...*zerolog.Logger)
• func LogWarn(msg string, err error, logger ...*zerolog.Logger)
• func PrependSubject(subject string, err error) error
• type Builder
  • func NewBuilder(about string) *Builder
  • func (b *Builder) About() string
  • func (b *Builder) Add(err error) *Builder
  • func (b *Builder) AddFrom(other *Builder, flatten bool) *Builder
  • func (b *Builder) AddRange(errs ...error) *Builder
  • func (b *Builder) Addf(format string, args ...any) *Builder
  • func (b *Builder) Adds(err string) *Builder
  • func (b *Builder) Error() Error
  • func (b *Builder) HasError() bool
  • func (b *Builder) String() string
• type Error
  • func Errorf(format string, args ...any) Error
  • func From(err error) Error
  • func Join(errors ...error) Error
  • func New(message string) Error
  • func Wrap(err error, message ...string) Error

Functions

func Collect

func Collect[T any, Err error, Arg any, Func func(Arg) (T, Err)](eb *Builder, fn Func, arg Arg) T

func Collect2

func Collect2[T any, Err error, Arg1 any, Arg2 any, Func func(Arg1, Arg2) (T, Err)](eb *Builder, fn Func, arg1 Arg1, arg2 Arg2) T

func LogDebug

func LogDebug(msg string, err error, logger ...*zerolog.Logger)

func LogError

func LogError(msg string, err error, logger ...*zerolog.Logger)

func LogFatal

func LogFatal(msg string, err error, logger ...*zerolog.Logger)

func LogInfo

func LogInfo(msg string, err error, logger ...*zerolog.Logger)

func LogPanic

func LogPanic(msg string, err error, logger ...*zerolog.Logger)

func LogWarn

func LogWarn(msg string, err error, logger ...*zerolog.Logger)

func PrependSubject

func PrependSubject(subject string, err error) error

Types

type Builder

type Builder struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewBuilder

func NewBuilder(about string) *Builder

func (*Builder) About

func (b *Builder) About() string

func (*Builder) Add

func (b *Builder) Add(err error) *Builder

Add adds an error to the Builder.

adding nil is no-op.

func (*Builder) AddFrom

func (b *Builder) AddFrom(other *Builder, flatten bool) *Builder

func (*Builder) AddRange

func (b *Builder) AddRange(errs ...error) *Builder

func (*Builder) Addf

func (b *Builder) Addf(format string, args ...any) *Builder

func (*Builder) Adds

func (b *Builder) Adds(err string) *Builder

func (*Builder) Error

func (b *Builder) Error() Error

func (*Builder) HasError

func (b *Builder) HasError() bool

func (*Builder) String

func (b *Builder) String() string

type Error

type Error interface {
	error

	// Is is a wrapper for errors.Is when there is no sub-error.
	//
	// When there are sub-errors, they will also be checked.
	Is(other error) bool
	// With appends a sub-error to the error.
	With(extra error) Error
	// Withf is a wrapper for With(fmt.Errorf(format, args...)).
	Withf(format string, args ...any) Error
	// Subject prepends the given subject with a colon and space to the error message.
	//
	// If there is already a subject in the error message, the subject will be
	// prepended to the existing subject with " > ".
	//
	// Subject empty string is ignored.
	Subject(subject string) Error
	// Subjectf is a wrapper for Subject(fmt.Sprintf(format, args...)).
	Subjectf(format string, args ...any) Error
}

func Errorf

func Errorf(format string, args ...any) Error

func From

func From(err error) Error

func Join

func Join(errors ...error) Error

func New

func New(message string) Error

func Wrap

func Wrap(err error, message ...string) Error