Safe Haskell	None
Language	Haskell2010

Network.TypedProtocol.Stateful.Codec.CBOR

Synopsis

module Network.TypedProtocol.Stateful.Codec
data DeserialiseFailure
mkCodecCborLazyBS :: forall ps f (m :: Type -> Type). MonadST m => (forall (st :: ps) (st' :: ps). (StateTokenI st, ActiveState st) => f st' -> Message ps st st' -> Encoding) -> (forall (st :: ps) s. ActiveState st => StateToken st -> f st -> Decoder s (SomeMessage st)) -> Codec ps DeserialiseFailure f m ByteString
mkCodecCborStrictBS :: forall ps f (m :: Type -> Type). MonadST m => (forall (st :: ps) (st' :: ps). (StateTokenI st, ActiveState st) => f st' -> Message ps st st' -> Encoding) -> (forall (st :: ps) s. ActiveState st => StateToken st -> f st -> Decoder s (SomeMessage st)) -> Codec ps DeserialiseFailure f m ByteString

Documentation

module Network.TypedProtocol.Stateful.Codec

data DeserialiseFailure #

An exception type that may be returned (by pure functions) or thrown (by IO actions) that fail to deserialise a given input.

Since: cborg-0.2.0.0

Instances

Instances details

NFData DeserialiseFailure
Instance details Defined in Codec.CBOR.Read Methods rnf :: DeserialiseFailure -> () #
Exception DeserialiseFailure
Instance details Defined in Codec.CBOR.Read Methods toException :: DeserialiseFailure -> SomeException # fromException :: SomeException -> Maybe DeserialiseFailure # displayException :: DeserialiseFailure -> String # backtraceDesired :: DeserialiseFailure -> Bool #
Show DeserialiseFailure
Instance details Defined in Codec.CBOR.Read Methods showsPrec :: Int -> DeserialiseFailure -> ShowS # show :: DeserialiseFailure -> String # showList :: [DeserialiseFailure] -> ShowS #
Eq DeserialiseFailure
Instance details Defined in Codec.CBOR.Read Methods (==) :: DeserialiseFailure -> DeserialiseFailure -> Bool # (/=) :: DeserialiseFailure -> DeserialiseFailure -> Bool #

mkCodecCborLazyBS Source #

Arguments

:: forall ps f (m :: Type -> Type). MonadST m
=> (forall (st :: ps) (st' :: ps). (StateTokenI st, ActiveState st) => f st' -> Message ps st st' -> Encoding)	cbor encoder
-> (forall (st :: ps) s. ActiveState st => StateToken st -> f st -> Decoder s (SomeMessage st))	cbor decoder
-> Codec ps DeserialiseFailure f m ByteString

Construct a Codec for a CBOR based serialisation format, using lazy ByteStrings.

This is an adaptor between the cborg library and the Codec abstraction.

It takes encode and decode functions for the protocol messages that use the CBOR library encoder and decoder.

mkCodecCborStrictBS Source #

Arguments

:: forall ps f (m :: Type -> Type). MonadST m
=> (forall (st :: ps) (st' :: ps). (StateTokenI st, ActiveState st) => f st' -> Message ps st st' -> Encoding)	cbor encoder
-> (forall (st :: ps) s. ActiveState st => StateToken st -> f st -> Decoder s (SomeMessage st))	cbor decoder
-> Codec ps DeserialiseFailure f m ByteString

Construct a Codec for a CBOR based serialisation format, using strict ByteStrings.

This is an adaptor between the cborg library and the Codec abstraction.

It takes encode and decode functions for the protocol messages that use the CBOR library encoder and decoder.

Note that this is less efficient than the mkCodecCborLazyBS variant because it has to copy and concatenate the result of the encoder (which natively produces chunks).