Copyright	(c) Frederick Pringle 2024
License	BSD-3-Clause
Maintainer	freddyjepringle@gmail.com
Safe Haskell	Safe-Inferred
Language	Haskell2010

Servant.API.Routes.Header

Description

Simple representation of HTTP headers.

Synopsis

data HeaderRep
class GetHeaderReps (hs :: [Type]) where
- getHeaderReps :: [HeaderRep]
mkHeaderRep :: forall sym a. (KnownSymbol sym, Typeable a) => HeaderRep

Documentation

data HeaderRep Source #

Simple term-level representation of a Header.

A type-level Header (sym :: Symbol) typ should correspond to HeaderRep { _hName = str, _hType = typRep }, where str is the term-level equivalent of sym and typRep is the term-level representation of typ.

Instances

Instances details

ToJSON HeaderRep Source #
Instance details Defined in Servant.API.Routes.Internal.Header Methods toJSON :: HeaderRep -> Value Source # toEncoding :: HeaderRep -> Encoding Source # toJSONList :: [HeaderRep] -> Value Source # toEncodingList :: [HeaderRep] -> Encoding Source #
Show HeaderRep Source #
Instance details Defined in Servant.API.Routes.Internal.Header Methods showsPrec :: Int -> HeaderRep -> ShowS Source # show :: HeaderRep -> String Source # showList :: [HeaderRep] -> ShowS Source #
Eq HeaderRep Source #
Instance details Defined in Servant.API.Routes.Internal.Header Methods (==) :: HeaderRep -> HeaderRep -> Bool Source # (/=) :: HeaderRep -> HeaderRep -> Bool Source #

class GetHeaderReps (hs :: [Type]) where Source #

Utility class to let us get a value-level list of HeaderReps from a type-level list of Headers. See the implementation of HasRoutes (Verb method status ctypes (Headers hs a)) for an example.

Methods

getHeaderReps :: [HeaderRep] Source #

Instances

Instances details

GetHeaderReps ('[] :: [Type]) Source #
Instance details Defined in Servant.API.Routes.Header Methods getHeaderReps :: [HeaderRep] Source #
(GetHeaderReps rest, KnownSymbol h, Typeable v) => GetHeaderReps (Header h v ': rest) Source #
Instance details Defined in Servant.API.Routes.Header Methods getHeaderReps :: [HeaderRep] Source #

mkHeaderRep :: forall sym a. (KnownSymbol sym, Typeable a) => HeaderRep Source #

Convenience function to construct a HeaderRep from sym :: Symbol and a :: Type'.