| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Servant.API.ContentTypes
Description
A collection of basic Content-Types (also known as Internet Media Types, or MIME types). Additionally, this module provides classes that encapsulate how to serialize or deserialize values to or from a particular Content-Type.
Content-Types are used in ReqBody and the method combinators:
>>>type MyEndpoint = ReqBody '[JSON, PlainText] Book :> Get '[JSON, PlainText] :> Book
Meaning the endpoint accepts requests of Content-Type application/json
or text/plain;charset-utf8, and returns data in either one of those
formats (depending on the Accept header).
If you would like to support Content-Types beyond those provided here, then:
- Declare a new data type with no constructors (e.g.
data HTML). - Make an instance of it for
Accept. - If you want to be able to serialize data *into* that
Content-Type, make an instance of it for
MimeRender. - If you want to be able to deserialize data *from* that
Content-Type, make an instance of it for
MimeUnrender.
Note that roles are reversed in servant-server and servant-client:
to be able to serve (or even typecheck) a Get '[JSON, XML] MyData,
you'll need to have the appropriate MimeRender instances in scope,
whereas to query that endpoint with servant-client, you'll need
a MimeUnrender instance in scope.
- data JSON
- data PlainText
- data FormUrlEncoded
- data OctetStream
- class Accept ctype where
- contentType :: Proxy ctype -> MediaType
- class Accept ctype => MimeRender ctype a where
- mimeRender :: Proxy ctype -> a -> ByteString
- class Accept ctype => MimeUnrender ctype a where
- mimeUnrender :: Proxy ctype -> ByteString -> Either String a
- newtype AcceptHeader = AcceptHeader ByteString
- class AllCTRender list a where
- handleAcceptH :: Proxy list -> AcceptHeader -> a -> Maybe (ByteString, ByteString)
- class IsNonEmpty list => AllCTUnrender list a where
- handleCTypeH :: Proxy list -> ByteString -> ByteString -> Maybe (Either String a)
- class AllMimeRender list a where
- allMimeRender :: Proxy list -> a -> [(MediaType, ByteString)]
- class AllMimeUnrender list a where
- allMimeUnrender :: Proxy list -> ByteString -> [(MediaType, Either String a)]
- class FromFormUrlEncoded a where
- fromFormUrlEncoded :: [(Text, Text)] -> Either String a
- class ToFormUrlEncoded a where
- toFormUrlEncoded :: a -> [(Text, Text)]
- type family IsNonEmpty list :: Constraint
- eitherDecodeLenient :: FromJSON a => ByteString -> Either String a
Provided Content-Types
Instances
| Accept * PlainText Source | text/plain;charset=utf-8 |
| MimeUnrender * PlainText Text Source | left show . TextS.decodeUtf8' . toStrict |
| MimeUnrender * PlainText Text Source | left show . TextL.decodeUtf8' |
| MimeRender * PlainText Text Source | fromStrict . TextS.encodeUtf8 |
| MimeRender * PlainText Text Source |
data FormUrlEncoded Source
Instances
| Accept * FormUrlEncoded Source | application/x-www-form-urlencoded |
| FromFormUrlEncoded a => MimeUnrender * FormUrlEncoded a Source |
|
| ToFormUrlEncoded a => MimeRender * FormUrlEncoded a Source |
|
data OctetStream Source
Instances
| Accept * OctetStream Source | application/octet-stream |
| MimeUnrender * OctetStream ByteString Source | Right . toStrict |
| MimeUnrender * OctetStream ByteString Source | Right . id |
| MimeRender * OctetStream ByteString Source | |
| MimeRender * OctetStream ByteString Source | id |
Building your own Content-Type
class Accept ctype where Source
Instances of Accept represent mimetypes. They are used for matching
against the Accept HTTP header of the request, and for setting the
Content-Type header of the response
Example:
>>>import Network.HTTP.Media ((//), (/:))>>>data HTML>>>:{instance Accept HTML where contentType _ = "text" // "html" /: ("charset", "utf-8") :}
Methods
contentType :: Proxy ctype -> MediaType Source
class Accept ctype => MimeRender ctype a where Source
Instantiate this class to register a way of serializing a type based
on the Accept header.
Example:
data MyContentType
instance Accept MyContentType where
contentType _ = "example" // "prs.me.mine" /: ("charset", "utf-8")
instance Show a => MimeRender MyContentType where
mimeRender _ val = pack ("This is MINE! " ++ show val)
type MyAPI = "path" :> Get '[MyContentType] IntMethods
mimeRender :: Proxy ctype -> a -> ByteString Source
Instances
| MimeRender * OctetStream ByteString Source | |
| MimeRender * OctetStream ByteString Source | id |
| ToFormUrlEncoded a => MimeRender * FormUrlEncoded a Source |
|
| MimeRender * PlainText Text Source | fromStrict . TextS.encodeUtf8 |
| MimeRender * PlainText Text Source | |
| ToJSON a => MimeRender * JSON a Source |
class Accept ctype => MimeUnrender ctype a where Source
Instantiate this class to register a way of deserializing a type based
on the request's Content-Type header.
>>>import Network.HTTP.Media hiding (Accept)>>>import qualified Data.ByteString.Lazy.Char8 as BSC>>>data MyContentType = MyContentType String
>>>:{instance Accept MyContentType where contentType _ = "example" // "prs.me.mine" /: ("charset", "utf-8") :}
>>>:{instance Read a => MimeUnrender MyContentType a where mimeUnrender _ bs = case BSC.take 12 bs of "MyContentType" -> return . read . BSC.unpack $ BSC.drop 12 bs _ -> Left "didn't start with the magic incantation" :}
>>>type MyAPI = "path" :> ReqBody '[MyContentType] Int :> Get '[JSON] Int
Methods
mimeUnrender :: Proxy ctype -> ByteString -> Either String a Source
Instances
| MimeUnrender * OctetStream ByteString Source | Right . toStrict |
| MimeUnrender * OctetStream ByteString Source | Right . id |
| FromFormUrlEncoded a => MimeUnrender * FormUrlEncoded a Source |
|
| MimeUnrender * PlainText Text Source | left show . TextS.decodeUtf8' . toStrict |
| MimeUnrender * PlainText Text Source | left show . TextL.decodeUtf8' |
| FromJSON a => MimeUnrender * JSON a Source |
|
Internal
class AllCTRender list a where Source
Methods
handleAcceptH :: Proxy list -> AcceptHeader -> a -> Maybe (ByteString, ByteString) Source
Instances
| (AllMimeRender ctyps a, IsNonEmpty ctyps) => AllCTRender ctyps a Source |
class IsNonEmpty list => AllCTUnrender list a where Source
Methods
handleCTypeH :: Proxy list -> ByteString -> ByteString -> Maybe (Either String a) Source
Instances
| (AllMimeUnrender ctyps a, IsNonEmpty ctyps) => AllCTUnrender ctyps a Source |
class AllMimeRender list a where Source
Methods
allMimeRender :: Proxy list -> a -> [(MediaType, ByteString)] Source
Instances
| AllMimeRender ([] *) a Source | |
| (MimeRender * ctyp a, AllMimeRender ((:) * ctyp' ctyps) a) => AllMimeRender ((:) * ctyp ((:) * ctyp' ctyps)) a Source | |
| MimeRender * ctyp a => AllMimeRender ((:) * ctyp ([] *)) a Source |
class AllMimeUnrender list a where Source
Methods
allMimeUnrender :: Proxy list -> ByteString -> [(MediaType, Either String a)] Source
Instances
| AllMimeUnrender ([] *) a Source | |
| (MimeUnrender * ctyp a, AllMimeUnrender ctyps a) => AllMimeUnrender ((:) * ctyp ctyps) a Source |
class FromFormUrlEncoded a where Source
A type that can be converted from application/x-www-form-urlencoded,
with the possibility of failure.
Instances
| FromFormUrlEncoded [(Text, Text)] Source |
class ToFormUrlEncoded a where Source
A type that can be converted to application/x-www-form-urlencoded
Methods
toFormUrlEncoded :: a -> [(Text, Text)] Source
Instances
| ToFormUrlEncoded [(Text, Text)] Source |
type family IsNonEmpty list :: Constraint Source
Equations
| IsNonEmpty (x : xs) = () |
eitherDecodeLenient :: FromJSON a => ByteString -> Either String a Source
Like eitherDecode but allows all JSON values instead of just
objects and arrays.
Will handle trailing whitespace, but not trailing junk. ie.
>>>eitherDecodeLenient "1 " :: Either String IntRight 1
>>>eitherDecodeLenient "1 junk" :: Either String IntLeft "trailing junk after valid JSON: endOfInput"