Serv.Internal.Header.Serialization

Documentation

class ReflectName n => HeaderEncode n a where

Represents mechanisms to interpret data types as header-compatible values.

An instance of Encode n t captures a mechanism for treating values of type t as valid data to substantiate the header n.

Note: While this class allows the encoding of any value into a full Unicode Text value, Headers do not generally accept most Unicode code points. Be conservative in implementing this class.

Minimal complete definition

headerEncode

Methods

headerEncode :: Proxy n -> a -> Maybe Text

Instances

ReflectName n => HeaderEncode n Text

Methods

headerEncode :: Proxy HeaderName n -> Text -> Maybe Text

ReflectName n => HeaderEncode n Int

Methods

headerEncode :: Proxy HeaderName n -> Int -> Maybe Text

ReflectName n => HeaderEncode n Bool

Methods

headerEncode :: Proxy HeaderName n -> Bool -> Maybe Text

ReflectName n => HeaderEncode n RawText

Methods

headerEncode :: Proxy HeaderName n -> RawText -> Maybe Text

HeaderEncode AccessControlAllowOrigin Text

Methods

headerEncode :: Proxy HeaderName AccessControlAllowOrigin -> Text -> Maybe Text

HeaderEncode AccessControlMaxAge NominalDiffTime

Methods

headerEncode :: Proxy HeaderName AccessControlMaxAge -> NominalDiffTime -> Maybe Text

HeaderEncode AccessControlAllowCredentials Bool

Methods

headerEncode :: Proxy HeaderName AccessControlAllowCredentials -> Bool -> Maybe Text

HeaderEncode h t => HeaderEncode h (Maybe t)

Methods

headerEncode :: Proxy HeaderName h -> Maybe t -> Maybe Text

HeaderEncode AccessControlExposeHeaders (Set HeaderName)

Methods

headerEncode :: Proxy HeaderName AccessControlExposeHeaders -> Set HeaderName -> Maybe Text

HeaderEncode AccessControlAllowMethods [Verb]

Methods

headerEncode :: Proxy HeaderName AccessControlAllowMethods -> [Verb] -> Maybe Text

HeaderEncode AccessControlAllowMethods (Set Verb)

Methods

headerEncode :: Proxy HeaderName AccessControlAllowMethods -> Set Verb -> Maybe Text

HeaderEncode AccessControlAllowHeaders (Set HeaderName)

Methods

headerEncode :: Proxy HeaderName AccessControlAllowHeaders -> Set HeaderName -> Maybe Text

HeaderEncode Allow [Verb]

Methods

headerEncode :: Proxy HeaderName Allow -> [Verb] -> Maybe Text

HeaderEncode Allow (Set Verb)

Methods

headerEncode :: Proxy HeaderName Allow -> Set Verb -> Maybe Text

headerEncodeRaw :: HeaderEncode n a => Proxy n -> a -> Maybe ByteString

Handles encoding a header all the way to raw bytes.

class ReflectName n => HeaderDecode n a where

Represents mechanisms to interpret data types as header-compatible values.

An instance of Decode n t captures a mechanism for reading values of type t from header data stored at header n.

Minimal complete definition

headerDecode

Methods

headerDecode :: Proxy n -> Maybe Text -> Either String a

Instances

ReflectName n => HeaderDecode n RawText

RawText enables capturing the data untouched from the header

Methods

headerDecode :: Proxy HeaderName n -> Maybe Text -> Either String RawText

HeaderDecode h t => HeaderDecode h (Maybe t)

Methods

headerDecode :: Proxy HeaderName h -> Maybe Text -> Either String (Maybe t)

HeaderDecode Accept [Quality MediaType]

Methods

headerDecode :: Proxy HeaderName Accept -> Maybe Text -> Either String [Quality MediaType]

headerDecode' :: HeaderDecode n a => Proxy n -> Text -> Either String a

required :: (Text -> Either String a) -> Maybe Text -> Either String a

headerDecodeRaw :: HeaderDecode n a => Proxy n -> Maybe ByteString -> Either String a

Handles decoding a header all the way from raw bytes.

headerPair :: HeaderEncode h v => Proxy h -> v -> Maybe Header