Data.MemPack

Monad that is used for serializing data into a MutableByteArray. It is based on StateT that tracks the current index into the MutableByteArray where next write is expected to happen.

Monad that is used for deserializing data from a memory Buffer. It is based on StateT that tracks the current index into the Buffer a, from where the next read suppose to happen. Unpacking can fail with MonadFail instance or with failUnpack that provides a more type safe way of failing using Error interface.

Efficient serialization interface that operates directly on memory buffers.

Serialize a type into an unpinned ByteArray

Examples

>>> :set -XTypeApplications>>> unpack @[Int] $ pack ([1,2,3,4,5] :: [Int])Right [1,2,3,4,5]

Serialize a type into any Buffer

prop> pack xs == packBuffer xs

prop> packByteString xs == packBuffer xs

Examples

>>> :set -XTypeApplications>>> import qualified Data.Vector.Primitive as VP>>> import Data.Word (Word8)>>> unpack @[Int] $ packBuffer @[Int] @(VP.Vector Word8) [1,2,3,4,5]Right [1,2,3,4,5]

Serialize a type into a pinned ByteString

Serialize a type into an unpinned ShortByteString

Unpack a memory Buffer into a type using its MemPack instance. Besides potential unpacking failures due to a malformed buffer it will also fail the supplied Buffer was not fully consumed. Use unpackLeftOver, whenever a partially consumed buffer is possible.

Same as unpack except fails in a Fail monad, instead of Either.

Same as unpackFail except fails in any MonadFail, instead of Fail.

Same as unpack except throws a runtime exception upon a failure

Unpack a memory Buffer into a type using its MemPack instance. Besides the unpacked type it also returns an index into a buffer where unpacked has stopped.

Variable length encoding for bounded types. This type of encoding will use less memory for small values, but for larger values it will consume more memory and will be slower during packing/unpacking.

This is a helper type useful for serializing number of elements in data structures. It uses VarLen underneath, since sizes of common data structures aren't too big. It also prevents negative values from being serialized and deserialized.

This is a helper type that is useful for creating MemPack instances for sum types.

Tail recursive version of replicateM

A state transformer monad parameterized by:

• s - The state.

• m - The inner monad.

The return function leaves the state unchanged, while >>= uses the final state of the first computation as the initial state of the second.

Fail monad transformer that plays well with MonadFail type class.