Safe Haskell	None
Language	Haskell2010

Servant.API.ContentTypes

Contents

Provided Content-Types
Building your own Content-Type
NoContent
Internal

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 :> Put '[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.

Synopsis

data JSON
data PlainText
data FormUrlEncoded
data OctetStream
class Accept ctype where
- contentType :: Proxy ctype -> MediaType
- contentTypes :: Proxy ctype -> NonEmpty 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
- mimeUnrenderWithType :: Proxy ctype -> MediaType -> ByteString -> Either String a
data NoContent = NoContent
newtype AcceptHeader = AcceptHeader ByteString
class AllMime list => AllCTRender (list :: [*]) a where
- handleAcceptH :: Proxy list -> AcceptHeader -> a -> Maybe ( ByteString , ByteString )
class AllCTUnrender (list :: [*]) a where
- canHandleCTypeH :: Proxy list -> ByteString -> Maybe ( ByteString -> Either String a)
- handleCTypeH :: Proxy list -> ByteString -> ByteString -> Maybe ( Either String a)
class AllMime (list :: [*]) where
- allMime :: Proxy list -> [ MediaType ]
class AllMime list => AllMimeRender (list :: [*]) a where
- allMimeRender :: Proxy list -> a -> [( MediaType , ByteString )]
class AllMime list => AllMimeUnrender (list :: [*]) a where
- allMimeUnrender :: Proxy list -> [( MediaType , ByteString -> Either String a)]
eitherDecodeLenient :: FromJSON a => ByteString -> Either String a
canHandleAcceptH :: AllMime list => Proxy list -> AcceptHeader -> Bool

Provided Content-Types

data JSON Source #

Instances

Instances details

Accept JSON Source #	application/json
Instance details Defined in Servant.API.ContentTypes Methods contentType :: Proxy JSON -> MediaType Source # contentTypes :: Proxy JSON -> NonEmpty MediaType Source #
FromJSON a => MimeUnrender JSON a Source #	`eitherDecode`
Instance details Defined in Servant.API.ContentTypes Methods mimeUnrender :: Proxy JSON -> ByteString -> Either String a Source # mimeUnrenderWithType :: Proxy JSON -> MediaType -> ByteString -> Either String a Source #
ToJSON a => MimeRender JSON a Source #	`encode`
Instance details Defined in Servant.API.ContentTypes Methods mimeRender :: Proxy JSON -> a -> ByteString Source #
MimeUnrender JSON a => MimeUnrender JSON ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeUnrender :: Proxy JSON -> ByteString -> Either String ( WithStatus _status a) Source # mimeUnrenderWithType :: Proxy JSON -> MediaType -> ByteString -> Either String ( WithStatus _status a) Source #
MimeRender JSON a => MimeRender JSON ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeRender :: Proxy JSON -> WithStatus _status a -> ByteString Source #

data PlainText Source #

Instances

Instances details

Accept PlainText Source #	text/plain;charset=utf-8
Instance details Defined in Servant.API.ContentTypes Methods contentType :: Proxy PlainText -> MediaType Source # contentTypes :: Proxy PlainText -> NonEmpty MediaType Source #
MimeUnrender PlainText String Source #	Right . BC.unpack
Instance details Defined in Servant.API.ContentTypes Methods mimeUnrender :: Proxy PlainText -> ByteString -> Either String String Source # mimeUnrenderWithType :: Proxy PlainText -> MediaType -> ByteString -> Either String String Source #
MimeUnrender PlainText Text Source #	left show . TextS.decodeUtf8' . toStrict
Instance details Defined in Servant.API.ContentTypes Methods mimeUnrender :: Proxy PlainText -> ByteString -> Either String Text Source # mimeUnrenderWithType :: Proxy PlainText -> MediaType -> ByteString -> Either String Text Source #
MimeUnrender PlainText Text Source #	left show . TextL.decodeUtf8'
Instance details Defined in Servant.API.ContentTypes Methods mimeUnrender :: Proxy PlainText -> ByteString -> Either String Text Source # mimeUnrenderWithType :: Proxy PlainText -> MediaType -> ByteString -> Either String Text Source #
MimeRender PlainText String Source #	BC.pack
Instance details Defined in Servant.API.ContentTypes Methods mimeRender :: Proxy PlainText -> String -> ByteString Source #
MimeRender PlainText Text Source #	fromStrict . TextS.encodeUtf8
Instance details Defined in Servant.API.ContentTypes Methods mimeRender :: Proxy PlainText -> Text -> ByteString Source #
MimeRender PlainText Text Source #	`encodeUtf8`
Instance details Defined in Servant.API.ContentTypes Methods mimeRender :: Proxy PlainText -> Text -> ByteString Source #
MimeUnrender PlainText a => MimeUnrender PlainText ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeUnrender :: Proxy PlainText -> ByteString -> Either String ( WithStatus _status a) Source # mimeUnrenderWithType :: Proxy PlainText -> MediaType -> ByteString -> Either String ( WithStatus _status a) Source #
MimeRender PlainText a => MimeRender PlainText ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeRender :: Proxy PlainText -> WithStatus _status a -> ByteString Source #

