errors

Documentation

Index

• func As(err error, target any) bool
• func GetBase(err error) error
• func GetStackTrace() []string
• func Is(err, target error) bool
• func Tag(tag string, base HasCode) error
• func TagAndCode(tag string, code codes.Code, base error) error
• type ErrParameterRequired
  • func (e ErrParameterRequired) Error() string
  • func (e ErrParameterRequired) GetCode() codes.Code
• type ErrRequiresSuperUser
  • func (e ErrRequiresSuperUser) Error() string
  • func (e ErrRequiresSuperUser) GetCode() codes.Code
  • func (e ErrRequiresSuperUser) Trace() string
• type ErrTesting
  • func (e ErrTesting) Error() string
  • func (e ErrTesting) GetCode() codes.Code
• type HasCode
• type Tracer
• type TracerError
  • func New(format string, args ...interface{}) TracerError
  • func Wrap(err error) TracerError

Functions

func As

func As(err error, target any) bool

func GetBase

func GetBase(err error) error

GetBase returns the original error from the passed tagged error

func GetStackTrace

func GetStackTrace() []string

GetStackTrace retrieves the full stack (minus any runtime related functions) from where the Error was instantiated

func Is

func Is(err, target error) bool

func Tag

func Tag(tag string, base HasCode) error

Tag the passed error

func TagAndCode

func TagAndCode(tag string, code codes.Code, base error) error

TagAndCode the passed error

Types

type ErrParameterRequired

type ErrParameterRequired string

ErrParameterRequired is returned when a required parameter is empty or nil but requires a value.

func (ErrParameterRequired) Error

func (e ErrParameterRequired) Error() string

func (ErrParameterRequired) GetCode

func (e ErrParameterRequired) GetCode() codes.Code

type ErrRequiresSuperUser

type ErrRequiresSuperUser string

ErrRequiresSuperUser is returned when a user attempts to perform an action that requires superuser privileges.

func (ErrRequiresSuperUser) Error

func (e ErrRequiresSuperUser) Error() string

func (ErrRequiresSuperUser) GetCode

func (e ErrRequiresSuperUser) GetCode() codes.Code

func (ErrRequiresSuperUser) Trace

func (e ErrRequiresSuperUser) Trace() string

type ErrTesting

type ErrTesting string

ErrTesting is for use in error test cases only. Should primarily be used for returning generic errors from mocks and ensuring the error is expected

func (ErrTesting) Error

func (e ErrTesting) Error() string

func (ErrTesting) GetCode

func (e ErrTesting) GetCode() codes.Code

type HasCode

type HasCode interface {
	error
	// GetCode for this error
	GetCode() codes.Code
}

HasCode exposes functionality for switching from an error to a status error

type Tracer

type Tracer interface {
	// Trace returns the long format stack trace from where the error was instantiated
	Trace() []string
}

Tracer provides a stack trace

type TracerError

type TracerError interface {
	Tracer
	error
}

TracerError is an amalgamation of the Tracer and error interfaces

func New

func New(format string, args ...interface{}) TracerError

New instantiates a TracerError with a stack trace

func Wrap

func Wrap(err error) TracerError

Wrap an existing error in a TracerError