{-# LANGUAGE CPP #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE PatternSynonyms #-}

-- | Types and constants to describe HTTP status codes.
--
-- At the bottom are some functions to check if a given t'Status' is from a certain category. (i.e. @1XX@, @2XX@, etc.)
module Network.HTTP.Types.Status (
    -- * HTTP Status
#if __GLASGOW_HASKELL__ >= 800
    Status (
        Status,
        Status100,
        Status101,
        Status200,
        Status201,
        Status202,
        Status203,
        Status204,
        Status205,
        Status206,
        Status300,
        Status301,
        Status302,
        Status303,
        Status304,
        Status305,
        Status307,
        Status308,
        Status400,
        Status401,
        Status402,
        Status403,
        Status404,
        Status405,
        Status407,
        Status408,
        Status409,
        Status410,
        Status411,
        Status412,
        Status413,
        Status414,
        Status415,
        Status416,
        Status417,
        Status418,
        Status422,
        Status426,
        Status428,
        Status429,
        Status431,
        Status451,
        Status500,
        Status501,
        Status502,
        Status503,
        Status504,
        Status505,
        Status511
    ),
#else
    Status(Status),
    pattern Status100,
    pattern Status101,
    pattern Status200,
    pattern Status201,
    pattern Status202,
    pattern Status203,
    pattern Status204,
    pattern Status205,
    pattern Status206,
    pattern Status300,
    pattern Status301,
    pattern Status302,
    pattern Status303,
    pattern Status304,
    pattern Status305,
    pattern Status307,
    pattern Status308,
    pattern Status400,
    pattern Status401,
    pattern Status402,
    pattern Status403,
    pattern Status404,
    pattern Status405,
    pattern Status407,
    pattern Status408,
    pattern Status409,
    pattern Status410,
    pattern Status411,
    pattern Status412,
    pattern Status413,
    pattern Status414,
    pattern Status415,
    pattern Status416,
    pattern Status417,
    pattern Status418,
    pattern Status422,
    pattern Status426,
    pattern Status428,
    pattern Status429,
    pattern Status431,
    pattern Status451,
    pattern Status500,
    pattern Status501,
    pattern Status502,
    pattern Status503,
    pattern Status504,
    pattern Status505,
    pattern Status511,
#endif
    statusCode,
    statusMessage,
    mkStatus,

    -- ** Parsing and Rendering

    -- | These functions are quicker and more efficient than doing it yourself.
    parseStatusCode,
    renderStatusCode,
    parseFullStatus,
    renderFullStatus,

    -- ** Low level functions
    renderStatusCodeToPtr,
    renderFullStatusToPtr,

    -- * Common statuses
    status100,
    continue100,
    status101,
    switchingProtocols101,
    status200,
    ok200,
    status201,
    created201,
    status202,
    accepted202,
    status203,
    nonAuthoritative203,
    status204,
    noContent204,
    status205,
    resetContent205,
    status206,
    partialContent206,
    status300,
    multipleChoices300,
    status301,
    movedPermanently301,
    status302,
    found302,
    status303,
    seeOther303,
    status304,
    notModified304,
    status305,
    useProxy305,
    status307,
    temporaryRedirect307,
    status308,
    permanentRedirect308,
    status400,
    badRequest400,
    status401,
    unauthorized401,
    status402,
    paymentRequired402,
    status403,
    forbidden403,
    status404,
    notFound404,
    status405,
    methodNotAllowed405,
    status406,
    notAcceptable406,
    status407,
    proxyAuthenticationRequired407,
    status408,
    requestTimeout408,
    status409,
    conflict409,
    status410,
    gone410,
    status411,
    lengthRequired411,
    status412,
    preconditionFailed412,
    status413,
    requestEntityTooLarge413,
    status414,
    requestURITooLong414,
    status415,
    unsupportedMediaType415,
    status416,
    requestedRangeNotSatisfiable416,
    status417,
    expectationFailed417,
    status418,
    imATeapot418,
    status422,
    unprocessableEntity422,
    status426,
    upgradeRequired426,
    status428,
    preconditionRequired428,
    status429,
    tooManyRequests429,
    status431,
    requestHeaderFieldsTooLarge431,
    status451,
    unavailableForLegalReasons451,
    status500,
    internalServerError500,
    status501,
    notImplemented501,
    status502,
    badGateway502,
    status503,
    serviceUnavailable503,
    status504,
    gatewayTimeout504,
    status505,
    httpVersionNotSupported505,
    status511,
    networkAuthenticationRequired511,

    -- * Checking status code category
    statusIsInformational,
    statusIsSuccessful,
    statusIsRedirection,
    statusIsClientError,
    statusIsServerError,
) where

import Control.Monad (guard)
import Data.Bits ((.&.), (.|.))
import Data.ByteString as B (ByteString, drop, empty, length, uncons)
import qualified Data.ByteString.Char8 as B8
import Data.ByteString.Internal as B (
    ByteString (..),
    accursedUnutterablePerformIO,
    unsafeCreate,
 )
import Data.Data (Data)
import Data.Function (on)
import Foreign (Ptr, Word8, copyBytes, peek, plusPtr, poke)
#if !MIN_VERSION_base(4,15,0)
import Foreign.ForeignPtr (ForeignPtr, withForeignPtr)
#else
import GHC.ForeignPtr (unsafeWithForeignPtr)
#endif
import GHC.Generics (Generic)

-- | HTTP Status.
--
-- Only the 'statusCode' is used for comparisons.
--
-- /Please use 'mkStatus' to create status codes from code and message, or the 'Enum' instance or the/
-- /status code constants (like 'ok200'). There might be additional record members in the future./
--
-- Note that the 'Show' instance is only for debugging.
data Status = Status
    { Status -> Int
statusCode :: Int
    -- ^ The 3-digit code of a t'Status'
    --
    -- For example: "200" in a @200 OK@ status
    , Status -> ByteString
statusMessage :: B.ByteString
    -- ^ The textual message of a t'Status'
    --
    -- For example: "Not Found" in a @404 Not Found@ status
    }
    deriving
        ( Int -> Status -> ShowS
[Status] -> ShowS
Status -> String
(Int -> Status -> ShowS)
-> (Status -> String) -> ([Status] -> ShowS) -> Show Status
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> Status -> ShowS
showsPrec :: Int -> Status -> ShowS
$cshow :: Status -> String
show :: Status -> String
$cshowList :: [Status] -> ShowS
showList :: [Status] -> ShowS
Show
        , -- | @since 0.12.4
          Typeable Status
Typeable Status =>
(forall (c :: * -> *).
 (forall d b. Data d => c (d -> b) -> d -> c b)
 -> (forall g. g -> c g) -> Status -> c Status)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c Status)
-> (Status -> Constr)
-> (Status -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c Status))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status))
-> ((forall b. Data b => b -> b) -> Status -> Status)
-> (forall r r'.
    (r -> r' -> r)
    -> r -> (forall d. Data d => d -> r') -> Status -> r)
-> (forall r r'.
    (r' -> r -> r)
    -> r -> (forall d. Data d => d -> r') -> Status -> r)
-> (forall u. (forall d. Data d => d -> u) -> Status -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> Status -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> Status -> m Status)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> Status -> m Status)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> Status -> m Status)
-> Data Status
Status -> Constr
Status -> DataType
(forall b. Data b => b -> b) -> Status -> Status
forall a.
Typeable a =>
(forall (c :: * -> *).
 (forall d b. Data d => c (d -> b) -> d -> c b)
 -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u. Int -> (forall d. Data d => d -> u) -> Status -> u
forall u. (forall d. Data d => d -> u) -> Status -> [u]
forall r r'.
(r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r
forall r r'.
(r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> Status -> m Status
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> Status -> m Status
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c Status
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> Status -> c Status
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c Status)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status)
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> Status -> c Status
gfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> Status -> c Status
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c Status
gunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c Status
$ctoConstr :: Status -> Constr
toConstr :: Status -> Constr
$cdataTypeOf :: Status -> DataType
dataTypeOf :: Status -> DataType
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c Status)
dataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c Status)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status)
dataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status)
$cgmapT :: (forall b. Data b => b -> b) -> Status -> Status
gmapT :: (forall b. Data b => b -> b) -> Status -> Status
$cgmapQl :: forall r r'.
(r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r
gmapQl :: forall r r'.
(r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r
$cgmapQr :: forall r r'.
(r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r
gmapQr :: forall r r'.
(r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> Status -> [u]
gmapQ :: forall u. (forall d. Data d => d -> u) -> Status -> [u]
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> Status -> u
gmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> Status -> u
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> Status -> m Status
gmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> Status -> m Status
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> Status -> m Status
gmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> Status -> m Status
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> Status -> m Status
gmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> Status -> m Status
Data
        , -- | @since 0.12.4
          (forall x. Status -> Rep Status x)
-> (forall x. Rep Status x -> Status) -> Generic Status
forall x. Rep Status x -> Status
forall x. Status -> Rep Status x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. Status -> Rep Status x
from :: forall x. Status -> Rep Status x
$cto :: forall x. Rep Status x -> Status
to :: forall x. Rep Status x -> Status
Generic
        )

-- | A t'Status' is equal to another t'Status' if the status codes are equal.
instance Eq Status where
    == :: Status -> Status -> Bool
(==) = Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
(==) (Int -> Int -> Bool) -> (Status -> Int) -> Status -> Status -> Bool
forall b c a. (b -> b -> c) -> (a -> b) -> a -> a -> c
`on` Status -> Int
statusCode

-- | t'Status'es are ordered according to their status codes only.
instance Ord Status where
    compare :: Status -> Status -> Ordering
compare = Int -> Int -> Ordering
forall a. Ord a => a -> a -> Ordering
compare (Int -> Int -> Ordering)
-> (Status -> Int) -> Status -> Status -> Ordering
forall b c a. (b -> b -> c) -> (a -> b) -> a -> a -> c
`on` Status -> Int
statusCode

-- | Be advised, that when using the @enumFrom*@ family of methods or
-- ranges in lists, it will generate all possible status codes.
--
-- E.g. @[status100 .. status200]@ generates t'Status'es of @100, 101, 102 .. 198, 199, 200@
--
-- The statuses not included in this library will have an empty message.
--
-- @since 0.7.3
instance Enum Status where
    fromEnum :: Status -> Int
fromEnum = Status -> Int
statusCode
    toEnum :: Int -> Status
toEnum Int
100 = Status
status100
    toEnum Int
101 = Status
status101
    toEnum Int
200 = Status
status200
    toEnum Int
201 = Status
status201
    toEnum Int
202 = Status
status202
    toEnum Int
203 = Status
status203
    toEnum Int
204 = Status
status204
    toEnum Int
205 = Status
status205
    toEnum Int
206 = Status
status206
    toEnum Int
300 = Status
status300
    toEnum Int
301 = Status
status301
    toEnum Int
302 = Status
status302
    toEnum Int
303 = Status
status303
    toEnum Int
304 = Status
status304
    toEnum Int
305 = Status
status305
    toEnum Int
307 = Status
status307
    toEnum Int
308 = Status
status308
    toEnum Int
400 = Status
status400
    toEnum Int
401 = Status
status401
    toEnum Int
402 = Status
status402
    toEnum Int
403 = Status
status403
    toEnum Int
404 = Status
status404
    toEnum Int
405 = Status
status405
    toEnum Int
406 = Status
status406
    toEnum Int
407 = Status
status407
    toEnum Int
408 = Status
status408
    toEnum Int
409 = Status
status409
    toEnum Int
410 = Status
status410
    toEnum Int
411 = Status
status411
    toEnum Int
412 = Status
status412
    toEnum Int
413 = Status
status413
    toEnum Int
414 = Status
status414
    toEnum Int
415 = Status
status415
    toEnum Int
416 = Status
status416
    toEnum Int
417 = Status
status417
    toEnum Int
418 = Status
status418
    toEnum Int
422 = Status
status422
    toEnum Int
426 = Status
status426
    toEnum Int
428 = Status
status428
    toEnum Int
429 = Status
status429
    toEnum Int
431 = Status
status431
    toEnum Int
451 = Status
status451
    toEnum Int
500 = Status
status500
    toEnum Int
501 = Status
status501
    toEnum Int
502 = Status
status502
    toEnum Int
503 = Status
status503
    toEnum Int
504 = Status
status504
    toEnum Int
505 = Status
status505
    toEnum Int
511 = Status
status511
    toEnum Int
c = Int -> ByteString -> Status
mkStatus Int
c ByteString
B.empty

-- | @since 0.11
instance Bounded Status where
    minBound :: Status
minBound = Status
status100
    maxBound :: Status
maxBound = Status
status511

-- | Create a t'Status' from a status code and message.
--
-- @since 0.7.3
mkStatus :: Int -> B.ByteString -> Status
mkStatus :: Int -> ByteString -> Status
mkStatus = Int -> ByteString -> Status
Status

-- | Continue 100
--
-- @since 0.6.6
status100 :: Status
status100 :: Status
status100 = Int -> ByteString -> Status
mkStatus Int
100 ByteString
"Continue"

-- | Continue 100
--
-- @since 0.6.6
continue100 :: Status
continue100 :: Status
continue100 = Status
status100

-- | Switching Protocols 101
--
-- @since 0.6.6
status101 :: Status
status101 :: Status
status101 = Int -> ByteString -> Status
mkStatus Int
101 ByteString
"Switching Protocols"

-- | Switching Protocols 101
--
-- @since 0.6.6
switchingProtocols101 :: Status
switchingProtocols101 :: Status
switchingProtocols101 = Status
status101

-- | @since 0.13.0
pattern Status100 :: Status
pattern $mStatus100 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status100 <- Status 100 _

-- | @since 0.13.0
pattern Status101 :: Status
pattern $mStatus101 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status101 <- Status 101 _

-- | OK 200
status200 :: Status
status200 :: Status
status200 = Int -> ByteString -> Status
mkStatus Int
200 ByteString
"OK"

-- | OK 200
ok200 :: Status
ok200 :: Status
ok200 = Status
status200

-- | Created 201
status201 :: Status
status201 :: Status
status201 = Int -> ByteString -> Status
mkStatus Int
201 ByteString
"Created"

-- | Created 201
created201 :: Status
created201 :: Status
created201 = Status
status201

-- | Accepted 202
--
-- @since 0.6.6
status202 :: Status
status202 :: Status
status202 = Int -> ByteString -> Status
mkStatus Int
202 ByteString
"Accepted"

-- | Accepted 202
--
-- @since 0.6.6
accepted202 :: Status
accepted202 :: Status
accepted202 = Status
status202

-- | Non-Authoritative Information 203
--
-- @since 0.6.6
status203 :: Status
status203 :: Status
status203 = Int -> ByteString -> Status
mkStatus Int
203 ByteString
"Non-Authoritative Information"

-- | Non-Authoritative Information 203
--
-- @since 0.6.6
nonAuthoritative203 :: Status
nonAuthoritative203 :: Status
nonAuthoritative203 = Status
status203

-- | No Content 204
--
-- @since 0.6.6
status204 :: Status
status204 :: Status
status204 = Int -> ByteString -> Status
mkStatus Int
204 ByteString
"No Content"

-- | No Content 204
--
-- @since 0.6.6
noContent204 :: Status
noContent204 :: Status
noContent204 = Status
status204

-- | Reset Content 205
--
-- @since 0.6.6
status205 :: Status
status205 :: Status
status205 = Int -> ByteString -> Status
mkStatus Int
205 ByteString
"Reset Content"

-- | Reset Content 205
--
-- @since 0.6.6
resetContent205 :: Status
resetContent205 :: Status
resetContent205 = Status
status205

-- | Partial Content 206
--
-- @since 0.5.1
status206 :: Status
status206 :: Status
status206 = Int -> ByteString -> Status
mkStatus Int
206 ByteString
"Partial Content"

-- | Partial Content 206
--
-- @since 0.5.1
partialContent206 :: Status
partialContent206 :: Status
partialContent206 = Status
status206

-- | @since 0.13.0
pattern Status200 :: Status
pattern $mStatus200 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status200 <- Status 200 _

-- | @since 0.13.0
pattern Status201 :: Status
pattern $mStatus201 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status201 <- Status 201 _

-- | @since 0.13.0
pattern Status202 :: Status
pattern $mStatus202 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status202 <- Status 202 _

-- | @since 0.13.0
pattern Status203 :: Status
pattern $mStatus203 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status203 <- Status 203 _

-- | @since 0.13.0
pattern Status204 :: Status
pattern $mStatus204 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status204 <- Status 204 _

-- | @since 0.13.0
pattern Status205 :: Status
pattern $mStatus205 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status205 <- Status 205 _

-- | @since 0.13.0
pattern Status206 :: Status
pattern $mStatus206 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status206 <- Status 206 _

-- | Multiple Choices 300
status300 :: Status
status300 :: Status
status300 = Int -> ByteString -> Status
mkStatus Int
300 ByteString
"Multiple Choices"

-- | Multiple Choices 300
multipleChoices300 :: Status
multipleChoices300 :: Status
multipleChoices300 = Status
status300

-- | Moved Permanently 301
status301 :: Status
status301 :: Status
status301 = Int -> ByteString -> Status
mkStatus Int
301 ByteString
"Moved Permanently"

-- | Moved Permanently 301
movedPermanently301 :: Status
movedPermanently301 :: Status
movedPermanently301 = Status
status301

-- | Found 302
status302 :: Status
status302 :: Status
status302 = Int -> ByteString -> Status
mkStatus Int
302 ByteString
"Found"

-- | Found 302
found302 :: Status
found302 :: Status
found302 = Status
status302

-- | See Other 303
status303 :: Status
status303 :: Status
status303 = Int -> ByteString -> Status
mkStatus Int
303 ByteString
"See Other"

-- | See Other 303
seeOther303 :: Status
seeOther303 :: Status
seeOther303 = Status
status303

-- | Not Modified 304
--
-- @since 0.6.1
status304 :: Status
status304 :: Status
status304 = Int -> ByteString -> Status
mkStatus Int
304 ByteString
"Not Modified"

-- | Not Modified 304
--
-- @since 0.6.1
notModified304 :: Status
notModified304 :: Status
notModified304 = Status
status304

-- | Use Proxy 305
--
-- @since 0.6.6
status305 :: Status
status305 :: Status
status305 = Int -> ByteString -> Status
mkStatus Int
305 ByteString
"Use Proxy"

-- | Use Proxy 305
--
-- @since 0.6.6
useProxy305 :: Status
useProxy305 :: Status
useProxy305 = Status
status305

-- | Temporary Redirect 307
--
-- @since 0.6.6
status307 :: Status
status307 :: Status
status307 = Int -> ByteString -> Status
mkStatus Int
307 ByteString
"Temporary Redirect"

-- | Temporary Redirect 307
--
-- @since 0.6.6
temporaryRedirect307 :: Status
temporaryRedirect307 :: Status
temporaryRedirect307 = Status
status307

-- | Permanent Redirect 308
--
-- @since 0.9
status308 :: Status
status308 :: Status
status308 = Int -> ByteString -> Status
mkStatus Int
308 ByteString
"Permanent Redirect"

-- | Permanent Redirect 308
--
-- @since 0.9
permanentRedirect308 :: Status
permanentRedirect308 :: Status
permanentRedirect308 = Status
status308


-- | @since 0.13.0
pattern Status300 :: Status
pattern $mStatus300 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status300 <- Status 300 _

-- | @since 0.13.0
pattern Status301 :: Status
pattern $mStatus301 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status301 <- Status 301 _

-- | @since 0.13.0
pattern Status302 :: Status
pattern $mStatus302 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status302 <- Status 302 _

-- | @since 0.13.0
pattern Status303 :: Status
pattern $mStatus303 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status303 <- Status 303 _

-- | @since 0.13.0
pattern Status304 :: Status
pattern $mStatus304 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status304 <- Status 304 _

-- | @since 0.13.0
pattern Status305 :: Status
pattern $mStatus305 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status305 <- Status 305 _

-- | @since 0.13.0
pattern Status307 :: Status
pattern $mStatus307 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status307 <- Status 307 _

-- | @since 0.13.0
pattern Status308 :: Status
pattern $mStatus308 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status308 <- Status 308 _

-- | Bad Request 400
status400 :: Status
status400 :: Status
status400 = Int -> ByteString -> Status
mkStatus Int
400 ByteString
"Bad Request"

-- | Bad Request 400
badRequest400 :: Status
badRequest400 :: Status
badRequest400 = Status
status400

-- | Unauthorized 401
status401 :: Status
status401 :: Status
status401 = Int -> ByteString -> Status
mkStatus Int
401 ByteString
"Unauthorized"

-- | Unauthorized 401
unauthorized401 :: Status
unauthorized401 :: Status
unauthorized401 = Status
status401

-- | Payment Required 402
--
-- @since 0.6.6
status402 :: Status
status402 :: Status
status402 = Int -> ByteString -> Status
mkStatus Int
402 ByteString
"Payment Required"

-- | Payment Required 402
--
-- @since 0.6.6
paymentRequired402 :: Status
paymentRequired402 :: Status
paymentRequired402 = Status
status402

-- | Forbidden 403
status403 :: Status
status403 :: Status
status403 = Int -> ByteString -> Status
mkStatus Int
403 ByteString
"Forbidden"

-- | Forbidden 403
forbidden403 :: Status
forbidden403 :: Status
forbidden403 = Status
status403

-- | Not Found 404
status404 :: Status
status404 :: Status
status404 = Int -> ByteString -> Status
mkStatus Int
404 ByteString
"Not Found"

-- | Not Found 404
notFound404 :: Status
notFound404 :: Status
notFound404 = Status
status404

-- | Method Not Allowed 405
status405 :: Status
status405 :: Status
status405 = Int -> ByteString -> Status
mkStatus Int
405 ByteString
"Method Not Allowed"

-- | Method Not Allowed 405
methodNotAllowed405 :: Status
methodNotAllowed405 :: Status
methodNotAllowed405 = Status
status405

-- | Not Acceptable 406
--
-- @since 0.6.6
status406 :: Status
status406 :: Status
status406 = Int -> ByteString -> Status
mkStatus Int
406 ByteString
"Not Acceptable"

-- | Not Acceptable 406
--
-- @since 0.6.6
notAcceptable406 :: Status
notAcceptable406 :: Status
notAcceptable406 = Status
status406

-- | Proxy Authentication Required 407
--
-- @since 0.6.6
status407 :: Status
status407 :: Status
status407 = Int -> ByteString -> Status
mkStatus Int
407 ByteString
"Proxy Authentication Required"

-- | Proxy Authentication Required 407
--
-- @since 0.6.6
proxyAuthenticationRequired407 :: Status
proxyAuthenticationRequired407 :: Status
proxyAuthenticationRequired407 = Status
status407

-- | Request Timeout 408
--
-- @since 0.6.6
status408 :: Status
status408 :: Status
status408 = Int -> ByteString -> Status
mkStatus Int
408 ByteString
"Request Timeout"

-- | Request Timeout 408
--
-- @since 0.6.6
requestTimeout408 :: Status
requestTimeout408 :: Status
requestTimeout408 = Status
status408

-- | Conflict 409
--
-- @since 0.6.6
status409 :: Status
status409 :: Status
status409 = Int -> ByteString -> Status
mkStatus Int
409 ByteString
"Conflict"

-- | Conflict 409
--
-- @since 0.6.6
conflict409 :: Status
conflict409 :: Status
conflict409 = Status
status409

-- | Gone 410
--
-- @since 0.6.6
status410 :: Status
status410 :: Status
status410 = Int -> ByteString -> Status
mkStatus Int
410 ByteString
"Gone"

-- | Gone 410
--
-- @since 0.6.6
gone410 :: Status
gone410 :: Status
gone410 = Status
status410

-- | Length Required 411
--
-- @since 0.6.6
status411 :: Status
status411 :: Status
status411 = Int -> ByteString -> Status
mkStatus Int
411 ByteString
"Length Required"

-- | Length Required 411
--
-- @since 0.6.6
lengthRequired411 :: Status
lengthRequired411 :: Status
lengthRequired411 = Status
status411

-- | Precondition Failed 412
--
-- @since 0.6.1
status412 :: Status
status412 :: Status
status412 = Int -> ByteString -> Status
mkStatus Int
412 ByteString
"Precondition Failed"

-- | Precondition Failed 412
--
-- @since 0.6.1
preconditionFailed412 :: Status
preconditionFailed412 :: Status
preconditionFailed412 = Status
status412

-- | Request Entity Too Large 413
--
-- @since 0.6.6
status413 :: Status
status413 :: Status
status413 = Int -> ByteString -> Status
mkStatus Int
413 ByteString
"Request Entity Too Large"

-- | Request Entity Too Large 413
--
-- @since 0.6.6
requestEntityTooLarge413 :: Status
requestEntityTooLarge413 :: Status
requestEntityTooLarge413 = Status
status413

-- | Request-URI Too Long 414
--
-- @since 0.6.6
status414 :: Status
status414 :: Status
status414 = Int -> ByteString -> Status
mkStatus Int
414 ByteString
"Request-URI Too Long"

-- | Request-URI Too Long 414
--
-- @since 0.6.6
requestURITooLong414 :: Status
requestURITooLong414 :: Status
requestURITooLong414 = Status
status414

-- | Unsupported Media Type 415
--
-- @since 0.6.6
status415 :: Status
status415 :: Status
status415 = Int -> ByteString -> Status
mkStatus Int
415 ByteString
"Unsupported Media Type"

-- | Unsupported Media Type 415
--
-- @since 0.6.6
unsupportedMediaType415 :: Status
unsupportedMediaType415 :: Status
unsupportedMediaType415 = Status
status415

-- | Requested Range Not Satisfiable 416
--
-- @since 0.6.1
status416 :: Status
status416 :: Status
status416 = Int -> ByteString -> Status
mkStatus Int
416 ByteString
"Requested Range Not Satisfiable"

-- | Requested Range Not Satisfiable 416
--
-- @since 0.6.1
requestedRangeNotSatisfiable416 :: Status
requestedRangeNotSatisfiable416 :: Status
requestedRangeNotSatisfiable416 = Status
status416

-- | Expectation Failed 417
--
-- @since 0.6.6
status417 :: Status
status417 :: Status
status417 = Int -> ByteString -> Status
mkStatus Int
417 ByteString
"Expectation Failed"

-- | Expectation Failed 417
--
-- @since 0.6.6
expectationFailed417 :: Status
expectationFailed417 :: Status
expectationFailed417 = Status
status417

-- FIXME: RFC 7168 updates the message to "I'm a Teapot" (capital T)
-- Should we update this?

-- | I'm a teapot 418
--
-- @since 0.6.6
status418 :: Status
status418 :: Status
status418 = Int -> ByteString -> Status
mkStatus Int
418 ByteString
"I'm a teapot"

-- | I'm a teapot 418
--
-- @since 0.6.6
imATeapot418 :: Status
imATeapot418 :: Status
imATeapot418 = Status
status418

-- | Unprocessable Entity 422
-- (<https://tools.ietf.org/html/rfc4918 RFC 4918>)
--
-- @since 0.9.1
status422 :: Status
status422 :: Status
status422 = Int -> ByteString -> Status
mkStatus Int
422 ByteString
"Unprocessable Entity"

-- | Unprocessable Entity 422
-- (<https://tools.ietf.org/html/rfc4918 RFC 4918>)
--
-- @since 0.9.1
unprocessableEntity422 :: Status
unprocessableEntity422 :: Status
unprocessableEntity422 = Status
status422

-- | Upgrade Required 426
-- (<https://tools.ietf.org/html/rfc7231#section-6.5.15 RFC 7231>)
--
-- @since 0.10
status426 :: Status
status426 :: Status
status426 = Int -> ByteString -> Status
mkStatus Int
426 ByteString
"Upgrade Required"

-- | Upgrade Required 426
-- (<https://tools.ietf.org/html/rfc7231#section-6.5.15 RFC 7231>)
--
-- @since 0.10
upgradeRequired426 :: Status
upgradeRequired426 :: Status
upgradeRequired426 = Status
status426

-- | Precondition Required 428
-- (<https://tools.ietf.org/html/rfc6585#section-3 RFC 6585>)
--
-- @since 0.8.5
status428 :: Status
status428 :: Status
status428 = Int -> ByteString -> Status
mkStatus Int
428 ByteString
"Precondition Required"

-- | Precondition Required 428
-- (<https://tools.ietf.org/html/rfc6585#section-3 RFC 6585>)
--
-- @since 0.8.5
preconditionRequired428 :: Status
preconditionRequired428 :: Status
preconditionRequired428 = Status
status428

-- | Too Many Requests 429
-- (<https://tools.ietf.org/html/rfc6585#section-4 RFC 6585>)
--
-- @since 0.8.5
status429 :: Status
status429 :: Status
status429 = Int -> ByteString -> Status
mkStatus Int
429 ByteString
"Too Many Requests"

-- | Too Many Requests 429
-- (<https://tools.ietf.org/html/rfc6585#section-4 RFC 6585>)
--
-- @since 0.8.5
tooManyRequests429 :: Status
tooManyRequests429 :: Status
tooManyRequests429 = Status
status429

-- | Request Header Fields Too Large 431
-- (<https://tools.ietf.org/html/rfc6585#section-5 RFC 6585>)
--
-- @since 0.8.5
status431 :: Status
status431 :: Status
status431 = Int -> ByteString -> Status
mkStatus Int
431 ByteString
"Request Header Fields Too Large"

-- | Request Header Fields Too Large 431
-- (<https://tools.ietf.org/html/rfc6585#section-5 RFC 6585>)
--
-- @since 0.8.5
requestHeaderFieldsTooLarge431 :: Status
requestHeaderFieldsTooLarge431 :: Status
requestHeaderFieldsTooLarge431 = Status
status431

-- | Unavailable For Legal Reasons 451
-- (<https://tools.ietf.org/html/rfc7725 RFC 7725>)
--
-- @since 0.12.5
status451 :: Status
status451 :: Status
status451 = Int -> ByteString -> Status
mkStatus Int
451 ByteString
"Unavailable For Legal Reasons"

-- | Unavailable For Legal Reasons 451
-- (<https://tools.ietf.org/html/rfc7725 RFC 7725>)
--
-- @since 0.12.5
unavailableForLegalReasons451 :: Status
unavailableForLegalReasons451 :: Status
unavailableForLegalReasons451 = Status
status451

-- | @since 0.13.0
pattern Status400 :: Status
pattern $mStatus400 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status400 <- Status 400 _

-- | @since 0.13.0
pattern Status401 :: Status
pattern $mStatus401 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status401 <- Status 401 _

-- | @since 0.13.0
pattern Status402 :: Status
pattern $mStatus402 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status402 <- Status 402 _

-- | @since 0.13.0
pattern Status403 :: Status
pattern $mStatus403 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status403 <- Status 403 _

-- | @since 0.13.0
pattern Status404 :: Status
pattern $mStatus404 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status404 <- Status 404 _

-- | @since 0.13.0
pattern Status405 :: Status
pattern $mStatus405 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status405 <- Status 405 _

-- | @since 0.13.0
pattern Status407 :: Status
pattern $mStatus407 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status407 <- Status 407 _

-- | @since 0.13.0
pattern Status408 :: Status
pattern $mStatus408 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status408 <- Status 408 _

-- | @since 0.13.0
pattern Status409 :: Status
pattern $mStatus409 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status409 <- Status 409 _

-- | @since 0.13.0
pattern Status410 :: Status
pattern $mStatus410 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status410 <- Status 410 _

-- | @since 0.13.0
pattern Status411 :: Status
pattern $mStatus411 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status411 <- Status 411 _

-- | @since 0.13.0
pattern Status412 :: Status
pattern $mStatus412 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status412 <- Status 412 _

-- | @since 0.13.0
pattern Status413 :: Status
pattern $mStatus413 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status413 <- Status 413 _

-- | @since 0.13.0
pattern Status414 :: Status
pattern $mStatus414 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status414 <- Status 414 _

-- | @since 0.13.0
pattern Status415 :: Status
pattern $mStatus415 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status415 <- Status 415 _

-- | @since 0.13.0
pattern Status416 :: Status
pattern $mStatus416 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status416 <- Status 416 _

-- | @since 0.13.0
pattern Status417 :: Status
pattern $mStatus417 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status417 <- Status 417 _

-- | @since 0.13.0
pattern Status418 :: Status
pattern $mStatus418 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status418 <- Status 418 _

-- | @since 0.13.0
pattern Status422 :: Status
pattern $mStatus422 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status422 <- Status 422 _

-- | @since 0.13.0
pattern Status426 :: Status
pattern $mStatus426 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status426 <- Status 426 _

-- | @since 0.13.0
pattern Status428 :: Status
pattern $mStatus428 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status428 <- Status 428 _

-- | @since 0.13.0
pattern Status429 :: Status
pattern $mStatus429 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status429 <- Status 429 _

-- | @since 0.13.0
pattern Status431 :: Status
pattern $mStatus431 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status431 <- Status 431 _

-- | @since 0.13.0
pattern Status451 :: Status
pattern $mStatus451 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status451 <- Status 451 _

-- | Internal Server Error 500
status500 :: Status
status500 :: Status
status500 = Int -> ByteString -> Status
mkStatus Int
500 ByteString
"Internal Server Error"

-- | Internal Server Error 500
internalServerError500 :: Status
internalServerError500 :: Status
internalServerError500 = Status
status500

-- | Not Implemented 501
--
-- @since 0.6.1
status501 :: Status
status501 :: Status
status501 = Int -> ByteString -> Status
mkStatus Int
501 ByteString
"Not Implemented"

-- | Not Implemented 501
--
-- @since 0.6.1
notImplemented501 :: Status
notImplemented501 :: Status
notImplemented501 = Status
status501

-- | Bad Gateway 502
--
-- @since 0.6.6
status502 :: Status
status502 :: Status
status502 = Int -> ByteString -> Status
mkStatus Int
502 ByteString
"Bad Gateway"

-- | Bad Gateway 502
--
-- @since 0.6.6
badGateway502 :: Status
badGateway502 :: Status
badGateway502 = Status
status502

-- | Service Unavailable 503
--
-- @since 0.6.6
status503 :: Status
status503 :: Status
status503 = Int -> ByteString -> Status
mkStatus Int
503 ByteString
"Service Unavailable"

-- | Service Unavailable 503
--
-- @since 0.6.6
serviceUnavailable503 :: Status
serviceUnavailable503 :: Status
serviceUnavailable503 = Status
status503

-- | Gateway Timeout 504
--
-- @since 0.6.6
status504 :: Status
status504 :: Status
status504 = Int -> ByteString -> Status
mkStatus Int
504 ByteString
"Gateway Timeout"

-- | Gateway Timeout 504
--
-- @since 0.6.6
gatewayTimeout504 :: Status
gatewayTimeout504 :: Status
gatewayTimeout504 = Status
status504

-- | HTTP Version Not Supported 505
--
-- @since 0.6.6
status505 :: Status
status505 :: Status
status505 = Int -> ByteString -> Status
mkStatus Int
505 ByteString
"HTTP Version Not Supported"

-- | HTTP Version Not Supported 505
--
-- @since 0.6.6
httpVersionNotSupported505 :: Status
httpVersionNotSupported505 :: Status
httpVersionNotSupported505 = Status
status505

-- | Network Authentication Required 511
-- (<https://tools.ietf.org/html/rfc6585#section-6 RFC 6585>)
--
-- @since 0.8.5
status511 :: Status
status511 :: Status
status511 = Int -> ByteString -> Status
mkStatus Int
511 ByteString
"Network Authentication Required"

-- | Network Authentication Required 511
-- (<https://tools.ietf.org/html/rfc6585#section-6 RFC 6585>)
--
-- @since 0.8.5
networkAuthenticationRequired511 :: Status
networkAuthenticationRequired511 :: Status
networkAuthenticationRequired511 = Status
status511

-- | @since 0.13.0
pattern Status500 :: Status
pattern $mStatus500 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status500 <- Status 500 _

-- | @since 0.13.0
pattern Status501 :: Status
pattern $mStatus501 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status501 <- Status 501 _

-- | @since 0.13.0
pattern Status502 :: Status
pattern $mStatus502 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status502 <- Status 502 _

-- | @since 0.13.0
pattern Status503 :: Status
pattern $mStatus503 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status503 <- Status 503 _

-- | @since 0.13.0
pattern Status504 :: Status
pattern $mStatus504 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status504 <- Status 504 _

-- | @since 0.13.0
pattern Status505 :: Status
pattern $mStatus505 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status505 <- Status 505 _

-- | @since 0.13.0
pattern Status511 :: Status
pattern $mStatus511 :: forall {r}. Status -> ((# #) -> r) -> ((# #) -> r) -> r
Status511 <- Status 511 _

-- | Informational class
--
-- Checks if the status is in the 1XX range.
--
-- @since 0.8.0
statusIsInformational :: Status -> Bool
statusIsInformational :: Status -> Bool
statusIsInformational (Status{statusCode :: Status -> Int
statusCode = Int
code}) = Int
code Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
>= Int
100 Bool -> Bool -> Bool
&& Int
code Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
< Int
200

-- | Successful class
--
-- Checks if the status is in the 2XX range.
--
-- @since 0.8.0
statusIsSuccessful :: Status -> Bool
statusIsSuccessful :: Status -> Bool
statusIsSuccessful (Status{statusCode :: Status -> Int
statusCode = Int
code}) = Int
code Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
>= Int
200 Bool -> Bool -> Bool
&& Int
code Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
< Int
300

-- | Redirection class
--
-- Checks if the status is in the 3XX range.
--
-- @since 0.8.0
statusIsRedirection :: Status -> Bool
statusIsRedirection :: Status -> Bool
statusIsRedirection (Status{statusCode :: Status -> Int
statusCode = Int
code}) = Int
code Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
>= Int
300 Bool -> Bool -> Bool
&& Int
code Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
< Int
400

-- | Client Error class
--
-- Checks if the status is in the 4XX range.
--
-- @since 0.8.0
statusIsClientError :: Status -> Bool
statusIsClientError :: Status -> Bool
statusIsClientError (Status{statusCode :: Status -> Int
statusCode = Int
code}) = Int
code Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
>= Int
400 Bool -> Bool -> Bool
&& Int
code Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
< Int
500

-- | Server Error class
--
-- Checks if the status is in the 5XX range.
--
-- @since 0.8.0
statusIsServerError :: Status -> Bool
statusIsServerError :: Status -> Bool
statusIsServerError (Status{statusCode :: Status -> Int
statusCode = Int
code}) = Int
code Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
>= Int
500 Bool -> Bool -> Bool
&& Int
code Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
< Int
600

-- | Write the 3 digit t'Status' code to the provided 'Ptr'.
--
-- /N.B. This function assumes @statusCode < 1000@!/
-- /If it is @>= 1000@, the first byte will not be a digit./
--
-- @since 0.13.0
renderStatusCodeToPtr :: Status -> Ptr Word8 -> IO ()
renderStatusCodeToPtr :: Status -> Ptr Word8 -> IO ()
renderStatusCodeToPtr (Status Int
code ByteString
_) Ptr Word8
ptr = do
    Ptr Word8 -> Word8 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke Ptr Word8
ptr (Word8 -> IO ()) -> Word8 -> IO ()
forall a b. (a -> b) -> a -> b
$ Int -> Word8
toByte Int
h
    Ptr Word8 -> Word8 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (Ptr Word8
ptr Ptr Word8 -> Int -> Ptr Word8
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
1) (Word8 -> IO ()) -> Word8 -> IO ()
forall a b. (a -> b) -> a -> b
$ Int -> Word8
toByte Int
t
    Ptr Word8 -> Word8 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (Ptr Word8
ptr Ptr Word8 -> Int -> Ptr Word8
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
2) (Word8 -> IO ()) -> Word8 -> IO ()
forall a b. (a -> b) -> a -> b
$ Int -> Word8
toByte Int
i
  where
    (Int
h, Int
rest) = Int
code Int -> Int -> (Int, Int)
forall a. Integral a => a -> a -> (a, a)
`divMod` Int
100
    (Int
t, Int
i) = Int
rest Int -> Int -> (Int, Int)
forall a. Integral a => a -> a -> (a, a)
`divMod` Int
10
    toByte :: Int -> Word8
    toByte :: Int -> Word8
toByte Int
x = Int -> Word8
forall a b. (Integral a, Num b) => a -> b
fromIntegral Int
x Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.|. Word8
0x30

-- | Render the 3 digit t'Status' code into a 'ByteString'.
--
-- @since 0.13.0
renderStatusCode :: Status -> ByteString
renderStatusCode :: Status -> ByteString
renderStatusCode s :: Status
s@(Status Int
code ByteString
_)
    | Int
code Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
>= Int
1000 = String -> ByteString
B8.pack (String -> ByteString) -> String -> ByteString
forall a b. (a -> b) -> a -> b
$ Status -> String
forall a. Show a => a -> String
show Status
s
    | Bool
otherwise =
        Int -> (Ptr Word8 -> IO ()) -> ByteString
unsafeCreate Int
3 ((Ptr Word8 -> IO ()) -> ByteString)
-> (Ptr Word8 -> IO ()) -> ByteString
forall a b. (a -> b) -> a -> b
$ Status -> Ptr Word8 -> IO ()
renderStatusCodeToPtr Status
s

-- | Writes the full t'Status' code to the provided 'Ptr'.
--
-- /N.B. Same caveat from 'renderStatusCodeToPtr' applies./
--
-- @since 0.13.0
renderFullStatusToPtr :: Status -> Ptr Word8 -> IO ()
renderFullStatusToPtr :: Status -> Ptr Word8 -> IO ()
renderFullStatusToPtr s :: Status
s@(Status Int
_ (PS ForeignPtr Word8
fptr Int
offset Int
len)) Ptr Word8
ptr = do
    Status -> Ptr Word8 -> IO ()
renderStatusCodeToPtr Status
s Ptr Word8
ptr
    Ptr Word8 -> Word8 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (Ptr Word8
ptr Ptr Word8 -> Int -> Ptr Word8
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
3) (Word8
0x20 :: Word8)
    ForeignPtr Word8 -> (Ptr Word8 -> IO ()) -> IO ()
forall a b. ForeignPtr a -> (Ptr a -> IO b) -> IO b
unsafeWithForeignPtr ForeignPtr Word8
fptr ((Ptr Word8 -> IO ()) -> IO ()) -> (Ptr Word8 -> IO ()) -> IO ()
forall a b. (a -> b) -> a -> b
$ \Ptr Word8
src ->
        Ptr (ZonkAny 2) -> Ptr (ZonkAny 2) -> Int -> IO ()
forall a. Ptr a -> Ptr a -> Int -> IO ()
copyBytes (Ptr Word8
ptr Ptr Word8 -> Int -> Ptr (ZonkAny 2)
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
4) (Ptr Word8
src Ptr Word8 -> Int -> Ptr (ZonkAny 2)
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
offset) Int
len

-- | Render the full t'Status' code with status message into a 'ByteString'.
--
-- @since 0.13.0
renderFullStatus :: Status -> ByteString
renderFullStatus :: Status -> ByteString
renderFullStatus s :: Status
s@(Status Int
code ByteString
msg)
    | Int
code Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
>= Int
1000 =
        String -> ByteString
B8.pack (Int -> String
forall a. Show a => a -> String
show Int
code) ByteString -> ByteString -> ByteString
forall a. Monoid a => a -> a -> a
`mappend` ByteString
" " ByteString -> ByteString -> ByteString
forall a. Monoid a => a -> a -> a
`mappend` ByteString
msg
    | Bool
otherwise =
        Int -> (Ptr Word8 -> IO ()) -> ByteString
unsafeCreate (Int
4 Int -> Int -> Int
forall a. Num a => a -> a -> a
+ Int
len) ((Ptr Word8 -> IO ()) -> ByteString)
-> (Ptr Word8 -> IO ()) -> ByteString
forall a b. (a -> b) -> a -> b
$ Status -> Ptr Word8 -> IO ()
renderFullStatusToPtr Status
s
  where
    len :: Int
len = ByteString -> Int
B.length ByteString
msg

-- | Parses the first three characters as digits and converts them to an 'Int'.
--
-- If the first 3 characters are not digits (i.e. @0-9@), or the 'ByteString'
-- is less than 3 bytes long, the result will be 'Nothing'.
--
-- When successful, it will return the parsed status code and the remainder of
-- the 'ByteString'.
--
-- >>> parseStatusCode "307"
-- Just (307,"")
--
-- >>> parseStatusCode "404 Not Found"
-- Just (404," Not Found")
--
-- >>> parseStatusCode "No Digits"
-- Nothing
--
-- >>> parseStatusCode "12 Is Not Enough Digits"
-- Nothing
parseStatusCode :: ByteString -> Maybe (Int, ByteString)
parseStatusCode :: ByteString -> Maybe (Int, ByteString)
parseStatusCode bs :: ByteString
bs@(PS ForeignPtr Word8
fptr Int
offset Int
len)
    | Int
len Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
< Int
3 = Maybe (Int, ByteString)
forall a. Maybe a
Nothing
    | Bool
otherwise =
        IO (Maybe (Int, ByteString)) -> Maybe (Int, ByteString)
forall a. IO a -> a
accursedUnutterablePerformIO (IO (Maybe (Int, ByteString)) -> Maybe (Int, ByteString))
-> IO (Maybe (Int, ByteString)) -> Maybe (Int, ByteString)
forall a b. (a -> b) -> a -> b
$
            ForeignPtr Word8
-> (Ptr Word8 -> IO (Maybe (Int, ByteString)))
-> IO (Maybe (Int, ByteString))
forall a b. ForeignPtr a -> (Ptr a -> IO b) -> IO b
unsafeWithForeignPtr ForeignPtr Word8
fptr ((Ptr Word8 -> IO (Maybe (Int, ByteString)))
 -> IO (Maybe (Int, ByteString)))
-> (Ptr Word8 -> IO (Maybe (Int, ByteString)))
-> IO (Maybe (Int, ByteString))
forall a b. (a -> b) -> a -> b
$ \Ptr Word8
ptr' -> do
                let ptr :: Ptr b
ptr = Ptr Word8
ptr' Ptr Word8 -> Int -> Ptr b
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
offset
                w1 <- Ptr Word8 -> IO Word8
forall a. Storable a => Ptr a -> IO a
peek Ptr Word8
forall {b}. Ptr b
ptr
                w2 <- peek (ptr `plusPtr` 1)
                w3 <- peek (ptr `plusPtr` 2)
                pure $ do
                    h <- toNumber w1
                    t <- toNumber w2
                    i <- toNumber w3
                    Just (h * 100 + t * 10 + i, B.drop 3 bs)
  where
    toNumber :: Word8 -> Maybe Int
    toNumber :: Word8 -> Maybe Int
toNumber Word8
w = do
        Bool -> Maybe ()
forall (f :: * -> *). Alternative f => Bool -> f ()
guard (Bool -> Maybe ()) -> Bool -> Maybe ()
forall a b. (a -> b) -> a -> b
$ Word8
0x30 Word8 -> Word8 -> Bool
forall a. Ord a => a -> a -> Bool
<= Word8
w Bool -> Bool -> Bool
&& Word8
w Word8 -> Word8 -> Bool
forall a. Ord a => a -> a -> Bool
<= Word8
0x39
        Int -> Maybe Int
forall a. a -> Maybe a
Just (Int -> Maybe Int) -> (Word8 -> Int) -> Word8 -> Maybe Int
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Word8 -> Int
forall a b. (Integral a, Num b) => a -> b
fromIntegral (Word8 -> Maybe Int) -> Word8 -> Maybe Int
forall a b. (a -> b) -> a -> b
$ Word8
w Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.&. Word8
0x0F

-- | Assumes the provided 'ByteString' is either:
--
--   * only 3 digits, or
--   * 3 digits, a space, and the rest of the status message
--
-- /N.B. this function does not check for newlines, it puts everything/
-- /after the code and space into the 'statusMessage'./
--
-- >>> parseFullStatus "307"
-- Just (Status {statusCode = 307, statusMessage = ""})
--
-- >>> parseFullStatus "404 Not Found"
-- Just (Status {statusCode = 404, statusMessage = "Not Found"})
--
-- >>> parseFullStatus "500 Someone Forgot To\r\nBreak At The Newline"
-- Just (Status {statusCode = 500, statusMessage = "Someone Forgot To\r\nBreak At The Newline"})
--
-- >>> parseFullStatus "1337 Is A Bad Status Code"
-- Nothing
--
-- >>> parseFullStatus "101Still Needs A Space"
-- Nothing
--
-- >>> parseFullStatus "No Digits"
-- Nothing
parseFullStatus :: ByteString -> Maybe Status
parseFullStatus :: ByteString -> Maybe Status
parseFullStatus ByteString
bs = do
    (code, rest) <- ByteString -> Maybe (Int, ByteString)
parseStatusCode ByteString
bs
    case B.uncons rest of
        Maybe (Word8, ByteString)
Nothing -> Status -> Maybe Status
forall a. a -> Maybe a
Just (Status -> Maybe Status) -> Status -> Maybe Status
forall a b. (a -> b) -> a -> b
$ Int -> ByteString -> Status
mkStatus Int
code ByteString
""
        Just (Word8
w, ByteString
ws)
            | Word8
w Word8 -> Word8 -> Bool
forall a. Eq a => a -> a -> Bool
== Word8
0x20 -> Status -> Maybe Status
forall a. a -> Maybe a
Just (Status -> Maybe Status) -> Status -> Maybe Status
forall a b. (a -> b) -> a -> b
$ Int -> ByteString -> Status
mkStatus Int
code ByteString
ws
            | Bool
otherwise -> Maybe Status
forall a. Maybe a
Nothing

#if !MIN_VERSION_base(4,15,0)
unsafeWithForeignPtr :: ForeignPtr a -> (Ptr a -> IO b) -> IO b
unsafeWithForeignPtr = withForeignPtr
#endif