apperr

Documentation

Index

• Variables
• func Response(c *gin.Context, err error)
• type APPError
  • func New(status int, msg string) *APPError
  • func NewStatus(status int) *APPError
  • func (e APPError) Error() string

Variables

var (
	// Generic error
	Generic = NewStatus(http.StatusInternalServerError)
	// DB represents database related errors
	DB = NewStatus(http.StatusInternalServerError)
	// Forbidden represents access to forbidden resource error
	Forbidden = NewStatus(http.StatusForbidden)
	// BadRequest represents error for bad requests
	BadRequest = NewStatus(http.StatusBadRequest)
	// NotFound represents errors for not found resources
	NotFound = NewStatus(http.StatusNotFound)
	// Unauthorized represents errors for unauthorized requests
	Unauthorized = NewStatus(http.StatusUnauthorized)
)

Functions

func Response

func Response(c *gin.Context, err error)

Response writes an error response to client

Types

type APPError

type APPError struct {
	// HTTP Status code to be set in response
	Status int `json:"-"`
	// Message is the error message that may be displayed to end users
	Message string `json:"message,omitempty"`
}

APPError is the default error struct containing detailed information about the error

func New

func New(status int, msg string) *APPError

New generates an application error

func NewStatus

func NewStatus(status int) *APPError

NewStatus generates new error containing only http status code

func (APPError) Error

func (e APPError) Error() string

Error returns the error message.