Safe Haskell	None
Language	Haskell2010

Symantic.HTTP.MIME

Contents

Class MediaTypeFor
Type MimeType
- Type MimeTypeTs
Class MimeTypes
Type MimeEncodable
- Type MimeEncoder
Type MimeDecodable
- Type MimeDecoder

Synopsis

class MediaTypeFor t where
- mediaTypeFor :: Proxy t -> MediaType
- mediaTypesFor :: Proxy t -> NonEmpty MediaType
type MediaType = MediaType
mediaType :: forall t. MediaTypeFor t => MediaType
type MediaTypes = NonEmpty MediaType
mediaTypes :: forall ts c. MimeTypes ts c => MediaTypes
charsetUTF8 :: MediaType -> MediaType
mimeAny :: MediaType
data JSON
data HTML
data FormUrlEncoded
data OctetStream
data PlainText
data MimeType c where
- MimeType :: (c t, MediaTypeFor t) => Proxy t -> MimeType c
mimeType :: forall t c. MediaTypeFor t => c t => MimeType c
type MimeTypeTs c = NonEmpty (MimeType c)
mimeTypes :: forall ts c. MimeTypes ts c => NonEmpty (MimeType c)
class MimeTypes (ts :: [*]) (c :: * -> Constraint) where
- mimeTypesMap :: NonEmpty (MediaType, MimeType c)
matchAccept :: forall ts c. MimeTypes ts c => ByteString -> Maybe (MimeType c)
matchContent :: forall ts c. MimeTypes ts c => ByteString -> Maybe (MimeType c)
class MediaTypeFor t => MimeEncodable a t where
- mimeEncode :: Proxy t -> MimeEncoder a
type MimeEncoder a = a -> ByteString
class MediaTypeFor mt => MimeDecodable a mt where
- mimeDecode :: Proxy mt -> MimeDecoder a
type MimeDecoder a = ByteString -> Either String a

Class `MediaTypeFor`

class MediaTypeFor t where Source #

Minimal complete definition

mediaTypeFor

Methods

mediaTypeFor :: Proxy t -> MediaType Source #

mediaTypesFor :: Proxy t -> NonEmpty MediaType Source #

Instances

MediaTypeFor () Source #
Instance details Defined in Symantic.HTTP.MIME Methods mediaTypeFor :: Proxy () -> MediaType Source # mediaTypesFor :: Proxy () -> NonEmpty MediaType Source #
MediaTypeFor PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mediaTypeFor :: Proxy PlainText -> MediaType Source # mediaTypesFor :: Proxy PlainText -> NonEmpty MediaType Source #
MediaTypeFor OctetStream Source #
Instance details Defined in Symantic.HTTP.MIME Methods mediaTypeFor :: Proxy OctetStream -> MediaType Source # mediaTypesFor :: Proxy OctetStream -> NonEmpty MediaType Source #
MediaTypeFor FormUrlEncoded Source #
Instance details Defined in Symantic.HTTP.MIME Methods mediaTypeFor :: Proxy FormUrlEncoded -> MediaType Source # mediaTypesFor :: Proxy FormUrlEncoded -> NonEmpty MediaType Source #
MediaTypeFor HTML Source #
Instance details Defined in Symantic.HTTP.MIME Methods mediaTypeFor :: Proxy HTML -> MediaType Source # mediaTypesFor :: Proxy HTML -> NonEmpty MediaType Source #
MediaTypeFor JSON Source #
Instance details Defined in Symantic.HTTP.MIME Methods mediaTypeFor :: Proxy JSON -> MediaType Source # mediaTypesFor :: Proxy JSON -> NonEmpty MediaType Source #

Type `MediaType`

type MediaType = MediaType Source #

mediaType :: forall t. MediaTypeFor t => MediaType Source #

Type `MediaTypes`

type MediaTypes = NonEmpty MediaType Source #

