merror

README

merror is a set of functions for handling standardized errors in applications using the HTTP/S protocol.

Package extracted from https://github.com/malumar/tempf

Documentation

Index

• Constants
• Variables
• func Cause(err error) error
• func Code(err error) int
• func GetCode(code int, dfault string) string
• func Is(err error) bool
• func SetCode(code int, value string)
• func UnWrap(err error) error
• type CauseHolder
• type Error
  • func New(code int, casue error, comment string) *Error
  • func NewForbidden() *Error
  • func NewForbiddenWrap(err error) *Error
  • func NewInternalServer() *Error
  • func NewInternalServerWrap(err error) *Error
  • func NewNotFound() *Error
  • func NewNotFoundWrap(err error) *Error
  • func NewUnauthorized() *Error
  • func NewUnauthorizedWrap(err error) *Error
  • func NewUnprocessableEntity() *Error
  • func NewUnprocessableEntityWrap(err error) *Error
  • func (self *Error) Cause() error
  • func (self *Error) Code() int
  • func (self *Error) Error() string
  • func (self *Error) SetCode(code int) *Error
  • func (self *Error) SetComment(comment string) *Error
  • func (self *Error) SetCommentf(format string, args ...interface{}) *Error
  • func (self *Error) String() string

Constants

const (
	NotFoundMessage            = "not found"
	ForbiddenMessage           = "forbidden"
	UnauthorizedMessage        = "unauthorized"
	InternalServerErrorMessage = "internal server error"
	UnprocessableMessage       = "unprocessable entity"
)

Variables

var DefaultMessageIfEmpty = ""

var ErrForbiddenCode = 403

var ErrInternalServerCode = 501

var ErrNotFoundCode = 404

you can register custom error codes below basic codes

var ErrUnauthorizedCode = 401

var ErrUnprocessableEntity = 422

var UndefinedErrorCode = -1

Functions

func Cause

func Cause(err error) error

Cause returns to the parent and returns the root cause of the error implements the "causer" interface.

func Code

func Code(err error) int

func GetCode

func GetCode(code int, dfault string) string

func Is

func Is(err error) bool

func SetCode

func SetCode(code int, value string)

func UnWrap

func UnWrap(err error) error

The UnWrap function takes an error and return unwraped error.

Types

type CauseHolder

type CauseHolder interface {
	Cause() error
}

type Error

type Error struct {
	// contains filtered or unexported fields
}

func New

func New(code int, casue error, comment string) *Error

func NewForbidden

func NewForbidden() *Error

func NewForbiddenWrap

func NewForbiddenWrap(err error) *Error

func NewInternalServer

func NewInternalServer() *Error

func NewInternalServerWrap

func NewInternalServerWrap(err error) *Error

func NewNotFound

func NewNotFound() *Error

func NewNotFoundWrap

func NewNotFoundWrap(err error) *Error

func NewUnauthorized

func NewUnauthorized() *Error

func NewUnauthorizedWrap

func NewUnauthorizedWrap(err error) *Error

func NewUnprocessableEntity

func NewUnprocessableEntity() *Error

func NewUnprocessableEntityWrap

func NewUnprocessableEntityWrap(err error) *Error

func (*Error) Cause

func (self *Error) Cause() error

func (*Error) Code

func (self *Error) Code() int

func (*Error) Error

func (self *Error) Error() string

func (*Error) SetCode

func (self *Error) SetCode(code int) *Error

func (*Error) SetComment

func (self *Error) SetComment(comment string) *Error

func (*Error) SetCommentf

func (self *Error) SetCommentf(format string, args ...interface{}) *Error

func (*Error) String

func (self *Error) String() string