Safe Haskell	None
Language	Haskell2010

Network.HTTP.Kinder.Status

Contents

Functions and types for working with HeaderName Sings
The Status type/kind
Type synonyms for more convenient use of Statuses

Description

Defines the types and kinds for working with type and value level HTTP status codes.

In particular, this module exports a datatype, Status which is meant to be used with DataKinds providing one type, e.g. 'Ok for every common HTTP response status (and an override one CustomStatus). It also exports Sing values for each Status-kinded type each merely being the name of that type prepended with S.

Finally, it exports a set of type synonms for each Status-kinded type so that they can be referenced without the quote prefix '.

Synopsis

Functions and types for working with `HeaderName` `Sing`s

data SomeStatus where Source

It's difficult to get ahold of values of Status directly since they may contain Nat values which do not exist. Instead, we can get almost the same effect through an existential which holds a singleton at the Status kind

Note that while the Haddocks show this as taking any Sing type it is actually constrained only to have Sings of kind Status.

Constructors

SomeStatus :: forall s. Sing s -> SomeStatus

httpStatus :: forall sc. Sing sc -> Status Source

Convert a Status Sing-value into a normal http-types Status

statusCode :: forall sc. Sing sc -> Int Source

Get the Int status code for a given Status Sing.

parseStatus :: Int -> SomeStatus Source

Given a particular Int status create a Status Sing to match. Attempts to parse to a meaningful Status Sing but defaults to CustomStatus if necessary.

The `Status` type/kind

data Status Source

A data type representing HTTP statuses (codes). Much more importantly, with DataKinds enabled this becomes a kind describing types, one for each such status.

It's worth noting that values of this type can be had, but one branch, CustomStatus will not work since it requires Nat values which cannot be had. For this reason prefer using values of SomeStatus instead of values of Status directly.

Constructors

CustomStatus Nat	Inject an arbitatry code number as a status code.
Continue
SwitchingProtocols
Ok
Created
Accepted
NonAuthoritiveInformation
NoContent
ResetContent
PartialContent
IMUsed
MultipleChoices
MovedPermanently
Found
SeeOther
NotModified
TemporaryRedirect
PermanentRedirect
BadRequest
Unauthorized
PaymentRequired
Forbidden
NotFound
MethodNotAllowed
NotAcceptable
ProxyAuthenticationRequired
RequestTimeout
Conflict
Gone
LengthRequired
PreconditionFailed
PayloadTooLarge
RequestURITooLong
UnsupportedMediaType
RequestedRangeNotSatisfiable
ExpectationFailed
MisdirectedRequest
UnprocessableEntity
Locked
FailedDependency
UpgradeRequired
PreconditionRequired
TooManyRequests
RequestHeaderFieldsTooLarge
UnavailableForLegalReasons
InternalServerError
NotImplemented
BadGateway
ServiceUnavailable
GatewayTimeout
HTTPVersionNotSupported
VariantAlsoNegotiates
InsufficientStorage
LoopDetected
NotExtended
NetworkAuthenticationRequired

Instances

