failure

Documentation

Index

• func NewReason(message, reason string) error
• func Reason(err error) (string, bool)
• func WithReason(err error, reason string) error

Functions

func NewReason

func NewReason(message, reason string) error

NewReason creates a new error using message and wraps it with reason. The reason can be extracted using Reason().

func Reason

func Reason(err error) (string, bool)

Reason extracts a failure reason from err. err has a reason if it satisfies the failure reason interface:

interface {
	FailureReason() string
}

If err does not have a reason or FailureReason() returns an empty string, ReasonUnknown is returned.

func WithReason

func WithReason(err error, reason string) error

WithReason decorates err with reason. The reason can be extracted using Reason().