data FormUrlEncoded Source #

Instances

Instances details

Accept FormUrlEncoded Source #	application/x-www-form-urlencoded
Instance details Defined in Servant.API.ContentTypes Methods contentType :: Proxy FormUrlEncoded -> MediaType Source # contentTypes :: Proxy FormUrlEncoded -> NonEmpty MediaType Source #
FromForm a => MimeUnrender FormUrlEncoded a Source #	`urlDecodeAsForm` Note that the `mimeUnrender p (mimeRender p x) == Right x` law only holds if every element of x is non-null (i.e., not `("", "")` )
Instance details Defined in Servant.API.ContentTypes Methods mimeUnrender :: Proxy FormUrlEncoded -> ByteString -> Either String a Source # mimeUnrenderWithType :: Proxy FormUrlEncoded -> MediaType -> ByteString -> Either String a Source #
ToForm a => MimeRender FormUrlEncoded a Source #	`urlEncodeAsForm` Note that the `mimeUnrender p (mimeRender p x) == Right x` law only holds if every element of x is non-null (i.e., not `("", "")` )
Instance details Defined in Servant.API.ContentTypes Methods mimeRender :: Proxy FormUrlEncoded -> a -> ByteString Source #
MimeUnrender FormUrlEncoded a => MimeUnrender FormUrlEncoded ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeUnrender :: Proxy FormUrlEncoded -> ByteString -> Either String ( WithStatus _status a) Source # mimeUnrenderWithType :: Proxy FormUrlEncoded -> MediaType -> ByteString -> Either String ( WithStatus _status a) Source #
MimeRender FormUrlEncoded a => MimeRender FormUrlEncoded ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeRender :: Proxy FormUrlEncoded -> WithStatus _status a -> ByteString Source #

data OctetStream Source #

Instances

Instances details

Accept OctetStream Source #	application/octet-stream
Instance details Defined in Servant.API.ContentTypes Methods contentType :: Proxy OctetStream -> MediaType Source # contentTypes :: Proxy OctetStream -> NonEmpty MediaType Source #
MimeUnrender OctetStream ByteString Source #	Right . toStrict
Instance details Defined in Servant.API.ContentTypes Methods mimeUnrender :: Proxy OctetStream -> ByteString0 -> Either String ByteString Source # mimeUnrenderWithType :: Proxy OctetStream -> MediaType -> ByteString0 -> Either String ByteString Source #
MimeUnrender OctetStream ByteString Source #	Right . id
Instance details Defined in Servant.API.ContentTypes Methods mimeUnrender :: Proxy OctetStream -> ByteString -> Either String ByteString Source # mimeUnrenderWithType :: Proxy OctetStream -> MediaType -> ByteString -> Either String ByteString Source #
MimeRender OctetStream ByteString Source #	`fromStrict`
Instance details Defined in Servant.API.ContentTypes Methods mimeRender :: Proxy OctetStream -> ByteString -> ByteString0 Source #
MimeRender OctetStream ByteString Source #	id
Instance details Defined in Servant.API.ContentTypes Methods mimeRender :: Proxy OctetStream -> ByteString -> ByteString Source #
MimeUnrender OctetStream a => MimeUnrender OctetStream ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeUnrender :: Proxy OctetStream -> ByteString -> Either String ( WithStatus _status a) Source # mimeUnrenderWithType :: Proxy OctetStream -> MediaType -> ByteString -> Either String ( WithStatus _status a) Source #
MimeRender OctetStream a => MimeRender OctetStream ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeRender :: Proxy OctetStream -> WithStatus _status a -> ByteString Source #

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")
:}

