errors

Documentation

Overview

Package errors provides definitions for some common errors that may be encountered. These errors may be eventually mapped to HTTP error codes, when being returned as a response.

Index

• Constants
• func GetHTTPErrorCode(err error) int
• func Newf(et ErrorType, msg string, args ...interface{}) error
• func Wrapf(err error, msg string, args ...interface{}) error
• type ErrorType
  • func GetType(err error) ErrorType
• type HTTPError
  • func NewHTTPError(err error) *HTTPError
  • func (e *HTTPError) Error() string

Constants

const (
	// Unknown error type is used for all generic errors
	Unknown = ErrorType(iota)
	// BadInput is used when any function encounters bad/incomplete input
	BadInput
	// NotFound is used when a resource cannot be located
	NotFound
)

Functions

func GetHTTPErrorCode

func GetHTTPErrorCode(err error) int

GetHTTPErrorCode maps the ErrorType to http status codes and returns it

func Newf

func Newf(et ErrorType, msg string, args ...interface{}) error

Newf creates a new errorData of the specified type with formatted message

func Wrapf

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

Wrapf creates a new wrapped errorData with formatted message

Types

type ErrorType

type ErrorType uint

ErrorType captures some common error types

func GetType

func GetType(err error) ErrorType

GetType returns the error type

type HTTPError

type HTTPError struct {
	Code    int
	Message string
}

HTTPError associates an error message with a HTTP status code.

func NewHTTPError

func NewHTTPError(err error) *HTTPError

func (*HTTPError) Error

func (e *HTTPError) Error() string

Error satisfies the error interface