fail

Documentation

Index

• func IsEqual(err, other error) bool
• func IsFail(err error) bool
• func New(message string, data ...interface{}) error
• func NewFromErr(err error, data ...interface{}) error
• type Fail
  • func (f *Fail) Error() string

Functions

func IsEqual

func IsEqual(err, other error) bool

IsEqual tests whether an error is equal to another error / failure

func IsFail

func IsFail(err error) bool

IsFail tests whether the passed in error is a failure

func New

func New(message string, data ...interface{}) error

New creates a new failure, data is optional

func NewFromErr

func NewFromErr(err error, data ...interface{}) error

NewFromErr returns a new failure based on the passed in error, data is optional if passed in error is nil, then nil is returned

Types

type Fail

type Fail struct {
	Message    string      `json:"message,omitempty"`
	Data       interface{} `json:"data,omitempty"`
	HTTPStatus int         `json:"-"` //gets set in the error response
}

Fail is an error whos contents can be exposed to the client and is usually the result of incorrect client input

func (*Fail) Error

func (f *Fail) Error() string