Minimal complete definition

contentType | contentTypes

Methods

contentType :: Proxy ctype -> MediaType Source #

contentTypes :: Proxy ctype -> NonEmpty MediaType Source #

Instances

Instances details

Accept OctetStream Source #	application/octet-stream
Instance details Defined in Servant.API.ContentTypes Methods contentType :: Proxy OctetStream -> MediaType Source # contentTypes :: Proxy OctetStream -> NonEmpty MediaType Source #
Accept FormUrlEncoded Source #	application/x-www-form-urlencoded
Instance details Defined in Servant.API.ContentTypes Methods contentType :: Proxy FormUrlEncoded -> MediaType Source # contentTypes :: Proxy FormUrlEncoded -> NonEmpty MediaType Source #
Accept PlainText Source #	text/plain;charset=utf-8
Instance details Defined in Servant.API.ContentTypes Methods contentType :: Proxy PlainText -> MediaType Source # contentTypes :: Proxy PlainText -> NonEmpty MediaType Source #
Accept JSON Source #	application/json
Instance details Defined in Servant.API.ContentTypes Methods contentType :: Proxy JSON -> MediaType Source # contentTypes :: Proxy JSON -> NonEmpty 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 a where
   mimeRender _ val = pack ("This is MINE! " ++ show val)

type MyAPI = "path" :> Get '[MyContentType] Int

Methods

mimeRender :: Proxy ctype -> a -> ByteString Source #

Instances

Instances details

MimeRender OctetStream ByteString Source #	`fromStrict`
Instance details Defined in Servant.API.ContentTypes Methods mimeRender :: Proxy OctetStream -> ByteString -> ByteString0 Source #
MimeRender OctetStream ByteString Source #	id
Instance details Defined in Servant.API.ContentTypes Methods mimeRender :: Proxy OctetStream -> ByteString -> ByteString Source #
ToForm a => MimeRender FormUrlEncoded a Source #	`urlEncodeAsForm` Note that the `mimeUnrender p (mimeRender p x) == Right x` law only holds if every element of x is non-null (i.e., not `("", "")` )
Instance details Defined in Servant.API.ContentTypes Methods mimeRender :: Proxy FormUrlEncoded -> a -> ByteString Source #
MimeRender PlainText String Source #	BC.pack
Instance details Defined in Servant.API.ContentTypes Methods mimeRender :: Proxy PlainText -> String -> ByteString Source #
MimeRender PlainText Text Source #	fromStrict . TextS.encodeUtf8
Instance details Defined in Servant.API.ContentTypes Methods mimeRender :: Proxy PlainText -> Text -> ByteString Source #
MimeRender PlainText Text Source #	`encodeUtf8`
Instance details Defined in Servant.API.ContentTypes Methods mimeRender :: Proxy PlainText -> Text -> ByteString Source #
ToJSON a => MimeRender JSON a Source #	`encode`
Instance details Defined in Servant.API.ContentTypes Methods mimeRender :: Proxy JSON -> a -> ByteString Source #
MimeRender OctetStream a => MimeRender OctetStream ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeRender :: Proxy OctetStream -> WithStatus _status a -> ByteString Source #
MimeRender FormUrlEncoded a => MimeRender FormUrlEncoded ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeRender :: Proxy FormUrlEncoded -> WithStatus _status a -> ByteString Source #
MimeRender PlainText a => MimeRender PlainText ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeRender :: Proxy PlainText -> WithStatus _status a -> ByteString Source #
MimeRender JSON a => MimeRender JSON ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeRender :: Proxy JSON -> WithStatus _status a -> ByteString 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

Minimal complete definition

mimeUnrender | mimeUnrenderWithType

Methods

mimeUnrender :: Proxy ctype -> ByteString -> Either String a Source #

mimeUnrenderWithType :: Proxy ctype -> MediaType -> ByteString -> Either String a Source #

Variant which is given the actual MediaType provided by the other party.

In the most cases you don't want to branch based on the MediaType . See pr552 for a motivating example.

