Safe Haskell	Safe-Inferred
Language	Haskell2010

Unison.Util.Servant.CBOR

Description

Servant configuration for the CBOR media type

Adapted from https://hackage.haskell.org/package/servant-serialization-0.3/docs/Servant-API-ContentTypes-SerialiseCBOR.html via MIT license

Synopsis

data CBOR
type UnknownCBORBytes = CBORBytes Unknown
newtype CBORBytes t = CBORBytes ByteString
newtype CBORStream a = CBORStream ByteString
deserialiseOrFailCBORBytes :: Serialise t => CBORBytes t -> Either DeserialiseFailure t
serialiseCBORBytes :: Serialise t => t -> CBORBytes t
decodeCBORBytes :: Serialise t => CBORBytes t -> Decoder s t
decodeUnknownCBORBytes :: Serialise t => UnknownCBORBytes -> Decoder s t
serialiseUnknownCBORBytes :: Serialise t => t -> UnknownCBORBytes

Documentation

data CBOR Source #

Content-type for encoding and decoding objects as their CBOR representations

Instances

Instances details

Accept CBOR Source #	Mime-type for CBOR and additional ones using the word "hackage" and the name of the package "serialise".
Instance details Defined in Unison.Util.Servant.CBOR Methods contentType :: Proxy CBOR -> MediaType # contentTypes :: Proxy CBOR -> NonEmpty MediaType #
Serialise a => MimeRender CBOR a Source #	`>>>` `mimeRender (Proxy :: Proxy CBOR) ("Hello" :: String)`"eHello"
Instance details Defined in Unison.Util.Servant.CBOR Methods mimeRender :: Proxy CBOR -> a -> ByteString #
Serialise a => MimeUnrender CBOR a Source #	`>>>` `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"
Instance details Defined in Unison.Util.Servant.CBOR Methods mimeUnrender :: Proxy CBOR -> ByteString -> Either String a # mimeUnrenderWithType :: Proxy CBOR -> MediaType -> ByteString -> Either String a #

type UnknownCBORBytes = CBORBytes Unknown Source #

newtype CBORBytes t Source #

Wrapper for CBOR data that has already been serialized. In our case, we use this because we may load pre-serialized CBOR directly from the database, but it's also useful in allowing us to more quickly seek through a CBOR stream, since we only need to decode the CBOR when/if we actually need to use it, and can skip past it using a byte offset otherwise.

The t phantom type is the type of the data encoded in the bytestring.

Constructors

CBORBytes ByteString

Instances

Instances details

Show (CBORBytes t) Source #
Instance details Defined in Unison.Util.Servant.CBOR Methods showsPrec :: Int -> CBORBytes t -> ShowS # show :: CBORBytes t -> String # showList :: [CBORBytes t] -> ShowS #
Eq (CBORBytes t) Source #
Instance details Defined in Unison.Util.Servant.CBOR Methods (==) :: CBORBytes t -> CBORBytes t -> Bool # (/=) :: CBORBytes t -> CBORBytes t -> Bool #
Ord (CBORBytes t) Source #
Instance details Defined in Unison.Util.Servant.CBOR Methods compare :: CBORBytes t -> CBORBytes t -> Ordering # (<) :: CBORBytes t -> CBORBytes t -> Bool # (<=) :: CBORBytes t -> CBORBytes t -> Bool # (>) :: CBORBytes t -> CBORBytes t -> Bool # (>=) :: CBORBytes t -> CBORBytes t -> Bool # max :: CBORBytes t -> CBORBytes t -> CBORBytes t # min :: CBORBytes t -> CBORBytes t -> CBORBytes t #
Serialise (CBORBytes t) Source #
Instance details Defined in Unison.Util.Servant.CBOR Methods encode :: CBORBytes t -> Encoding # decode :: Decoder s (CBORBytes t) # encodeList :: [CBORBytes t] -> Encoding # decodeList :: Decoder s [CBORBytes t] #

newtype CBORStream a Source #

Wrapper for a stream of CBOR data. Each chunk may not be a complete CBOR value, but the concatenation of all the chunks is a valid CBOR stream.

Constructors

CBORStream ByteString

Instances

Instances details

MimeRender OctetStream (CBORStream a) Source #
Instance details Defined in Unison.Util.Servant.CBOR Methods mimeRender :: Proxy OctetStream -> CBORStream a -> ByteString #
MimeUnrender OctetStream (CBORStream a) Source #
Instance details Defined in Unison.Util.Servant.CBOR Methods mimeUnrender :: Proxy OctetStream -> ByteString -> Either String (CBORStream a) # mimeUnrenderWithType :: Proxy OctetStream -> MediaType -> ByteString -> Either String (CBORStream a) #
Show (CBORStream a) Source #
Instance details Defined in Unison.Util.Servant.CBOR Methods showsPrec :: Int -> CBORStream a -> ShowS # show :: CBORStream a -> String # showList :: [CBORStream a] -> ShowS #
Eq (CBORStream a) Source #
Instance details Defined in Unison.Util.Servant.CBOR Methods (==) :: CBORStream a -> CBORStream a -> Bool # (/=) :: CBORStream a -> CBORStream a -> Bool #
Ord (CBORStream a) Source #
Instance details Defined in Unison.Util.Servant.CBOR Methods compare :: CBORStream a -> CBORStream a -> Ordering # (<) :: CBORStream a -> CBORStream a -> Bool # (<=) :: CBORStream a -> CBORStream a -> Bool # (>) :: CBORStream a -> CBORStream a -> Bool # (>=) :: CBORStream a -> CBORStream a -> Bool # max :: CBORStream a -> CBORStream a -> CBORStream a # min :: CBORStream a -> CBORStream a -> CBORStream a #
Serialise (CBORStream a) Source #
Instance details Defined in Unison.Util.Servant.CBOR Methods encode :: CBORStream a -> Encoding # decode :: Decoder s (CBORStream a) # encodeList :: [CBORStream a] -> Encoding # decodeList :: Decoder s [CBORStream a] #

deserialiseOrFailCBORBytes :: Serialise t => CBORBytes t -> Either DeserialiseFailure t Source #

Deserialize a CBORBytes value into its tagged type, throwing an error if the deserialization fails.

serialiseCBORBytes :: Serialise t => t -> CBORBytes t Source #

decodeCBORBytes :: Serialise t => CBORBytes t -> Decoder s t Source #

decodeUnknownCBORBytes :: Serialise t => UnknownCBORBytes -> Decoder s t Source #

serialiseUnknownCBORBytes :: Serialise t => t -> UnknownCBORBytes Source #