WebApi.ContentTypes

Predefined Content Types.

data JSON

Type representing content type of application/json.

Instances

Accept JSON

FromJSON a => Decode JSON a

ToJSON c => Encode JSON c

data PlainText

Type representing content type of text/plain.

Instances

Accept PlainText

FromText a => Decode PlainText a

ToText a => Encode PlainText a

data HTML

Type representing content type of text/html.

Instances

Accept HTML

data OctetStream

Type representing content type of application/octetstream.

Instances

Accept OctetStream

data MultipartFormData

Type representing content type of multipart/form-data.

Instances

Accept MultipartFormData

data UrlEncoded

Type representing content type of application/x-www-form-urlencoded.

Instances

Accept UrlEncoded

Creating custom Content Types.

data Content ctypes a

class Accept ctype where

Singleton class for content type.

Methods

contentType :: Proxy ctype -> MediaType

Instances

Accept UrlEncoded

Accept MultipartFormData

Accept OctetStream

Accept HTML

Accept PlainText

Accept JSON

class Accept a => Encode a c where

Encode a type into a specific content type.

Methods

encode :: Proxy a -> c -> Builder

Instances

ToText a => Encode PlainText a

ToJSON c => Encode JSON c

class Accept c => Decode c a where

(Try to) Decode a type from a specific content type.

Methods

decode :: Proxy c -> ByteString -> Either String a

Instances

FromText a => Decode PlainText a

FromJSON a => Decode JSON a

Converting from and to Text

class FromText a where

Methods

fromText :: Text -> Maybe a

Instances

FromText Text

class ToText a where

Methods

toText :: a -> Text

Instances

ToText Text

Internal classes.

class Encodings ctypes a where

Encodings of type for all content types ctypes.

Methods

encodings :: Proxy ctypes -> a -> [(MediaType, Builder)]

Instances

Encodings ([] *) a

(Accept ctype, Encode ctype a, Encodings ctypes a) => Encodings ((:) * ctype ctypes) a

class Decodings ctypes a where

Decodings of type for all content types ctypes.

Methods

decodings :: Proxy ctypes -> ByteString -> [(MediaType, Either String a)]

Instances

Decodings ([] *) a

(Accept ctype, Decode ctype a, Decodings ctypes a) => Decodings ((:) * ctype ctypes) a

class PartEncodings xs where

Methods

partEncodings :: Proxy xs -> HListToRecTuple (StripContents xs) -> [[(MediaType, Builder)]]

Instances

PartEncodings ([] *)

(PartEncodings ts, Encodings ctypes (StripContent t), (~) * (MkContent t) (Content ctypes a)) => PartEncodings ((:) * t ts)

class PartDecodings xs where

Methods

partDecodings :: Proxy xs -> [(ByteString, ByteString)] -> Either String (HListToRecTuple (StripContents xs))

Instances

PartDecodings ([] *)

(PartDecodings ts, Decodings ctypes (StripContent t), (~) * (MkContent t) (Content ctypes a)) => PartDecodings ((:) * t ts)

type family StripContents a :: [*]

Equations

StripContents (t : ts) = StripContent t : StripContents ts

StripContents `[]` = `[]`