simplehttp

Documentation

Index

• func DefaultMapping() map[simplerr.Code]HTTPStatus
• func NewHandlerFuncAdapter(h HandlerFunc, opts ...HandlerOption) http.HandlerFunc
• func SetDefaultErrorStatus(code int)
• func SetMapping(m map[simplerr.Code]HTTPStatus)
• type ErrorHandler
• type HTTPStatus
  • func GetStatus(err error) (status HTTPStatus, found bool)
  • func SetStatus(r http.ResponseWriter, err error) HTTPStatus
• type Handler
• type HandlerAdapter
  • func NewHandlerAdapter(h Handler, opts ...HandlerOption) *HandlerAdapter
  • func (h HandlerAdapter) ServeHTTP(writer http.ResponseWriter, request *http.Request)
• type HandlerFunc
  • func (h HandlerFunc) Adapter(opts ...HandlerOption) http.HandlerFunc
  • func (h HandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request) error
• type HandlerOption
  • func WithErrorHandler(h ErrorHandler) HandlerOption

Functions

func DefaultMapping

func DefaultMapping() map[simplerr.Code]HTTPStatus

DefaultMapping returns the default mapping of SimpleError codes to HTTP status codes

func NewHandlerFuncAdapter

func NewHandlerFuncAdapter(h HandlerFunc, opts ...HandlerOption) http.HandlerFunc

NewHandlerFuncAdapter returns a http.HandlerFunc which calls SetStatus on the returned error

func SetDefaultErrorStatus

func SetDefaultErrorStatus(code int)

SetDefaultErrorStatus changes the default HTTP status code for when a translation could not be found. The default status code is 500.

func SetMapping

func SetMapping(m map[simplerr.Code]HTTPStatus)

SetMapping sets the mapping from simplerr.Code to HTTP status code

Types

type ErrorHandler

type ErrorHandler func(http.ResponseWriter, *http.Request, error)

ErrorHandler is an error handling function for HTTP handlers

var DefaultErrorHandler ErrorHandler = func(w http.ResponseWriter, r *http.Request, err error) {
	SetStatus(w, err)
}

DefaultErrorHandler is the default error handling function for HTTP handlers, it Sets the response status based on the handler's returned error using the SimpleError to HTTP mapping. The DefaultErrorHandler can be changed to also provide other error handling such as logging.

type HTTPStatus

type HTTPStatus = int

HTTPStatus is the HTTP status code

func GetStatus

func GetStatus(err error) (status HTTPStatus, found bool)

GetStatus returns the HTTP status that the error maps to if the provided error is a SimpleError. If a mapping could not be found or the error is nil, then the boolean second argument is returned as false

func SetStatus

func SetStatus(r http.ResponseWriter, err error) HTTPStatus

SetStatus sets the http.Response status from the error code in the provided error. It returns the HTTPStatus that was written If the error contains a SimpleError, then the status is determined by the mapping. If the error is not a SimpleError then the default error status code will be set. If the error is nil, then no status will be set.

type Handler

type Handler interface {
	ServeHTTP(http.ResponseWriter, *http.Request) error
}

Handler is analogous to http.Handler but returns an error

type HandlerAdapter

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

HandlerAdapter adapts the Handler interface to the http.Handler interface

func NewHandlerAdapter

func NewHandlerAdapter(h Handler, opts ...HandlerOption) *HandlerAdapter

NewHandlerAdapter returns a HandlerAdapter that can be used with the standard library http package.

func (HandlerAdapter) ServeHTTP

func (h HandlerAdapter) ServeHTTP(writer http.ResponseWriter, request *http.Request)

ServeHTTP calls the underlying handler's ServeHTTP method and calls SetStatus on the returned error

type HandlerFunc

type HandlerFunc func(http.ResponseWriter, *http.Request) error

HandlerFunc is analogous to http.HandlerFunc but returns an error

func (HandlerFunc) Adapter

func (h HandlerFunc) Adapter(opts ...HandlerOption) http.HandlerFunc

Adapter returns a http.HandlerFunc which calls SetStatus on the returned error

func (HandlerFunc) ServeHTTP

func (h HandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request) error

ServerHTTP implements the Handler interface

type HandlerOption

type HandlerOption func(adapter *HandlerAdapter)

HandlerOption are options to change the behaviour of the HandlerAdapter

func WithErrorHandler

func WithErrorHandler(h ErrorHandler) HandlerOption

WithErrorHandler is an HandlerOption to change the error handling function