SingI Status Continue Source
SingI Status SwitchingProtocols Source
SingI Status Ok Source
SingI Status Created Source
SingI Status Accepted Source
SingI Status NonAuthoritiveInformation Source
SingI Status NoContent Source
SingI Status ResetContent Source
SingI Status PartialContent Source
SingI Status IMUsed Source
SingI Status MultipleChoices Source
SingI Status MovedPermanently Source
SingI Status Found Source
SingI Status SeeOther Source
SingI Status NotModified Source
SingI Status TemporaryRedirect Source
SingI Status PermanentRedirect Source
SingI Status BadRequest Source
SingI Status Unauthorized Source
SingI Status PaymentRequired Source
SingI Status Forbidden Source
SingI Status NotFound Source
SingI Status MethodNotAllowed Source
SingI Status NotAcceptable Source
SingI Status ProxyAuthenticationRequired Source
SingI Status RequestTimeout Source
SingI Status Conflict Source
SingI Status Gone Source
SingI Status LengthRequired Source
SingI Status PreconditionFailed Source
SingI Status PayloadTooLarge Source
SingI Status RequestURITooLong Source
SingI Status UnsupportedMediaType Source
SingI Status RequestedRangeNotSatisfiable Source
SingI Status ExpectationFailed Source
SingI Status MisdirectedRequest Source
SingI Status UnprocessableEntity Source
SingI Status Locked Source
SingI Status FailedDependency Source
SingI Status UpgradeRequired Source
SingI Status PreconditionRequired Source
SingI Status TooManyRequests Source
SingI Status RequestHeaderFieldsTooLarge Source
SingI Status UnavailableForLegalReasons Source
SingI Status InternalServerError Source
SingI Status NotImplemented Source
SingI Status BadGateway Source
SingI Status ServiceUnavailable Source
SingI Status GatewayTimeout Source
SingI Status HTTPVersionNotSupported Source
SingI Status VariantAlsoNegotiates Source
SingI Status InsufficientStorage Source
SingI Status LoopDetected Source
SingI Status NotExtended Source
SingI Status NetworkAuthenticationRequired Source
SingI Nat i => SingI Status (CustomStatus i) Source
data Sing Status where SCustomStatus :: (~) Status s (CustomStatus i) => Sing Nat i -> Sing Status s SContinue :: (~) Status s Continue => Sing Status s SSwitchingProtocols :: (~) Status s SwitchingProtocols => Sing Status s SOk :: (~) Status s Ok => Sing Status s SCreated :: (~) Status s Created => Sing Status s SAccepted :: (~) Status s Accepted => Sing Status s SNonAuthoritiveInformation :: (~) Status s NonAuthoritiveInformation => Sing Status s SNoContent :: (~) Status s NoContent => Sing Status s SResetContent :: (~) Status s ResetContent => Sing Status s SPartialContent :: (~) Status s PartialContent => Sing Status s SIMUsed :: (~) Status s IMUsed => Sing Status s SMultipleChoices :: (~) Status s MultipleChoices => Sing Status s SMovedPermanently :: (~) Status s MovedPermanently => Sing Status s SFound :: (~) Status s Found => Sing Status s SSeeOther :: (~) Status s SeeOther => Sing Status s SNotModified :: (~) Status s NotModified => Sing Status s STemporaryRedirect :: (~) Status s TemporaryRedirect => Sing Status s SPermanentRedirect :: (~) Status s PermanentRedirect => Sing Status s SBadRequest :: (~) Status s BadRequest => Sing Status s SUnauthorized :: (~) Status s Unauthorized => Sing Status s SPaymentRequired :: (~) Status s PaymentRequired => Sing Status s SForbidden :: (~) Status s Forbidden => Sing Status s SNotFound :: (~) Status s NotFound => Sing Status s SMethodNotAllowed :: (~) Status s MethodNotAllowed => Sing Status s SNotAcceptable :: (~) Status s NotAcceptable => Sing Status s SProxyAuthenticationRequired :: (~) Status s ProxyAuthenticationRequired => Sing Status s SRequestTimeout :: (~) Status s RequestTimeout => Sing Status s SConflict :: (~) Status s Conflict => Sing Status s SGone :: (~) Status s Gone => Sing Status s SLengthRequired :: (~) Status s LengthRequired => Sing Status s SPreconditionFailed :: (~) Status s PreconditionFailed => Sing Status s SPayloadTooLarge :: (~) Status s PayloadTooLarge => Sing Status s SRequestURITooLong :: (~) Status s RequestURITooLong => Sing Status s SUnsupportedMediaType :: (~) Status s UnsupportedMediaType => Sing Status s SRequestedRangeNotSatisfiable :: (~) Status s RequestedRangeNotSatisfiable => Sing Status s SExpectationFailed :: (~) Status s ExpectationFailed => Sing Status s SMisdirectedRequest :: (~) Status s MisdirectedRequest => Sing Status s SUnprocessableEntity :: (~) Status s UnprocessableEntity => Sing Status s SLocked :: (~) Status s Locked => Sing Status s SFailedDependency :: (~) Status s FailedDependency => Sing Status s SUpgradeRequired :: (~) Status s UpgradeRequired => Sing Status s SPreconditionRequired :: (~) Status s PreconditionRequired => Sing Status s STooManyRequests :: (~) Status s TooManyRequests => Sing Status s SRequestHeaderFieldsTooLarge :: (~) Status s RequestHeaderFieldsTooLarge => Sing Status s SUnavailableForLegalReasons :: (~) Status s UnavailableForLegalReasons => Sing Status s SInternalServerError :: (~) Status s InternalServerError => Sing Status s SNotImplemented :: (~) Status s NotImplemented => Sing Status s SBadGateway :: (~) Status s BadGateway => Sing Status s SServiceUnavailable :: (~) Status s ServiceUnavailable => Sing Status s SGatewayTimeout :: (~) Status s GatewayTimeout => Sing Status s SHTTPVersionNotSupported :: (~) Status s HTTPVersionNotSupported => Sing Status s SVariantAlsoNegotiates :: (~) Status s VariantAlsoNegotiates => Sing Status s SInsufficientStorage :: (~) Status s InsufficientStorage => Sing Status s SLoopDetected :: (~) Status s LoopDetected => Sing Status s SNotExtended :: (~) Status s NotExtended => Sing Status s SNetworkAuthenticationRequired :: (~) Status s NetworkAuthenticationRequired => Sing Status s Source