Instances

Instances details

MimeUnrender OctetStream ByteString Source #	Right . toStrict
Instance details Defined in Servant.API.ContentTypes Methods mimeUnrender :: Proxy OctetStream -> ByteString0 -> Either String ByteString Source # mimeUnrenderWithType :: Proxy OctetStream -> MediaType -> ByteString0 -> Either String ByteString Source #
MimeUnrender OctetStream ByteString Source #	Right . id
Instance details Defined in Servant.API.ContentTypes Methods mimeUnrender :: Proxy OctetStream -> ByteString -> Either String ByteString Source # mimeUnrenderWithType :: Proxy OctetStream -> MediaType -> ByteString -> Either String ByteString Source #
FromForm a => MimeUnrender FormUrlEncoded a Source #	`urlDecodeAsForm` Note that the `mimeUnrender p (mimeRender p x) == Right x` law only holds if every element of x is non-null (i.e., not `("", "")` )
Instance details Defined in Servant.API.ContentTypes Methods mimeUnrender :: Proxy FormUrlEncoded -> ByteString -> Either String a Source # mimeUnrenderWithType :: Proxy FormUrlEncoded -> MediaType -> ByteString -> Either String a Source #
MimeUnrender PlainText String Source #	Right . BC.unpack
Instance details Defined in Servant.API.ContentTypes Methods mimeUnrender :: Proxy PlainText -> ByteString -> Either String String Source # mimeUnrenderWithType :: Proxy PlainText -> MediaType -> ByteString -> Either String String Source #
MimeUnrender PlainText Text Source #	left show . TextS.decodeUtf8' . toStrict
Instance details Defined in Servant.API.ContentTypes Methods mimeUnrender :: Proxy PlainText -> ByteString -> Either String Text Source # mimeUnrenderWithType :: Proxy PlainText -> MediaType -> ByteString -> Either String Text Source #
MimeUnrender PlainText Text Source #	left show . TextL.decodeUtf8'
Instance details Defined in Servant.API.ContentTypes Methods mimeUnrender :: Proxy PlainText -> ByteString -> Either String Text Source # mimeUnrenderWithType :: Proxy PlainText -> MediaType -> ByteString -> Either String Text Source #
FromJSON a => MimeUnrender JSON a Source #	`eitherDecode`
Instance details Defined in Servant.API.ContentTypes Methods mimeUnrender :: Proxy JSON -> ByteString -> Either String a Source # mimeUnrenderWithType :: Proxy JSON -> MediaType -> ByteString -> Either String a Source #
MimeUnrender OctetStream a => MimeUnrender OctetStream ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeUnrender :: Proxy OctetStream -> ByteString -> Either String ( WithStatus _status a) Source # mimeUnrenderWithType :: Proxy OctetStream -> MediaType -> ByteString -> Either String ( WithStatus _status a) Source #
MimeUnrender FormUrlEncoded a => MimeUnrender FormUrlEncoded ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeUnrender :: Proxy FormUrlEncoded -> ByteString -> Either String ( WithStatus _status a) Source # mimeUnrenderWithType :: Proxy FormUrlEncoded -> MediaType -> ByteString -> Either String ( WithStatus _status a) Source #
MimeUnrender PlainText a => MimeUnrender PlainText ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeUnrender :: Proxy PlainText -> ByteString -> Either String ( WithStatus _status a) Source # mimeUnrenderWithType :: Proxy PlainText -> MediaType -> ByteString -> Either String ( WithStatus _status a) Source #
MimeUnrender JSON a => MimeUnrender JSON ( WithStatus _status a) Source #
Instance details Defined in Servant.API.UVerb Methods mimeUnrender :: Proxy JSON -> ByteString -> Either String ( WithStatus _status a) Source # mimeUnrenderWithType :: Proxy JSON -> MediaType -> ByteString -> Either String ( WithStatus _status a) Source #

NoContent

data NoContent Source #

A type for responses without content-body.

Constructors

NoContent

Instances

Instances details

