README
¶
erkhttp
Allows erk error kinds to embed HTTP Statuses.
Install
$ github.com/JosiahWitt/erkhttp
Usage
Embed HTTP Statuses in erk errors:
type ErkItemNotFound {
erk.DefaultKind
erkhttp.StatusNotFound
}
Fetch the HTTP Status using erkhttp.GetHTTPStatus:
var ErrItemNotFound = erk.New(ErkItemNotFound{}, "item with key '{{.key}}' was not found")
func main() {
fmt.Println(erkhttp.GetHTTPStatus(ErrItemNotFound)) // Prints 404, true
}
Documentation
¶
Overview ¶
Package erkhttp allows embeding HTTP statuses in erk error kinds.
Index ¶
- func GetHTTPStatus(err error) (int, bool)
- type HTTPStatusable
- type StatusAccepted
- type StatusAlreadyReported
- type StatusBadGateway
- type StatusBadRequest
- type StatusConflict
- type StatusContinue
- type StatusCreated
- type StatusEarlyHints
- type StatusExpectationFailed
- type StatusFailedDependency
- type StatusForbidden
- type StatusFound
- type StatusGatewayTimeout
- type StatusGone
- type StatusHTTPVersionNotSupported
- type StatusIMUsed
- type StatusInsufficientStorage
- type StatusInternalServerError
- type StatusLengthRequired
- type StatusLocked
- type StatusLoopDetected
- type StatusMethodNotAllowed
- type StatusMisdirectedRequest
- type StatusMovedPermanently
- type StatusMultiStatus
- type StatusMultipleChoices
- type StatusNetworkAuthenticationRequired
- type StatusNoContent
- type StatusNonAuthoritativeInfo
- type StatusNotAcceptable
- type StatusNotExtended
- type StatusNotFound
- type StatusNotImplemented
- type StatusNotModified
- type StatusOK
- type StatusPartialContent
- type StatusPaymentRequired
- type StatusPermanentRedirect
- type StatusPreconditionFailed
- type StatusPreconditionRequired
- type StatusProcessing
- type StatusProxyAuthRequired
- type StatusRequestEntityTooLarge
- type StatusRequestHeaderFieldsTooLarge
- type StatusRequestTimeout
- type StatusRequestURITooLong
- type StatusRequestedRangeNotSatisfiable
- type StatusResetContent
- type StatusSeeOther
- type StatusServiceUnavailable
- type StatusSwitchingProtocols
- type StatusTeapot
- type StatusTemporaryRedirect
- type StatusTooEarly
- type StatusTooManyRequests
- type StatusUnauthorized
- type StatusUnavailableForLegalReasons
- type StatusUnprocessableEntity
- type StatusUnsupportedMediaType
- type StatusUpgradeRequired
- type StatusUseProxy
- type StatusVariantAlsoNegotiates
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetHTTPStatus ¶
GetHTTPStatus from the kind of the provided error.
If the status cannot be found, it defaults to 500 (Internal Server Error), and returns false.
Types ¶
type HTTPStatusable ¶
type HTTPStatusable interface {
HTTPStatus() int
}
HTTPStatusable items can return an HTTP status.
type StatusAccepted ¶
type StatusAccepted struct{}
StatusAccepted = 202
func (StatusAccepted) HTTPStatus ¶
func (StatusAccepted) HTTPStatus() int
type StatusAlreadyReported ¶
type StatusAlreadyReported struct{}
StatusAlreadyReported = 208
func (StatusAlreadyReported) HTTPStatus ¶
func (StatusAlreadyReported) HTTPStatus() int
type StatusBadGateway ¶
type StatusBadGateway struct{}
StatusBadGateway = 502
func (StatusBadGateway) HTTPStatus ¶
func (StatusBadGateway) HTTPStatus() int
type StatusBadRequest ¶
type StatusBadRequest struct{}
StatusBadRequest = 400
func (StatusBadRequest) HTTPStatus ¶
func (StatusBadRequest) HTTPStatus() int
type StatusConflict ¶
type StatusConflict struct{}
StatusConflict = 409
func (StatusConflict) HTTPStatus ¶
func (StatusConflict) HTTPStatus() int
type StatusContinue ¶
type StatusContinue struct{}
StatusContinue = 100
func (StatusContinue) HTTPStatus ¶
func (StatusContinue) HTTPStatus() int
type StatusCreated ¶
type StatusCreated struct{}
StatusCreated = 201
func (StatusCreated) HTTPStatus ¶
func (StatusCreated) HTTPStatus() int
type StatusEarlyHints ¶
type StatusEarlyHints struct{}
StatusEarlyHints = 103
func (StatusEarlyHints) HTTPStatus ¶
func (StatusEarlyHints) HTTPStatus() int
type StatusExpectationFailed ¶
type StatusExpectationFailed struct{}
StatusExpectationFailed = 417
func (StatusExpectationFailed) HTTPStatus ¶
func (StatusExpectationFailed) HTTPStatus() int
type StatusFailedDependency ¶
type StatusFailedDependency struct{}
StatusFailedDependency = 424
func (StatusFailedDependency) HTTPStatus ¶
func (StatusFailedDependency) HTTPStatus() int
type StatusForbidden ¶
type StatusForbidden struct{}
StatusForbidden = 403
func (StatusForbidden) HTTPStatus ¶
func (StatusForbidden) HTTPStatus() int
type StatusFound ¶
type StatusFound struct{}
StatusFound = 302
func (StatusFound) HTTPStatus ¶
func (StatusFound) HTTPStatus() int
type StatusGatewayTimeout ¶
type StatusGatewayTimeout struct{}
StatusGatewayTimeout = 504
func (StatusGatewayTimeout) HTTPStatus ¶
func (StatusGatewayTimeout) HTTPStatus() int
type StatusGone ¶
type StatusGone struct{}
StatusGone = 410
func (StatusGone) HTTPStatus ¶
func (StatusGone) HTTPStatus() int
type StatusHTTPVersionNotSupported ¶
type StatusHTTPVersionNotSupported struct{}
StatusHTTPVersionNotSupported = 505
func (StatusHTTPVersionNotSupported) HTTPStatus ¶
func (StatusHTTPVersionNotSupported) HTTPStatus() int
type StatusIMUsed ¶
type StatusIMUsed struct{}
StatusIMUsed = 226
func (StatusIMUsed) HTTPStatus ¶
func (StatusIMUsed) HTTPStatus() int
type StatusInsufficientStorage ¶
type StatusInsufficientStorage struct{}
StatusInsufficientStorage = 507
func (StatusInsufficientStorage) HTTPStatus ¶
func (StatusInsufficientStorage) HTTPStatus() int
type StatusInternalServerError ¶
type StatusInternalServerError struct{}
StatusInternalServerError = 500
func (StatusInternalServerError) HTTPStatus ¶
func (StatusInternalServerError) HTTPStatus() int
type StatusLengthRequired ¶
type StatusLengthRequired struct{}
StatusLengthRequired = 411
func (StatusLengthRequired) HTTPStatus ¶
func (StatusLengthRequired) HTTPStatus() int
type StatusLocked ¶
type StatusLocked struct{}
StatusLocked = 423
func (StatusLocked) HTTPStatus ¶
func (StatusLocked) HTTPStatus() int
type StatusLoopDetected ¶
type StatusLoopDetected struct{}
StatusLoopDetected = 508
func (StatusLoopDetected) HTTPStatus ¶
func (StatusLoopDetected) HTTPStatus() int
type StatusMethodNotAllowed ¶
type StatusMethodNotAllowed struct{}
StatusMethodNotAllowed = 405
func (StatusMethodNotAllowed) HTTPStatus ¶
func (StatusMethodNotAllowed) HTTPStatus() int
type StatusMisdirectedRequest ¶
type StatusMisdirectedRequest struct{}
StatusMisdirectedRequest = 421
func (StatusMisdirectedRequest) HTTPStatus ¶
func (StatusMisdirectedRequest) HTTPStatus() int
type StatusMovedPermanently ¶
type StatusMovedPermanently struct{}
StatusMovedPermanently = 301
func (StatusMovedPermanently) HTTPStatus ¶
func (StatusMovedPermanently) HTTPStatus() int
type StatusMultiStatus ¶
type StatusMultiStatus struct{}
StatusMultiStatus = 207
func (StatusMultiStatus) HTTPStatus ¶
func (StatusMultiStatus) HTTPStatus() int
type StatusMultipleChoices ¶
type StatusMultipleChoices struct{}
StatusMultipleChoices = 300
func (StatusMultipleChoices) HTTPStatus ¶
func (StatusMultipleChoices) HTTPStatus() int
type StatusNetworkAuthenticationRequired ¶
type StatusNetworkAuthenticationRequired struct{}
StatusNetworkAuthenticationRequired = 511
func (StatusNetworkAuthenticationRequired) HTTPStatus ¶
func (StatusNetworkAuthenticationRequired) HTTPStatus() int
type StatusNoContent ¶
type StatusNoContent struct{}
StatusNoContent = 204
func (StatusNoContent) HTTPStatus ¶
func (StatusNoContent) HTTPStatus() int
type StatusNonAuthoritativeInfo ¶
type StatusNonAuthoritativeInfo struct{}
StatusNonAuthoritativeInfo = 203
func (StatusNonAuthoritativeInfo) HTTPStatus ¶
func (StatusNonAuthoritativeInfo) HTTPStatus() int
type StatusNotAcceptable ¶
type StatusNotAcceptable struct{}
StatusNotAcceptable = 406
func (StatusNotAcceptable) HTTPStatus ¶
func (StatusNotAcceptable) HTTPStatus() int
type StatusNotExtended ¶
type StatusNotExtended struct{}
StatusNotExtended = 510
func (StatusNotExtended) HTTPStatus ¶
func (StatusNotExtended) HTTPStatus() int
type StatusNotFound ¶
type StatusNotFound struct{}
StatusNotFound = 404
func (StatusNotFound) HTTPStatus ¶
func (StatusNotFound) HTTPStatus() int
type StatusNotImplemented ¶
type StatusNotImplemented struct{}
StatusNotImplemented = 501
func (StatusNotImplemented) HTTPStatus ¶
func (StatusNotImplemented) HTTPStatus() int
type StatusNotModified ¶
type StatusNotModified struct{}
StatusNotModified = 304
func (StatusNotModified) HTTPStatus ¶
func (StatusNotModified) HTTPStatus() int
type StatusPartialContent ¶
type StatusPartialContent struct{}
StatusPartialContent = 206
func (StatusPartialContent) HTTPStatus ¶
func (StatusPartialContent) HTTPStatus() int
type StatusPaymentRequired ¶
type StatusPaymentRequired struct{}
StatusPaymentRequired = 402
func (StatusPaymentRequired) HTTPStatus ¶
func (StatusPaymentRequired) HTTPStatus() int
type StatusPermanentRedirect ¶
type StatusPermanentRedirect struct{}
StatusPermanentRedirect = 308
func (StatusPermanentRedirect) HTTPStatus ¶
func (StatusPermanentRedirect) HTTPStatus() int
type StatusPreconditionFailed ¶
type StatusPreconditionFailed struct{}
StatusPreconditionFailed = 412
func (StatusPreconditionFailed) HTTPStatus ¶
func (StatusPreconditionFailed) HTTPStatus() int
type StatusPreconditionRequired ¶
type StatusPreconditionRequired struct{}
StatusPreconditionRequired = 428
func (StatusPreconditionRequired) HTTPStatus ¶
func (StatusPreconditionRequired) HTTPStatus() int
type StatusProcessing ¶
type StatusProcessing struct{}
StatusProcessing = 102
func (StatusProcessing) HTTPStatus ¶
func (StatusProcessing) HTTPStatus() int
type StatusProxyAuthRequired ¶
type StatusProxyAuthRequired struct{}
StatusProxyAuthRequired = 407
func (StatusProxyAuthRequired) HTTPStatus ¶
func (StatusProxyAuthRequired) HTTPStatus() int
type StatusRequestEntityTooLarge ¶
type StatusRequestEntityTooLarge struct{}
StatusRequestEntityTooLarge = 413
func (StatusRequestEntityTooLarge) HTTPStatus ¶
func (StatusRequestEntityTooLarge) HTTPStatus() int
type StatusRequestHeaderFieldsTooLarge ¶
type StatusRequestHeaderFieldsTooLarge struct{}
StatusRequestHeaderFieldsTooLarge = 431
func (StatusRequestHeaderFieldsTooLarge) HTTPStatus ¶
func (StatusRequestHeaderFieldsTooLarge) HTTPStatus() int
type StatusRequestTimeout ¶
type StatusRequestTimeout struct{}
StatusRequestTimeout = 408
func (StatusRequestTimeout) HTTPStatus ¶
func (StatusRequestTimeout) HTTPStatus() int
type StatusRequestURITooLong ¶
type StatusRequestURITooLong struct{}
StatusRequestURITooLong = 414
func (StatusRequestURITooLong) HTTPStatus ¶
func (StatusRequestURITooLong) HTTPStatus() int
type StatusRequestedRangeNotSatisfiable ¶
type StatusRequestedRangeNotSatisfiable struct{}
StatusRequestedRangeNotSatisfiable = 416
func (StatusRequestedRangeNotSatisfiable) HTTPStatus ¶
func (StatusRequestedRangeNotSatisfiable) HTTPStatus() int
type StatusResetContent ¶
type StatusResetContent struct{}
StatusResetContent = 205
func (StatusResetContent) HTTPStatus ¶
func (StatusResetContent) HTTPStatus() int
type StatusSeeOther ¶
type StatusSeeOther struct{}
StatusSeeOther = 303
func (StatusSeeOther) HTTPStatus ¶
func (StatusSeeOther) HTTPStatus() int
type StatusServiceUnavailable ¶
type StatusServiceUnavailable struct{}
StatusServiceUnavailable = 503
func (StatusServiceUnavailable) HTTPStatus ¶
func (StatusServiceUnavailable) HTTPStatus() int
type StatusSwitchingProtocols ¶
type StatusSwitchingProtocols struct{}
StatusSwitchingProtocols = 101
func (StatusSwitchingProtocols) HTTPStatus ¶
func (StatusSwitchingProtocols) HTTPStatus() int
type StatusTeapot ¶
type StatusTeapot struct{}
StatusTeapot = 418
func (StatusTeapot) HTTPStatus ¶
func (StatusTeapot) HTTPStatus() int
type StatusTemporaryRedirect ¶
type StatusTemporaryRedirect struct{}
StatusTemporaryRedirect = 307
func (StatusTemporaryRedirect) HTTPStatus ¶
func (StatusTemporaryRedirect) HTTPStatus() int
type StatusTooEarly ¶
type StatusTooEarly struct{}
StatusTooEarly = 425
func (StatusTooEarly) HTTPStatus ¶
func (StatusTooEarly) HTTPStatus() int
type StatusTooManyRequests ¶
type StatusTooManyRequests struct{}
StatusTooManyRequests = 429
func (StatusTooManyRequests) HTTPStatus ¶
func (StatusTooManyRequests) HTTPStatus() int
type StatusUnauthorized ¶
type StatusUnauthorized struct{}
StatusUnauthorized = 401
func (StatusUnauthorized) HTTPStatus ¶
func (StatusUnauthorized) HTTPStatus() int
type StatusUnavailableForLegalReasons ¶
type StatusUnavailableForLegalReasons struct{}
StatusUnavailableForLegalReasons = 451
func (StatusUnavailableForLegalReasons) HTTPStatus ¶
func (StatusUnavailableForLegalReasons) HTTPStatus() int
type StatusUnprocessableEntity ¶
type StatusUnprocessableEntity struct{}
StatusUnprocessableEntity = 422
func (StatusUnprocessableEntity) HTTPStatus ¶
func (StatusUnprocessableEntity) HTTPStatus() int
type StatusUnsupportedMediaType ¶
type StatusUnsupportedMediaType struct{}
StatusUnsupportedMediaType = 415
func (StatusUnsupportedMediaType) HTTPStatus ¶
func (StatusUnsupportedMediaType) HTTPStatus() int
type StatusUpgradeRequired ¶
type StatusUpgradeRequired struct{}
StatusUpgradeRequired = 426
func (StatusUpgradeRequired) HTTPStatus ¶
func (StatusUpgradeRequired) HTTPStatus() int
type StatusUseProxy ¶
type StatusUseProxy struct{}
StatusUseProxy = 305
func (StatusUseProxy) HTTPStatus ¶
func (StatusUseProxy) HTTPStatus() int
type StatusVariantAlsoNegotiates ¶
type StatusVariantAlsoNegotiates struct{}
StatusVariantAlsoNegotiates = 506
func (StatusVariantAlsoNegotiates) HTTPStatus ¶
func (StatusVariantAlsoNegotiates) HTTPStatus() int
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.