data family Sing a

The singleton kind-indexed data family.

Instances

data Sing Bool where SFalse :: (~) Bool z0 False => Sing Bool z0 STrue :: (~) Bool z0 True => Sing Bool z0
data Sing Ordering where SLT :: (~) Ordering z0 LT => Sing Ordering z0 SEQ :: (~) Ordering z0 EQ => Sing Ordering z0 SGT :: (~) Ordering z0 GT => Sing Ordering z0
data Sing Nat where SNat :: KnownNat n => Sing Nat n
data Sing Symbol where SSym :: KnownSymbol n => Sing Symbol n
data Sing () where STuple0 :: (~) () z0 () => Sing () z0
data Sing HeaderName where SCustomHeader :: (~) HeaderName h (CustomHeader s) => Sing Symbol s -> Sing HeaderName h SAccept :: (~) HeaderName h Accept => Sing HeaderName h SAcceptCharset :: (~) HeaderName h AcceptCharset => Sing HeaderName h SAcceptEncoding :: (~) HeaderName h AcceptEncoding => Sing HeaderName h SAcceptLanguage :: (~) HeaderName h AcceptLanguage => Sing HeaderName h SAcceptPatch :: (~) HeaderName h AcceptPatch => Sing HeaderName h SAcceptRanges :: (~) HeaderName h AcceptRanges => Sing HeaderName h SAccessControlAllowCredentials :: (~) HeaderName h AccessControlAllowCredentials => Sing HeaderName h SAccessControlAllowHeaders :: (~) HeaderName h AccessControlAllowHeaders => Sing HeaderName h SAccessControlAllowMethods :: (~) HeaderName h AccessControlAllowMethods => Sing HeaderName h SAccessControlAllowOrigin :: (~) HeaderName h AccessControlAllowOrigin => Sing HeaderName h SAccessControlExposeHeaders :: (~) HeaderName h AccessControlExposeHeaders => Sing HeaderName h SAccessControlMaxAge :: (~) HeaderName h AccessControlMaxAge => Sing HeaderName h SAccessControlRequestHeaders :: (~) HeaderName h AccessControlRequestHeaders => Sing HeaderName h SAccessControlRequestMethod :: (~) HeaderName h AccessControlRequestMethod => Sing HeaderName h SAge :: (~) HeaderName h Age => Sing HeaderName h SAllow :: (~) HeaderName h Allow => Sing HeaderName h SAuthorization :: (~) HeaderName h Authorization => Sing HeaderName h SCacheControl :: (~) HeaderName h CacheControl => Sing HeaderName h SConnection :: (~) HeaderName h Connection => Sing HeaderName h SContentDisposition :: (~) HeaderName h ContentDisposition => Sing HeaderName h SContentEncoding :: (~) HeaderName h ContentEncoding => Sing HeaderName h SContentLanguage :: (~) HeaderName h ContentLanguage => Sing HeaderName h SContentLength :: (~) HeaderName h ContentLength => Sing HeaderName h SContentLocation :: (~) HeaderName h ContentLocation => Sing HeaderName h SContentRange :: (~) HeaderName h ContentRange => Sing HeaderName h SContentSecurityPolicy :: (~) HeaderName h ContentSecurityPolicy => Sing HeaderName h SContentType :: (~) HeaderName h ContentType => Sing HeaderName h SCookie :: (~) HeaderName h Cookie => Sing HeaderName h SDate :: (~) HeaderName h Date => Sing HeaderName h SETag :: (~) HeaderName h ETag => Sing HeaderName h SExpect :: (~) HeaderName h Expect => Sing HeaderName h SExpires :: (~) HeaderName h Expires => Sing HeaderName h SFrom :: (~) HeaderName h From => Sing HeaderName h SHost :: (~) HeaderName h Host => Sing HeaderName h SIfMatch :: (~) HeaderName h IfMatch => Sing HeaderName h SIfModifiedSince :: (~) HeaderName h IfModifiedSince => Sing HeaderName h SIfNoneMatch :: (~) HeaderName h IfNoneMatch => Sing HeaderName h SIfRange :: (~) HeaderName h IfRange => Sing HeaderName h SIfUnmodifiedSince :: (~) HeaderName h IfUnmodifiedSince => Sing HeaderName h SLastModified :: (~) HeaderName h LastModified => Sing HeaderName h SLink :: (~) HeaderName h Link => Sing HeaderName h SLocation :: (~) HeaderName h Location => Sing HeaderName h SMaxForwards :: (~) HeaderName h MaxForwards => Sing HeaderName h SOrigin :: (~) HeaderName h Origin => Sing HeaderName h SPragma :: (~) HeaderName h Pragma => Sing HeaderName h SProxyAuthenticate :: (~) HeaderName h ProxyAuthenticate => Sing HeaderName h SProxyAuthorization :: (~) HeaderName h ProxyAuthorization => Sing HeaderName h SPublicKeyPins :: (~) HeaderName h PublicKeyPins => Sing HeaderName h SRange :: (~) HeaderName h Range => Sing HeaderName h SReferer :: (~) HeaderName h Referer => Sing HeaderName h SRetryAfter :: (~) HeaderName h RetryAfter => Sing HeaderName h SSetCookie :: (~) HeaderName h SetCookie => Sing HeaderName h SStrictTransportSecurity :: (~) HeaderName h StrictTransportSecurity => Sing HeaderName h STE :: (~) HeaderName h TE => Sing HeaderName h STrailer :: (~) HeaderName h Trailer => Sing HeaderName h STransferEncoding :: (~) HeaderName h TransferEncoding => Sing HeaderName h SUpgrade :: (~) HeaderName h Upgrade => Sing HeaderName h SUserAgent :: (~) HeaderName h UserAgent => Sing HeaderName h SVary :: (~) HeaderName h Vary => Sing HeaderName h SVia :: (~) HeaderName h Via => Sing HeaderName h SWWWAuthenticate :: (~) HeaderName h WWWAuthenticate => Sing HeaderName h SWarning :: (~) HeaderName h Warning => Sing HeaderName h SXCsrfToken :: (~) HeaderName h XCsrfToken => Sing HeaderName h SXForwardedFor :: (~) HeaderName h XForwardedFor => Sing HeaderName h SXForwardedHost :: (~) HeaderName h XForwardedHost => Sing HeaderName h SXForwardedProto :: (~) HeaderName h XForwardedProto => Sing HeaderName h
data Sing Verb where SDELETE :: (~) Verb v DELETE => Sing Verb v SGET :: (~) Verb v GET => Sing Verb v SHEAD :: (~) Verb v HEAD => Sing Verb v SOPTIONS :: (~) Verb v OPTIONS => Sing Verb v SPATCH :: (~) Verb v PATCH => Sing Verb v SPOST :: (~) Verb v POST => Sing Verb v SPUT :: (~) Verb v PUT => Sing Verb v
data Sing Status where SCustomStatus :: (~) Status s (CustomStatus i) => Sing Nat i -> Sing Status s SContinue :: (~) Status s Continue => Sing Status s SSwitchingProtocols :: (~) Status s SwitchingProtocols => Sing Status s SOk :: (~) Status s Ok => Sing Status s SCreated :: (~) Status s Created => Sing Status s SAccepted :: (~) Status s Accepted => Sing Status s SNonAuthoritiveInformation :: (~) Status s NonAuthoritiveInformation => Sing Status s SNoContent :: (~) Status s NoContent => Sing Status s SResetContent :: (~) Status s ResetContent => Sing Status s SPartialContent :: (~) Status s PartialContent => Sing Status s SIMUsed :: (~) Status s IMUsed => Sing Status s SMultipleChoices :: (~) Status s MultipleChoices => Sing Status s SMovedPermanently :: (~) Status s MovedPermanently => Sing Status s SFound :: (~) Status s Found => Sing Status s SSeeOther :: (~) Status s SeeOther => Sing Status s SNotModified :: (~) Status s NotModified => Sing Status s STemporaryRedirect :: (~) Status s TemporaryRedirect => Sing Status s SPermanentRedirect :: (~) Status s PermanentRedirect => Sing Status s SBadRequest :: (~) Status s BadRequest => Sing Status s SUnauthorized :: (~) Status s Unauthorized => Sing Status s SPaymentRequired :: (~) Status s PaymentRequired => Sing Status s SForbidden :: (~) Status s Forbidden => Sing Status s SNotFound :: (~) Status s NotFound => Sing Status s SMethodNotAllowed :: (~) Status s MethodNotAllowed => Sing Status s SNotAcceptable :: (~) Status s NotAcceptable => Sing Status s SProxyAuthenticationRequired :: (~) Status s ProxyAuthenticationRequired => Sing Status s SRequestTimeout :: (~) Status s RequestTimeout => Sing Status s SConflict :: (~) Status s Conflict => Sing Status s SGone :: (~) Status s Gone => Sing Status s SLengthRequired :: (~) Status s LengthRequired => Sing Status s SPreconditionFailed :: (~) Status s PreconditionFailed => Sing Status s SPayloadTooLarge :: (~) Status s PayloadTooLarge => Sing Status s SRequestURITooLong :: (~) Status s RequestURITooLong => Sing Status s SUnsupportedMediaType :: (~) Status s UnsupportedMediaType => Sing Status s SRequestedRangeNotSatisfiable :: (~) Status s RequestedRangeNotSatisfiable => Sing Status s SExpectationFailed :: (~) Status s ExpectationFailed => Sing Status s SMisdirectedRequest :: (~) Status s MisdirectedRequest => Sing Status s SUnprocessableEntity :: (~) Status s UnprocessableEntity => Sing Status s SLocked :: (~) Status s Locked => Sing Status s SFailedDependency :: (~) Status s FailedDependency => Sing Status s SUpgradeRequired :: (~) Status s UpgradeRequired => Sing Status s SPreconditionRequired :: (~) Status s PreconditionRequired => Sing Status s STooManyRequests :: (~) Status s TooManyRequests => Sing Status s SRequestHeaderFieldsTooLarge :: (~) Status s RequestHeaderFieldsTooLarge => Sing Status s SUnavailableForLegalReasons :: (~) Status s UnavailableForLegalReasons => Sing Status s SInternalServerError :: (~) Status s InternalServerError => Sing Status s SNotImplemented :: (~) Status s NotImplemented => Sing Status s SBadGateway :: (~) Status s BadGateway => Sing Status s SServiceUnavailable :: (~) Status s ServiceUnavailable => Sing Status s SGatewayTimeout :: (~) Status s GatewayTimeout => Sing Status s SHTTPVersionNotSupported :: (~) Status s HTTPVersionNotSupported => Sing Status s SVariantAlsoNegotiates :: (~) Status s VariantAlsoNegotiates => Sing Status s SInsufficientStorage :: (~) Status s InsufficientStorage => Sing Status s SLoopDetected :: (~) Status s LoopDetected => Sing Status s SNotExtended :: (~) Status s NotExtended => Sing Status s SNetworkAuthenticationRequired :: (~) Status s NetworkAuthenticationRequired => Sing Status s
data Sing [a0] where SNil :: (~) [a0] z0 ([] a0) => Sing [a0] z0 SCons :: (~) [a0] z0 ((:) a0 n0 n1) => Sing a0 n0 -> Sing [a0] n1 -> Sing [a0] z0
data Sing (Maybe a0) where SNothing :: (~) (Maybe a0) z0 (Nothing a0) => Sing (Maybe a0) z0 SJust :: (~) (Maybe a0) z0 (Just a0 n0) => Sing a0 n0 -> Sing (Maybe a0) z0
data Sing (TyFun k1 k2 -> *) = SLambda { applySing :: forall t. Sing k1 t -> Sing k2 ((@@) k2 k1 f t) }
data Sing (Either a0 b0) where SLeft :: (~) (Either a0 b0) z0 (Left a0 b0 n0) => Sing a0 n0 -> Sing (Either a0 b0) z0 SRight :: (~) (Either a0 b0) z0 (Right a0 b0 n0) => Sing b0 n0 -> Sing (Either a0 b0) z0
data Sing ((,) a0 b0) where STuple2 :: (~) ((,) a0 b0) z0 ((,) a0 b0 n0 n1) => Sing a0 n0 -> Sing b0 n1 -> Sing ((,) a0 b0) z0
data Sing ((,,) a0 b0 c0) where STuple3 :: (~) ((,,) a0 b0 c0) z0 ((,,) a0 b0 c0 n0 n1 n2) => Sing a0 n0 -> Sing b0 n1 -> Sing c0 n2 -> Sing ((,,) a0 b0 c0) z0
data Sing ((,,,) a0 b0 c0 d0) where STuple4 :: (~) ((,,,) a0 b0 c0 d0) z0 ((,,,) a0 b0 c0 d0 n0 n1 n2 n3) => Sing a0 n0 -> Sing b0 n1 -> Sing c0 n2 -> Sing d0 n3 -> Sing ((,,,) a0 b0 c0 d0) z0
data Sing ((,,,,) a0 b0 c0 d0 e0) where STuple5 :: (~) ((,,,,) a0 b0 c0 d0 e0) z0 ((,,,,) a0 b0 c0 d0 e0 n0 n1 n2 n3 n4) => Sing a0 n0 -> Sing b0 n1 -> Sing c0 n2 -> Sing d0 n3 -> Sing e0 n4 -> Sing ((,,,,) a0 b0 c0 d0 e0) z0
data Sing ((,,,,,) a0 b0 c0 d0 e0 f0) where STuple6 :: (~) ((,,,,,) a0 b0 c0 d0 e0 f0) z0 ((,,,,,) a0 b0 c0 d0 e0 f0 n0 n1 n2 n3 n4 n5) => Sing a0 n0 -> Sing b0 n1 -> Sing c0 n2 -> Sing d0 n3 -> Sing e0 n4 -> Sing f0 n5 -> Sing ((,,,,,) a0 b0 c0 d0 e0 f0) z0
data Sing ((,,,,,,) a0 b0 c0 d0 e0 f0 g0) where STuple7 :: (~) ((,,,,,,) a0 b0 c0 d0 e0 f0 g0) z0 ((,,,,,,) a0 b0 c0 d0 e0 f0 g0 n0 n1 n2 n3 n4 n5 n6) => Sing a0 n0 -> Sing b0 n1 -> Sing c0 n2 -> Sing d0 n3 -> Sing e0 n4 -> Sing f0 n5 -> Sing g0 n6 -> Sing ((,,,,,,) a0 b0 c0 d0 e0 f0 g0) z0