Documentation

TrailersMake to create no trailers.

Either the next trailers maker or final trailers.

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 bs

Usage example:

let h2rsp = responseFile ...
    maker = trailersMaker (CH.hashInit :: Context SHA1)
    h2rsp' = setResponseTrailersMaker h2rsp maker

Authority.

How many bytes to read

Offset for file.

File specification.

Input object

Output object

Path.

"http" or "https".

Accessing FieldValue with Token.

Accessing FieldValue with Token.

Field name. Internal usage only.

Field value.

A pair of token list and value table.

Header value.

TokenBased header.

TokenBased header list.

A pair of token list and value table.

An array to get FieldValue quickly. getHeaderValue should be used. Internally, the key is tokenIx.

Token index for tokenCookie.

Is this token ix for Cookie?

Is this token ix to be held in the place holder?

Is this token for a header not defined in the static table?

Is this token ix for a header not defined in the static table?

Maximun token index defined in the static table.

Maximum token index.

Minimum token index.

Making a token from a header key.

>>> toToken ":authority" == tokenAuthority
True
>>> toToken "foo"
Token {tokenIx = 73, shouldBeIndexed = True, isPseudo = False, tokenKey = "foo"}
>>> toToken ":bar"
Token {tokenIx = 73, shouldBeIndexed = True, isPseudo = True, tokenKey = ":bar"}

For QPACK

Extracting a case insensitive header key from a token.

A place holder to hold header keys not defined in the static table. | For Warp

Extracting a folded header key from a token.

Internal representation for header keys.