errors

Documentation

Index

• func Errorf(message string, args ...interface{}) error
• func IsError(actual error, expected error) bool
• func PrintErrorWithStackTrace(err error) string
• func Recover(onPanic func(cause error))
• func Unwrap(err error) error
• func WithStackTrace(err any) error
• func WithStackTraceAndPrefix(err error, message string, args ...interface{}) error
• type IErrorCode

Functions

func Errorf

func Errorf(message string, args ...interface{}) error

Errorf creates a new error and wraps in an Error type that contains the stack trace.

func IsError

func IsError(actual error, expected error) bool

Returns true if actual is the same type of error as expected. This method unwraps the given error objects (if they are wrapped in objects with a stacktrace) and then does a simple equality check on them.

func PrintErrorWithStackTrace

func PrintErrorWithStackTrace(err error) string

Convert the given error to a string, including the stack trace if available

func Recover

func Recover(onPanic func(cause error))

A method that tries to recover from panics, and if it succeeds, calls the given onPanic function with an error that explains the cause of the panic. This function should only be called from a defer statement.

func Unwrap

func Unwrap(err error) error

If the given error is a wrapper that contains a stacktrace, unwrap it and return the original, underlying error. In all other cases, return the error unchanged

func WithStackTrace

func WithStackTrace(err any) error

Wrap the given error in an Error type that contains the stack trace. If the given error already has a stack trace, it is used directly. If the given error is nil, return nil.

func WithStackTraceAndPrefix

func WithStackTraceAndPrefix(err error, message string, args ...interface{}) error

Wrap the given error in an Error type that contains the stack trace and has the given message prepended as part of the error message. If the given error already has a stack trace, it is used directly. If the given error is nil, return nil.

Types

type IErrorCode

type IErrorCode interface {
	ExitStatus() (int, error)
}

Interface to determine if we can retrieve an exit status from an error