README
¶
herrors 
import "github.com/geek/herrors"
Examples
Basic Bad Request
func handler(w http.ResponseWriter, r *http.Request) {
// perform some validation
if !isValid(r) {
herrors.Write(w, herrors.ErrBadRequest)
return
}
}
Bad Request with Wrapping
func validate(r *http.Request) error {
// ... do some validation and return an error on failure
}
func handler(w http.ResponseWriter, r *http.Request) {
if err := validate(r); err != nil {
err = herrors.Wrap(err, http.StatusBadRequest)
herrors.Write(w, err)
return
}
}
Usage
func New
func New(statusCode uint) error
New constructs an ErrHttp error with the code and message populated
func Wrap
func Wrap(err error, statusCode uint) error
Wrap will create a new ErrHttp and place the provided error inside of it. There is a complementary errors.Unwrap to retrieve the wrapped error.
func Write
func Write(w http.ResponseWriter, err error)
Write sets the response status code to the provided error code. When unable to find an ErrHttp error in the error chain then a 500 internal error is output.
type ErrHttp
type ErrHttp struct {
}
func (*ErrHttp) Code
func (e *ErrHttp) Code() uint
Code returns http status code that the error represents
func (*ErrHttp) Error
func (e *ErrHttp) Error() string
Error returns http friendly error message
func (*ErrHttp) Is
func (e *ErrHttp) Is(target error) bool
Is used by errors.Is for comparing ErrHttp
func (*ErrHttp) Unwrap
func (e *ErrHttp) Unwrap() error
Unwrap will return the first wrapped error if there is one
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // 4xx errors ErrBadRequest = New(http.StatusBadRequest) ErrPaymentRequired = New(http.StatusPaymentRequired) ErrForbidden = New(http.StatusForbidden) ErrNotFound = New(http.StatusNotFound) ErrMethodNotAllowed = New(http.StatusMethodNotAllowed) ErrNotAcceptable = New(http.StatusNotAcceptable) ErrProxyAuthRequired = New(http.StatusProxyAuthRequired) ErrRequestTimeout = New(http.StatusRequestTimeout) ErrConflict = New(http.StatusConflict) ErrResourceGone = New(http.StatusGone) ErrLengthRequired = New(http.StatusLengthRequired) ErrPreconditionFailed = New(http.StatusPreconditionFailed) ErrEntityTooLarge = New(http.StatusRequestEntityTooLarge) ErrURITooLong = New(http.StatusRequestURITooLong) ErrUnsupportedMediaType = New(http.StatusUnsupportedMediaType) ErrRangeNotSatisfiable = New(http.StatusRequestedRangeNotSatisfiable) ErrExpectationFailed = New(http.StatusExpectationFailed) ErrMisdirectedRequest = New(http.StatusMisdirectedRequest) ErrUnprocessableEntity = New(http.StatusUnprocessableEntity) ErrLocked = New(http.StatusLocked) ErrFailedDependency = New(http.StatusFailedDependency) ErrTooEarly = New(http.StatusTooEarly) ErrPreconditionRequired = New(http.StatusPreconditionRequired) ErrTooManyRequests = New(http.StatusTooManyRequests) ErrHeaderFieldsTooLarge = New(http.StatusRequestHeaderFieldsTooLarge) ErrIllegal = New(http.StatusUnavailableForLegalReasons) // 5xx errors ErrInternalServer = New(http.StatusInternalServerError) ErrNotImplemented = New(http.StatusNotImplemented) ErrBadGateway = New(http.StatusBadGateway) ErrGatewayTimeout = New(http.StatusGatewayTimeout) ErrHTTPVersionNotSupported = New(http.StatusHTTPVersionNotSupported) ErrVariantAlsoNegotiates = New(http.StatusVariantAlsoNegotiates) ErrInsufficientStorage = New(http.StatusInsufficientStorage) ErrLoopDetected = New(http.StatusLoopDetected) ErrNotExtended = New(http.StatusNotExtended) ErrNetworkAuthenticationRequired = New(http.StatusNetworkAuthenticationRequired) )
Functions ¶
func Wrap ¶
Wrap will create a new ErrHttp and place the provided error inside of it. There is a complementary errors.Unwrap to retrieve the wrapped error.
func Write ¶
func Write(w http.ResponseWriter, err error)
Write sets the response status code to the provided error code. When unable to find an ErrHttp error in the error chain then a 500 internal error is output.
Source Files