Massiv.Persist

This package provides instances for Persist class for all mutable Array representations in massiv package. These instances are provided as orphans from a separate package in order to avoid direct dependency on persist package in massiv.

Array elements are serialized in little endian order, which is consistent with the rest of the instances in persist package.

Below is a simple example how to use it. Note a blank module import: import Massiv.Persist (), which is the only thing needed from this module in order to use provided orphan instances.

>>> import Massiv.Persist ()
>>> import Data.Massiv.Array as A
>>> import Data.Int (Int8)
>>> let arr = A.fromList A.Seq [72,97,115,107,101,108,108] :: A.Vector A.P Int8
>>> encode arr
"\NUL\a\NUL\NUL\NUL\NUL\NUL\NUL\NULHaskell"
>>> Right arr' = decode (encode arr) :: Either String (A.Vector A.P Int8)
>>> arr'
Array P Seq (Sz1 7)
  [ 72, 97, 115, 107, 101, 108, 108 ]

Helper functions used to define Persist instances

putIx :: forall ix. Index ix => ix -> Put ()

Encode index

Since: 0.1.0

getIx :: forall ix. Index ix => Get ix

Decode index

Since: 0.1.0

mkSzFail :: forall ix m. (Index ix, MonadFail m) => ix -> m (Sz ix)

Construct size from index verifying its correctness.

Since: 0.1.0

putArray :: (Manifest r ix e, Persist e) => Array r ix e -> Put ()

Serialize array as LittleEndian

Since: 0.1.0

getArray :: (Mutable r ix e, Persist e) => Get (Array r ix e)

Deserialize array from binary form in LittleEndian

Since: 0.1.0

putPrimArray :: forall ix e. (Index ix, Prim e, Persist e) => Array P ix e -> Put ()

Serialize primitive array in LittleEndian order

Since: 0.1.0

getPrimArray :: forall ix e. (Index ix, Prim e, Persist e) => Get (Array P ix e)

Deserialize primitive array in LittleEndian order

Since: 0.1.0

putStorableArray :: forall ix e. (Index ix, Storable e, Persist e) => Array S ix e -> Put ()

Serialize storable array in LittleEndian order

Since: 0.1.0

getStorableArray :: forall ix e. (Index ix, Storable e, Persist e) => Get (Array S ix e)

Deserialize storable array in LittleEndian order

Since: 0.1.0

Orphan instances

Persist Ix2

Methods

put :: Ix2 -> Put ()

get :: Get Ix2

Persist Comp

Methods

put :: Comp -> Put ()

get :: Get Comp

Index (IxN n) => Persist (IxN n)

Methods

put :: IxN n -> Put ()

get :: Get (IxN n)

Index ix => Persist (Sz ix)

Methods

put :: Sz ix -> Put ()

get :: Get (Sz ix)

(Index ix, Persist e) => Persist (Array B ix e)

Methods

put :: Array B ix e -> Put ()

get :: Get (Array B ix e)

(Index ix, NFData e, Persist e) => Persist (Array N ix e)

Methods

put :: Array N ix e -> Put ()

get :: Get (Array N ix e)

(Index ix, Storable e, Persist e) => Persist (Array S ix e)

Methods

put :: Array S ix e -> Put ()

get :: Get (Array S ix e)

(Index ix, Prim e, Persist e) => Persist (Array P ix e)

Methods

put :: Array P ix e -> Put ()

get :: Get (Array P ix e)

(Index ix, Unbox e, Persist e) => Persist (Array U ix e)

Methods

put :: Array U ix e -> Put ()

get :: Get (Array U ix e)