errors

Documentation

Index

• func GetRootStack(err error) string
• func HandleError(ctx context.Context, err error) bool
• func LogError(ctx context.Context, err *ClowderError)
• func RootCause(err error) error
• type ClowdKey
• type ClowderError
  • func NewClowderError(msg string) *ClowderError
  • func Wrap(msg string, err error) *ClowderError
  • func (a *ClowderError) Error() string
  • func (a *ClowderError) Is(target error) bool
  • func (a *ClowderError) Unwrap() error
• type MissingDependencies
  • func MakeMissingDependencies(missingDep MissingDependency) MissingDependencies
  • func (e *MissingDependencies) Error() string
• type MissingDependency
  • func (m *MissingDependency) ToString() string

Functions

func GetRootStack

func GetRootStack(err error) string

GetRootStack will recurse through an error until it finds one with a stack string set.

func HandleError

func HandleError(ctx context.Context, err error) bool

HandleError handles certain ClowdError types differently than normal errors.

func LogError

func LogError(ctx context.Context, err *ClowderError)

LogError logs an error using the given contexts logger and a string.

func RootCause

func RootCause(err error) error

RootCause takes an error an unwraps it, if it is nil, it calls RootCause on the returned err, this will recursively find an error that has an unwrapped value.

Types

type ClowdKey

type ClowdKey string

ClowdKey is a string determining the type of error.

type ClowderError

type ClowderError struct {
	Stack   zap.Field
	Msg     string
	Cause   error
	Requeue bool
}

ClowderError is a Clowder specific error, it has a number of functions attached to it to allow for creation and checking.

func NewClowderError

func NewClowderError(msg string) *ClowderError

NewClowderError constructs a new ClowderError object.

func Wrap

func Wrap(msg string, err error) *ClowderError

Wrap takes an existing error an wraps it, returning a ClowderError

func (*ClowderError) Error

func (a *ClowderError) Error() string

func (*ClowderError) Is

func (a *ClowderError) Is(target error) bool

Is checks that a target is the same as a given error, that is, it has the same message and cause.

func (*ClowderError) Unwrap

func (a *ClowderError) Unwrap() error

type MissingDependencies

type MissingDependencies struct {
	MissingDeps []MissingDependency
}

MissingDependencies is a struct that holds a list of MissingDependency structs

func MakeMissingDependencies

func MakeMissingDependencies(missingDep MissingDependency) MissingDependencies

func (*MissingDependencies) Error

func (e *MissingDependencies) Error() string

Error returns a string representation of the missing dependencies

type MissingDependency

type MissingDependency struct {
	Source  string
	Details string
}

MissingDependency is a struct that holds information about a missing dependency

func (*MissingDependency) ToString

func (m *MissingDependency) ToString() string

ToString returns a string representation of the missing dependency