errors

Documentation

Index

• Variables
• func Errorf(format string, args ...interface{}) error
• func OneOf(err error, others ...error) bool
• func Verbose(err error) error
• type Error
  • func E(err error) Error
  • func (err Error) Error() string
  • func (err Error) HTTPStatus() int
  • func (err Error) Is(other error) bool
  • func (err Error) WithCausef(format string, args ...interface{}) Error
  • func (err Error) WithMsgf(format string, args ...interface{}) Error
  • func (err Error) WithOp(name string) Error

Variables

var (
	Is  = errors.Is
	As  = errors.As
	New = errors.New
)

These aliased values are added to avoid conflicting imports of standard `errors` package and this `errors` package where these functions are needed.

var (
	ErrInvalid = Error{
		Code:    "bad_request",
		Message: "Request is not valid",
		Status:  http.StatusBadRequest,
	}

	ErrNotFound = Error{
		Code:    "not_found",
		Message: "Requested entity not found",
		Status:  http.StatusNotFound,
	}

	ErrConflict = Error{
		Code:    "conflict",
		Message: "An entity with conflicting identifier exists",
		Status:  http.StatusConflict,
	}

	ErrInternal = Error{
		Code:    "internal_error",
		Message: "Some unexpected error occurred",
		Status:  http.StatusInternalServerError,
	}
)

Common error categories. Use `ErrX.WithXXX()` to clone and add context.

Functions

func Errorf

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

Errorf returns a formatted error similar to `fmt.Errorf` but uses the Error type defined in this package. returned value is equivalent to ErrInternal (i.e., errors.Is(retVal, ErrInternal) = true).

func OneOf

func OneOf(err error, others ...error) bool

OneOf checks if the error is one of the 'others'.

func Verbose

func Verbose(err error) error

Verbose returns a verbose error value.

Types

type Error

type Error struct {
	Op      string `json:"op"`
	Code    string `json:"code"`
	Cause   string `json:"cause,omitempty"`
	Message string `json:"message"`
	Status  int    `json:"status"`
}

Error represents any error returned by the Entropy components along with any relevant context.

func E

func E(err error) Error

E converts any given error to the Error type. Unknown are converted to ErrInternal.

func (Error) Error

func (err Error) Error() string

func (Error) HTTPStatus

func (err Error) HTTPStatus() int

HTTPStatus returns the http code for the error.

func (Error) Is

func (err Error) Is(other error) bool

Is checks if 'other' is of type Error and has the same code. See https://blog.golang.org/go1.13-errors.

func (Error) WithCausef

func (err Error) WithCausef(format string, args ...interface{}) Error

WithCausef returns clone of err with the cause added. Use this when you need to provide description of the underlying technical root-cause which may be written in log for debugging purposes. Cause will be shown to the user only when the Message is empty.

func (Error) WithMsgf

func (err Error) WithMsgf(format string, args ...interface{}) Error

WithMsgf returns a clone of the error with message set. Use this when you need to provide a custom message that should be shown to the user. If the message is set to empty string, cause will be displayed to the user.

func (Error) WithOp

func (err Error) WithOp(name string) Error

WithOp can be used to add the name of the op where the error occurred.