mediaTypes :: forall ts c. MimeTypes ts c => MediaTypes Source #

charsetUTF8 :: MediaType -> MediaType Source #

mimeAny :: MediaType Source #

Type `JSON`

data JSON Source #

Instances

MediaTypeFor JSON Source #
Instance details Defined in Symantic.HTTP.MIME Methods mediaTypeFor :: Proxy JSON -> MediaType Source # mediaTypesFor :: Proxy JSON -> NonEmpty MediaType Source #

Type `HTML`

data HTML Source #

Instances

MediaTypeFor HTML Source #
Instance details Defined in Symantic.HTTP.MIME Methods mediaTypeFor :: Proxy HTML -> MediaType Source # mediaTypesFor :: Proxy HTML -> NonEmpty MediaType Source #

Type `FormUrlEncoded`

data FormUrlEncoded Source #

Instances

MediaTypeFor FormUrlEncoded Source #
Instance details Defined in Symantic.HTTP.MIME Methods mediaTypeFor :: Proxy FormUrlEncoded -> MediaType Source # mediaTypesFor :: Proxy FormUrlEncoded -> NonEmpty MediaType Source #
FromForm a => MimeDecodable a FormUrlEncoded Source #	`Web.urlDecodeAsForm` Note that the `mimeDecode p (mimeEncode p x) == Right x` law only holds if every element of x is non-null (i.e., not `("", "")`)
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy FormUrlEncoded -> MimeDecoder a Source #
ToForm a => MimeEncodable a FormUrlEncoded Source #	`Web.urlEncodeAsForm` Note that the `mimeDecode p (mimeEncode p x) == Right x` law only holds if every element of x is non-null (i.e., not `("", "")`)
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy FormUrlEncoded -> MimeEncoder a Source #

Type `OctetStream`

data OctetStream Source #

Instances

MediaTypeFor OctetStream Source #
Instance details Defined in Symantic.HTTP.MIME Methods mediaTypeFor :: Proxy OctetStream -> MediaType Source # mediaTypesFor :: Proxy OctetStream -> NonEmpty MediaType Source #
MimeDecodable ByteString OctetStream Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy OctetStream -> MimeDecoder ByteString Source #
MimeDecodable ByteString OctetStream Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy OctetStream -> MimeDecoder ByteString Source #
MimeEncodable ByteString OctetStream Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy OctetStream -> MimeEncoder ByteString Source #
MimeEncodable ByteString OctetStream Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy OctetStream -> MimeEncoder ByteString Source #

Type `PlainText`

data PlainText Source #

Instances

MediaTypeFor PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mediaTypeFor :: Proxy PlainText -> MediaType Source # mediaTypesFor :: Proxy PlainText -> NonEmpty MediaType Source #
MimeDecodable Int PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy PlainText -> MimeDecoder Int Source #
MimeDecodable () PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy PlainText -> MimeDecoder () Source #
MimeDecodable Text PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy PlainText -> MimeDecoder Text Source #
MimeDecodable Text PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy PlainText -> MimeDecoder Text Source #
MimeDecodable String PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy PlainText -> MimeDecoder String Source #
MimeEncodable Int PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy PlainText -> MimeEncoder Int Source #
MimeEncodable () PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy PlainText -> MimeEncoder () Source #
MimeEncodable Text PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy PlainText -> MimeEncoder Text Source #
MimeEncodable Text PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy PlainText -> MimeEncoder Text Source #
MimeEncodable String PlainText Source #	BSL.fromStrict . T.encodeUtf8
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy PlainText -> MimeEncoder String Source #

Type `MimeType`

data MimeType c where Source #

Existentially wraps a type-level type t with a proof it respects Constraint c. Usyally c is MimeEncodable a or MimeDecodable a.

Constructors

MimeType :: (c t, MediaTypeFor t) => Proxy t -> MimeType c

mimeType :: forall t c. MediaTypeFor t => c t => MimeType c Source #

