errors

Documentation

Index

• func Errorf(format string, args ...interface{}) error
• func IsStatus(err error) bool
• func New(message string) error
• func StatusCode(err error) int
• func Wrap(err error, message string) error
• func Wrapf(err error, format string, args ...interface{}) error
• type Item
• type Status
  • func NewStatus(code int, message string) Status
  • func NewStatusWithCause(cause error, code int, message string) Status
  • func NewStatusWithItems(code int, message string, items []Item) Status
  • func Statusf(code int, format string, args ...interface{}) Status
  • func (s Status) Error() string
  • func (s Status) MarshalJSON() ([]byte, error)
  • func (s Status) RenderItems() []byte

Functions

func Errorf

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

Errorf with stack trace and formatted message

func IsStatus

func IsStatus(err error) bool

IsStatus returns true if err is a Status

func New

func New(message string) error

New error with stack trace

func StatusCode

func StatusCode(err error) int

StatusCode returns the Status code if err is a Status, zero if err is not a Status

func Wrap

func Wrap(err error, message string) error

Wrap error with new message

If err is a Status, it will not be wrapped

func Wrapf

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

Wrapf error with new formatted message

If err is a Status, it will not be wrapped

Types

type Item

type Item struct {
	Field   string `json:"field,omitempty"`
	Message string `json:"message"`
}

type Status

type Status struct {
	At      string
	Cause   error
	Code    int
	Message string
	Items   []Item
}

Status data model

Implements error interface

func NewStatus

func NewStatus(code int, message string) Status

NewStatus with code and message

func NewStatusWithCause

func NewStatusWithCause(cause error, code int, message string) Status

NewStatus with cause, code, and message

Cause can be useful to record an error that caused a Status to be created

func NewStatusWithItems

func NewStatusWithItems(code int, message string, items []Item) Status

NewStatusWithItems with code, message, and items

Items can be useful to add extra context to the error

func Statusf

func Statusf(code int, format string, args ...interface{}) Status

Statusf with code and formatted message

func (Status) Error

func (s Status) Error() string

Error so that Status objects can be treated as errors

func (Status) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

func (Status) RenderItems

func (s Status) RenderItems() []byte

Render items