Eq NoContent Source #
Instance details Defined in Servant.API.ContentTypes Methods (==) :: NoContent -> NoContent -> Bool Source # (/=) :: NoContent -> NoContent -> Bool Source #
Read NoContent Source #
Instance details Defined in Servant.API.ContentTypes Methods readsPrec :: Int -> ReadS NoContent Source # readList :: ReadS [ NoContent ] Source # readPrec :: ReadPrec NoContent Source # readListPrec :: ReadPrec [ NoContent ] Source #
Show NoContent Source #
Instance details Defined in Servant.API.ContentTypes Methods showsPrec :: Int -> NoContent -> ShowS Source # show :: NoContent -> String Source # showList :: [ NoContent ] -> ShowS Source #
Generic NoContent Source #
Instance details Defined in Servant.API.ContentTypes Associated Types type Rep NoContent :: Type -> Type Source # Methods from :: NoContent -> Rep NoContent x Source # to :: Rep NoContent x -> NoContent Source #
NFData NoContent Source #
Instance details Defined in Servant.API.ContentTypes Methods rnf :: NoContent -> () Source #
HasStatus NoContent Source #	If an API can respond with `NoContent` we assume that this will happen with the status code 204 No Content. If this needs to be overridden, `WithStatus` can be used.
Instance details Defined in Servant.API.UVerb Associated Types type StatusOf NoContent :: Nat Source #
AllMime (ctyp ': (ctyp' ': ctyps)) => AllMimeRender (ctyp ': (ctyp' ': ctyps)) NoContent Source #
Instance details Defined in Servant.API.ContentTypes Methods allMimeRender :: Proxy (ctyp ': (ctyp' ': ctyps)) -> NoContent -> [( MediaType , ByteString )] Source #
Accept ctyp => AllMimeRender '[ctyp] NoContent Source #
Instance details Defined in Servant.API.ContentTypes Methods allMimeRender :: Proxy '[ctyp] -> NoContent -> [( MediaType , ByteString )] Source #
type Rep NoContent Source #
Instance details Defined in Servant.API.ContentTypes type Rep NoContent = D1 (' MetaData "NoContent" "Servant.API.ContentTypes" "servant-0.19.1-BZaZ2hTnOxc1hRbbpN6lAP" ' False ) ( C1 (' MetaCons "NoContent" ' PrefixI ' False ) ( U1 :: Type -> Type ))
type StatusOf NoContent Source #
Instance details Defined in Servant.API.UVerb type StatusOf NoContent = 204

Internal

newtype AcceptHeader Source #

Constructors

AcceptHeader ByteString

Instances

Instances details

Eq AcceptHeader Source #
Instance details Defined in Servant.API.ContentTypes Methods (==) :: AcceptHeader -> AcceptHeader -> Bool Source # (/=) :: AcceptHeader -> AcceptHeader -> Bool Source #
Read AcceptHeader Source #
Instance details Defined in Servant.API.ContentTypes Methods readsPrec :: Int -> ReadS AcceptHeader Source # readList :: ReadS [ AcceptHeader ] Source # readPrec :: ReadPrec AcceptHeader Source # readListPrec :: ReadPrec [ AcceptHeader ] Source #
Show AcceptHeader Source #
Instance details Defined in Servant.API.ContentTypes Methods showsPrec :: Int -> AcceptHeader -> ShowS Source # show :: AcceptHeader -> String Source # showList :: [ AcceptHeader ] -> ShowS Source #
Generic AcceptHeader Source #
Instance details Defined in Servant.API.ContentTypes Associated Types type Rep AcceptHeader :: Type -> Type Source # Methods from :: AcceptHeader -> Rep AcceptHeader x Source # to :: Rep AcceptHeader x -> AcceptHeader Source #
type Rep AcceptHeader Source #
Instance details Defined in Servant.API.ContentTypes type Rep AcceptHeader = D1 (' MetaData "AcceptHeader" "Servant.API.ContentTypes" "servant-0.19.1-BZaZ2hTnOxc1hRbbpN6lAP" ' True ) ( C1 (' MetaCons "AcceptHeader" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ByteString )))

class AllMime list => AllCTRender (list :: [*]) a where Source #

Methods

handleAcceptH :: Proxy list -> AcceptHeader -> a -> Maybe ( ByteString , ByteString ) Source #

Instances

Instances details

( TypeError (' Text "No instance for (), use NoContent instead.") :: Constraint ) => AllCTRender ('[] :: [ Type ]) () Source #
Instance details Defined in Servant.API.ContentTypes Methods handleAcceptH :: Proxy '[] -> AcceptHeader -> () -> Maybe ( ByteString , ByteString ) Source #
( Accept ct, AllMime cts, AllMimeRender (ct ': cts) a) => AllCTRender (ct ': cts) a Source #
Instance details Defined in Servant.API.ContentTypes Methods handleAcceptH :: Proxy (ct ': cts) -> AcceptHeader -> a -> Maybe ( ByteString , ByteString ) Source #

class AllCTUnrender (list :: [*]) a where Source #

Minimal complete definition

canHandleCTypeH

Methods

canHandleCTypeH :: Proxy list -> ByteString -> Maybe ( ByteString -> Either String a) Source #

handleCTypeH :: Proxy list -> ByteString -> ByteString -> Maybe ( Either String a) Source #

Instances

Instances details

AllMimeUnrender ctyps a => AllCTUnrender ctyps a Source #
Instance details Defined in Servant.API.ContentTypes Methods canHandleCTypeH :: Proxy ctyps -> ByteString -> Maybe ( ByteString -> Either String a) Source # handleCTypeH :: Proxy ctyps -> ByteString -> ByteString -> Maybe ( Either String a) Source #

class AllMime (list :: [*]) where Source #

Methods

allMime :: Proxy list -> [ MediaType ] Source #

Instances

Instances details

AllMime ('[] :: [ Type ]) Source #
Instance details Defined in Servant.API.ContentTypes Methods allMime :: Proxy '[] -> [ MediaType ] Source #
( Accept ctyp, AllMime ctyps) => AllMime (ctyp ': ctyps) Source #
Instance details Defined in Servant.API.ContentTypes Methods allMime :: Proxy (ctyp ': ctyps) -> [ MediaType ] Source #

class AllMime list => AllMimeRender (list :: [*]) a where Source #

Methods

allMimeRender :: Proxy list -> a -> [( MediaType , ByteString )] Source #

Instances

Instances details

AllMime (ctyp ': (ctyp' ': ctyps)) => AllMimeRender (ctyp ': (ctyp' ': ctyps)) NoContent Source #
Instance details Defined in Servant.API.ContentTypes Methods allMimeRender :: Proxy (ctyp ': (ctyp' ': ctyps)) -> NoContent -> [( MediaType , ByteString )] Source #
Accept ctyp => AllMimeRender '[ctyp] NoContent Source #
Instance details Defined in Servant.API.ContentTypes Methods allMimeRender :: Proxy '[ctyp] -> NoContent -> [( MediaType , ByteString )] Source #
( MimeRender ctyp a, AllMimeRender (ctyp' ': ctyps) a) => AllMimeRender (ctyp ': (ctyp' ': ctyps)) a Source #
Instance details Defined in Servant.API.ContentTypes Methods allMimeRender :: Proxy (ctyp ': (ctyp' ': ctyps)) -> a -> [( MediaType , ByteString )] Source #
MimeRender ctyp a => AllMimeRender '[ctyp] a Source #
Instance details Defined in Servant.API.ContentTypes Methods allMimeRender :: Proxy '[ctyp] -> a -> [( MediaType , ByteString )] Source #

class AllMime list => AllMimeUnrender (list :: [*]) a where Source #

Methods

allMimeUnrender :: Proxy list -> [( MediaType , ByteString -> Either String a)] Source #

Instances

Instances details

AllMimeUnrender ('[] :: [ Type ]) a Source #
Instance details Defined in Servant.API.ContentTypes Methods allMimeUnrender :: Proxy '[] -> [( MediaType , ByteString -> Either String a)] Source #
( MimeUnrender ctyp a, AllMimeUnrender ctyps a) => AllMimeUnrender (ctyp ': ctyps) a Source #
Instance details Defined in Servant.API.ContentTypes Methods allMimeUnrender :: Proxy (ctyp ': ctyps) -> [( MediaType , ByteString -> Either String a)] Source #

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 Int
Right 1

>>> eitherDecodeLenient "1 junk" :: Either String Int
Left "trailing junk after valid JSON: endOfInput"

canHandleAcceptH :: AllMime list => Proxy list -> AcceptHeader -> Bool Source #