httperror

Documentation

Index

• type Error
  • func InternalServerError(err error) *Error
  • func New(httpStatus int, displayMsg string, err error) *Error
  • func NotFound(res string, err error) *Error
  • func ParameterMissing(param string, err error) *Error
  • func PermissionDenied(action, subject string, err error) *Error
  • func ValueRequired(param string) *Error
  • func ValueTooLong(param string, nchars int) *Error
  • func (e Error) Error() string
  • func (e *Error) Unwrap() error

Types

type Error

type Error struct {
	DisplayMsg string `json:"display_message"`
	HTTPStatus int    `json:"status"`
	Err        error  `json:"-"`
}

Error enriches the original go error type with

DisplayMsg the human readable display message
HTTPStatus the HTTP status code
Err the internal error

func InternalServerError

func InternalServerError(err error) *Error

InternalServerError returns a internal server error message with code 500. Display message: "An internal server error occurred."

func New

func New(httpStatus int, displayMsg string, err error) *Error

New returns a new error

func NotFound

func NotFound(res string, err error) *Error

NotFound returns a not found message with code 404. The following display message is returned: "The [res] was not found."

func ParameterMissing

func ParameterMissing(param string, err error) *Error

ParameterMissing returns a parameter missing message with code 422. Display message: "The parameter [param] is invalid."

func PermissionDenied

func PermissionDenied(action, subject string, err error) *Error

PermissionDenied returns a permission denied message with code 403. The following display message is returned: "You are not allowed to [action] the [subject]."

func ValueRequired

func ValueRequired(param string) *Error

ValueRequired returns a value required message with code 422. Display message: "Please fill out the field [param]."

func ValueTooLong

func ValueTooLong(param string, nchars int) *Error

ValueTooLong returns the following display message with code 422. Display message: "The value of [param] is too long. Maximum [nchars] characters are allowed."

func (Error) Error

func (e Error) Error() string

func (*Error) Unwrap

func (e *Error) Unwrap() error