Type `MimeTypeTs`

type MimeTypeTs c = NonEmpty (MimeType c) Source #

mimeTypes :: forall ts c. MimeTypes ts c => NonEmpty (MimeType c) Source #

Class `MimeTypes`

class MimeTypes (ts :: [*]) (c :: * -> Constraint) where Source #

Implicitely generate MediaTypes and MimeTypes from given type-level list of types.

Methods

mimeTypesMap :: NonEmpty (MediaType, MimeType c) Source #

Instances

(MediaTypeFor t, MimeTypes (t1 ': ts) c, c t) => MimeTypes (t ': (t1 ': ts)) c Source #	More than one `MimeType`.
Instance details Defined in Symantic.HTTP.MIME Methods mimeTypesMap :: NonEmpty (MediaType, MimeType c) Source #
(MediaTypeFor t, c t) => MimeTypes (t ': ([] :: [Type])) c Source #	Single `MimeType`.
Instance details Defined in Symantic.HTTP.MIME Methods mimeTypesMap :: NonEmpty (MediaType, MimeType c) Source #

matchAccept :: forall ts c. MimeTypes ts c => ByteString -> Maybe (MimeType c) Source #

matchContent :: forall ts c. MimeTypes ts c => ByteString -> Maybe (MimeType c) Source #

Type `MimeEncodable`

class MediaTypeFor t => MimeEncodable a t where Source #

Methods

mimeEncode :: Proxy t -> MimeEncoder a Source #

Instances

MimeEncodable Int PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy PlainText -> MimeEncoder Int Source #
MimeEncodable () PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy PlainText -> MimeEncoder () Source #
ToForm a => MimeEncodable a FormUrlEncoded Source #	`Web.urlEncodeAsForm` Note that the `mimeDecode p (mimeEncode p x) == Right x` law only holds if every element of x is non-null (i.e., not `("", "")`)
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy FormUrlEncoded -> MimeEncoder a Source #
MimeEncodable ByteString OctetStream Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy OctetStream -> MimeEncoder ByteString Source #
MimeEncodable ByteString OctetStream Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy OctetStream -> MimeEncoder ByteString Source #
MimeEncodable Text PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy PlainText -> MimeEncoder Text Source #
MimeEncodable Text PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy PlainText -> MimeEncoder Text Source #
MimeEncodable String PlainText Source #	BSL.fromStrict . T.encodeUtf8
Instance details Defined in Symantic.HTTP.MIME Methods mimeEncode :: Proxy PlainText -> MimeEncoder String Source #

Type `MimeEncoder`

type MimeEncoder a = a -> ByteString Source #

Type `MimeDecodable`

class MediaTypeFor mt => MimeDecodable a mt where Source #

Methods

mimeDecode :: Proxy mt -> MimeDecoder a Source #

Instances

MimeDecodable Int PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy PlainText -> MimeDecoder Int Source #
MimeDecodable () PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy PlainText -> MimeDecoder () Source #
FromForm a => MimeDecodable a FormUrlEncoded Source #	`Web.urlDecodeAsForm` Note that the `mimeDecode p (mimeEncode p x) == Right x` law only holds if every element of x is non-null (i.e., not `("", "")`)
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy FormUrlEncoded -> MimeDecoder a Source #
MimeDecodable ByteString OctetStream Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy OctetStream -> MimeDecoder ByteString Source #
MimeDecodable ByteString OctetStream Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy OctetStream -> MimeDecoder ByteString Source #
MimeDecodable Text PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy PlainText -> MimeDecoder Text Source #
MimeDecodable Text PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy PlainText -> MimeDecoder Text Source #
MimeDecodable String PlainText Source #
Instance details Defined in Symantic.HTTP.MIME Methods mimeDecode :: Proxy PlainText -> MimeDecoder String Source #

Type `MimeDecoder`

type MimeDecoder a = ByteString -> Either String a Source #