CerealPlus.Deserialize

A monad-transformer over Data.Serialize.Get.

Documentation

data Deserialize m a

A deserialization monad transformer.

Instances

MFunctor Deserialize

MonadTrans Deserialize

Monad m => Monad (Deserialize m)

Monad m => Functor (Deserialize m)

Monad m => Applicative (Deserialize m)

MonadIO m => MonadIO (Deserialize m)

runPartial :: Deserialize m a -> ByteString -> m (Result m a)

Run on a chunk of data and get a partial result.

data Result m a

A partial result of deserialization.

Constructors

Fail Text ByteString

A message describing the deserialization failure and a remaining chunk.

Partial (ByteString -> m (Result m a))

A continuation function, which should be supplied with the next chunk.

Done a ByteString

A deserialized data structure and a remaining chunk.

Instances

MFunctor Result

liftGet :: Monad m => Get a -> Deserialize m a

Run a Get action of the "cereal" library.

throwError :: Monad m => Text -> Deserialize m a

Fail with a message.

Since there's no consensus on how to implement catchError of MonadError, we'll go with just this function.

It is not implemented as fail because fail is pure evil.