errors

Documentation

Index

• func Classify(err error, class api.Result) error
• func GetClass(err error) api.Result
• func IsRecoverable(err error) bool
• func NonRecoverable(err error) error
• func Recoverable(err error) error
• func RecoverableIf(err error, cond bool) error

Functions

func Classify

func Classify(err error, class api.Result) error

Classify annotates a given error with a error class.

func GetClass

func GetClass(err error) api.Result

GetClass returns the class of the error.

func IsRecoverable

func IsRecoverable(err error) bool

IsRecoverable returns true if the given error has been marked as recoverable.

func NonRecoverable

func NonRecoverable(err error) error

NonRecoverable annotates a given error as non-recoverable. It is equivalent to `RecoverableIf(err, false)`

func Recoverable

func Recoverable(err error) error

Recoverable annotates a given error as recoverable. It is equivalent to `RecoverableIf(err, true)`

func RecoverableIf

func RecoverableIf(err error, cond bool) error

RecoverableIf conditionally annotates a given error as recoverable. If err is nil, the function returns nil. If the recoverability status of err is equal to cond, the function returns err itself. Otherwise a new error is returned that wraps err.