Servant.API.ContentTypes.Cereal

Documentation

data CerealFmt

Content-type for instances of the Serialize class in the package "cereal". Trailing garbage is ignored.

Instances

Accept CerealFmt

Mime-type using the word "hackage" and the name of the package "cereal".

Defined in Servant.API.ContentTypes.Cereal

Methods

contentType :: Proxy CerealFmt -> MediaType

contentTypes :: Proxy CerealFmt -> NonEmpty MediaType

Serialize a => MimeRender CerealFmt a

>>> mimeRender (Proxy :: Proxy CerealFmt) (3.14 :: Float)
"@H\245\195"

Defined in Servant.API.ContentTypes.Cereal

Methods

mimeRender :: Proxy CerealFmt -> a -> ByteString

Serialize a => MimeUnrender CerealFmt a

>>> let bsl = mimeRender (Proxy :: Proxy CerealFmt) (3.14 :: Float)
>>> mimeUnrender (Proxy :: Proxy CerealFmt) bsl :: Either String Float
Right 3.14

>>> mimeUnrender (Proxy :: Proxy CerealFmt) (bsl <> "trailing garbage") :: Either String Float
Right 3.14

Cereal doesn't detect this preceding garbage.

>>> mimeUnrender (Proxy :: Proxy CerealFmt) ("preceding garbage" <> bsl) :: Either String Float
Right ...

>>> mimeUnrender (Proxy :: Proxy CerealFmt) "garbage" :: Either String (Float, Float)
Left "Data.Serialize.decodeLazy: too few bytes\nFrom:\tdemandInput\n\n"

Defined in Servant.API.ContentTypes.Cereal

Methods

mimeUnrender :: Proxy CerealFmt -> ByteString -> Either String a

mimeUnrenderWithType :: Proxy CerealFmt -> MediaType -> ByteString -> Either String a