Servant.API.Header

Documentation

type Header = Header' '[Optional, Strict]

Extract the given header's value as a value of type a. I.e. header sent by client, parsed by server.

Example:

>>> newtype Referer = Referer Text deriving (Eq, Show)
>>> 
>>> -- GET /view-my-referer
>>> type MyApi = "view-my-referer" :> Header "from" Referer :> Get '[JSON] Referer

data Header' (mods :: [*]) (sym :: Symbol) a

Instances

(KnownSymbol h, ToHttpApiData v) => AddHeader h v (Headers ((:) * fst rest) a) (Headers ((:) * (Header * h v) ((:) * fst rest)) a)

Methods

addOptionalHeader :: ResponseHeader h v -> Headers ((* ': fst) rest) a -> Headers ((* ': Header * h v) ((* ': fst) rest)) a

(KnownSymbol h, ToHttpApiData x, GetHeaders (HList xs)) => GetHeaders (HList ((:) * (Header * h x) xs))

Methods

getHeaders :: HList ((* ': Header * h x) xs) -> [Header]

HasLink * sub => HasLink * ((:>) * (Header' k mods sym a) sub)

Associated Types

type MkLink ((* :> Header' k mods sym a) sub) (endpoint :: (* :> Header' k mods sym a) sub) :: *

Methods

toLink :: Proxy ((* :> Header' k mods sym a) sub) endpoint -> Link -> MkLink ((* :> Header' k mods sym a) sub) endpoint

(KnownSymbol h, GetHeaders (HList rest), ToHttpApiData v) => GetHeaders (Headers ((:) * (Header * h v) rest) a)

Methods

getHeaders :: Headers ((* ': Header * h v) rest) a -> [Header]

(FromHttpApiData v, BuildHeadersTo xs, KnownSymbol h) => BuildHeadersTo ((:) * (Header * h v) xs)

Methods

buildHeadersTo :: [Header] -> HList ((* ': Header * h v) xs)

type MkLink * ((:>) * (Header' k mods sym a) sub)

type MkLink * ((:>) * (Header' k mods sym a) sub) = MkLink * sub