Servant.API.ContentTypes.SerialiseCBOR

Documentation

data CBOR

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

Instances

Accept CBOR

Mime-type for CBOR and additional ones using the word "hackage" and the name of the package "serialise".

Defined in Servant.API.ContentTypes.SerialiseCBOR

Methods

contentType :: Proxy CBOR -> MediaType

contentTypes :: Proxy CBOR -> NonEmpty MediaType

Serialise a => MimeRender CBOR a

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

Defined in Servant.API.ContentTypes.SerialiseCBOR

Methods

mimeRender :: Proxy CBOR -> a -> ByteString

Serialise a => MimeUnrender CBOR a

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

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

>>> mimeUnrender (Proxy :: Proxy CBOR) ("preceding garbage" <> bsl) :: Either String Float
Left "Codec.Serialise.deserialiseOrFail: expected float at byte-offset 0"

Defined in Servant.API.ContentTypes.SerialiseCBOR

Methods

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

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