| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Network.HTTP.Semantics
Description
Library for HTTP Semantics (RFC9110), version-independent common parts. For low-level headers, Token is used. For upper-level headers, HeaderName should be used.
Synopsis
- type ByteCount = Int64
- type FileOffset = Int64
- data OutBodyIface = OutBodyIface {
- outBodyUnmask :: forall x. IO x -> IO x
- outBodyPush :: Builder -> IO ()
- outBodyPushFinal :: Builder -> IO ()
- outBodyCancel :: Maybe SomeException -> IO ()
- outBodyFlush :: IO ()
- type TrailersMaker = Maybe ByteString -> IO NextTrailersMaker
- data NextTrailersMaker
- defaultTrailersMaker :: TrailersMaker
- type Scheme = ByteString
- type Authority = String
- type Path = ByteString
- data FileSpec = FileSpec FilePath FileOffset ByteCount
- data InpObj = InpObj {}
- data OutObj = OutObj {}
- type InpBody = IO (ByteString, Bool)
- data OutBody
- = OutBodyNone
- | OutBodyStreaming ((Builder -> IO ()) -> IO () -> IO ())
- | OutBodyStreamingIface (OutBodyIface -> IO ())
- | OutBodyBuilder Builder
- | OutBodyFile FileSpec
- type FieldName = ByteString
- type FieldValue = ByteString
- type TokenHeader = (Token, FieldValue)
- type TokenHeaderList = [TokenHeader]
- type TokenHeaderTable = (TokenHeaderList, ValueTable)
- type ValueTable = Array Int (Maybe FieldValue)
- getFieldValue :: Token -> ValueTable -> Maybe FieldValue
- type HeaderTable = (TokenHeaderList, ValueTable)
- type HeaderValue = ByteString
- getHeaderValue :: Token -> ValueTable -> Maybe FieldValue
- data Token = Token {
- tokenIx :: Int
- shouldBeIndexed :: Bool
- isPseudo :: Bool
- tokenKey :: HeaderName
- tokenCIKey :: Token -> ByteString
- tokenFoldedKey :: Token -> ByteString
- toToken :: ByteString -> Token
- minTokenIx :: Int
- maxStaticTokenIx :: Int
- maxTokenIx :: Int
- cookieTokenIx :: Int
- isMaxTokenIx :: Int -> Bool
- isCookieTokenIx :: Int -> Bool
- isStaticTokenIx :: Int -> Bool
- isStaticToken :: Token -> Bool
- tokenAuthority :: Token
- tokenMethod :: Token
- tokenPath :: Token
- tokenScheme :: Token
- tokenStatus :: Token
- tokenAcceptCharset :: Token
- tokenAcceptEncoding :: Token
- tokenAcceptLanguage :: Token
- tokenAcceptRanges :: Token
- tokenAccept :: Token
- tokenAccessControlAllowOrigin :: Token
- tokenAge :: Token
- tokenAllow :: Token
- tokenAuthorization :: Token
- tokenCacheControl :: Token
- tokenContentDisposition :: Token
- tokenContentEncoding :: Token
- tokenContentLanguage :: Token
- tokenContentLength :: Token
- tokenContentLocation :: Token
- tokenContentRange :: Token
- tokenContentType :: Token
- tokenCookie :: Token
- tokenDate :: Token
- tokenEtag :: Token
- tokenExpect :: Token
- tokenExpires :: Token
- tokenFrom :: Token
- tokenHost :: Token
- tokenIfMatch :: Token
- tokenIfModifiedSince :: Token
- tokenIfNoneMatch :: Token
- tokenIfRange :: Token
- tokenIfUnmodifiedSince :: Token
- tokenLastModified :: Token
- tokenLink :: Token
- tokenLocation :: Token
- tokenMaxForwards :: Token
- tokenProxyAuthenticate :: Token
- tokenProxyAuthorization :: Token
- tokenRange :: Token
- tokenReferer :: Token
- tokenRefresh :: Token
- tokenRetryAfter :: Token
- tokenServer :: Token
- tokenSetCookie :: Token
- tokenStrictTransportSecurity :: Token
- tokenTransferEncoding :: Token
- tokenUserAgent :: Token
- tokenVary :: Token
- tokenVia :: Token
- tokenWwwAuthenticate :: Token
- tokenConnection :: Token
- tokenTE :: Token
- tokenMax :: Token
- tokenAccessControlAllowCredentials :: Token
- tokenAccessControlAllowHeaders :: Token
- tokenAccessControlAllowMethods :: Token
- tokenAccessControlExposeHeaders :: Token
- tokenAccessControlRequestHeaders :: Token
- tokenAccessControlRequestMethod :: Token
- tokenAltSvc :: Token
- tokenContentSecurityPolicy :: Token
- tokenEarlyData :: Token
- tokenExpectCt :: Token
- tokenForwarded :: Token
- tokenOrigin :: Token
- tokenPurpose :: Token
- tokenTimingAllowOrigin :: Token
- tokenUpgradeInsecureRequests :: Token
- tokenXContentTypeOptions :: Token
- tokenXForwardedFor :: Token
- tokenXFrameOptions :: Token
- tokenXXssProtection :: Token
Documentation
type FileOffset = Int64 #
Offset for file.
data OutBodyIface #
Constructors
| OutBodyIface | |
Fields
| |
type TrailersMaker = Maybe ByteString -> IO NextTrailersMaker #
Trailers maker. A chunks of the response body is passed
with Just. The maker should update internal state
with the ByteString and return the next trailers maker.
When response body reaches its end,
Nothing is passed and the maker should generate
trailers. An example:
{-# LANGUAGE BangPatterns #-}
import Data.ByteString (ByteString)
import qualified Data.ByteString.Char8 as C8
import Crypto.Hash (Context, SHA1) -- cryptonite
import qualified Crypto.Hash as CH
-- Strictness is important for Context.
trailersMaker :: Context SHA1 -> Maybe ByteString -> IO NextTrailersMaker
trailersMaker ctx Nothing = return $ Trailers [("X-SHA1", sha1)]
where
!sha1 = C8.pack $ show $ CH.hashFinalize ctx
trailersMaker ctx (Just bs) = return $ NextTrailersMaker $ trailersMaker ctx'
where
!ctx' = CH.hashUpdate ctx bsUsage example:
let h2rsp = responseFile ...
maker = trailersMaker (CH.hashInit :: Context SHA1)
h2rsp' = setResponseTrailersMaker h2rsp makerdata NextTrailersMaker #
Either the next trailers maker or final trailers.
Constructors
| NextTrailersMaker TrailersMaker | |
| Trailers [Header] |
defaultTrailersMaker :: TrailersMaker #
TrailersMake to create no trailers.
type Scheme = ByteString #
"http" or "https".
type Path = ByteString #
Path.
File specification.
Constructors
| FileSpec FilePath FileOffset ByteCount |
Input object
Constructors
| InpObj | |
Fields
| |
Output object
Constructors
| OutObj | |
Fields
| |
type InpBody = IO (ByteString, Bool) #
Constructors
| OutBodyNone | |
| OutBodyStreaming ((Builder -> IO ()) -> IO () -> IO ()) | Streaming body takes a write action and a flush action. |
| OutBodyStreamingIface (OutBodyIface -> IO ()) | Generalization of |
| OutBodyBuilder Builder | |
| OutBodyFile FileSpec |
type FieldName = ByteString #
Field name. Internal usage only.
type FieldValue = ByteString #
Field value.
type TokenHeader = (Token, FieldValue) #
TokenBased header.
type TokenHeaderList = [TokenHeader] #
TokenBased header list.
type TokenHeaderTable = (TokenHeaderList, ValueTable) #
A pair of token list and value table.
type ValueTable = Array Int (Maybe FieldValue) #
An array to get FieldValue quickly.
getHeaderValue should be used.
Internally, the key is tokenIx.
getFieldValue :: Token -> ValueTable -> Maybe FieldValue #
Accessing FieldValue with Token.
type HeaderTable = (TokenHeaderList, ValueTable) #
Deprecated: use TokenHeaderTable instead
A pair of token list and value table.
type HeaderValue = ByteString #
Deprecated: use FieldValue instead
Header value.
getHeaderValue :: Token -> ValueTable -> Maybe FieldValue #
Deprecated: use geFieldValue instead
Accessing FieldValue with Token.
Internal representation for header keys.
Constructors
| Token | |
Fields
| |
tokenCIKey :: Token -> ByteString #
Extracting a case insensitive header key from a token.
tokenFoldedKey :: Token -> ByteString #
Extracting a folded header key from a token.
toToken :: ByteString -> Token #
Making a token from a header key.
>>>toToken ":authority" == tokenAuthorityTrue>>>toToken "foo"Token {tokenIx = 73, shouldBeIndexed = True, isPseudo = False, tokenKey = "foo"}>>>toToken ":bar"Token {tokenIx = 73, shouldBeIndexed = True, isPseudo = True, tokenKey = ":bar"}
minTokenIx :: Int #
Minimum token index.
maxStaticTokenIx :: Int #
Maximun token index defined in the static table.
maxTokenIx :: Int #
Maximum token index.
cookieTokenIx :: Int #
Token index for tokenCookie.
isMaxTokenIx :: Int -> Bool #
Is this token ix to be held in the place holder?
isCookieTokenIx :: Int -> Bool #
Is this token ix for Cookie?
isStaticTokenIx :: Int -> Bool #
Is this token ix for a header not defined in the static table?
isStaticToken :: Token -> Bool #
Is this token for a header not defined in the static table?
tokenAuthority :: Token #
tokenMethod :: Token #
tokenScheme :: Token #
tokenStatus :: Token #
tokenAccept :: Token #
tokenAllow :: Token #
tokenCookie :: Token #
tokenExpect :: Token #
tokenExpires :: Token #
tokenIfMatch :: Token #
tokenIfRange :: Token #
tokenLocation :: Token #
tokenRange :: Token #
tokenReferer :: Token #
tokenRefresh :: Token #
tokenServer :: Token #
tokenSetCookie :: Token #
tokenUserAgent :: Token #
A place holder to hold header keys not defined in the static table. | For Warp
tokenAccessControlAllowCredentials :: Token #
For QPACK
tokenAltSvc :: Token #
tokenEarlyData :: Token #
tokenExpectCt :: Token #
tokenForwarded :: Token #
tokenOrigin :: Token #
tokenPurpose :: Token #