Data.Columbia.CompoundData

Serialization of compound data types (with class!). Also read and write methods' type class contexts are implemented with heterogeneous list constraints, making them sufficiently abstract. For every context FooCtx that a program uses, one has a constraint HasField ctx FooCtx, that allows one to find the context evidence in the concrete context.

The recursive function that is generally needed to traverse an inductive data type instance is implemented in readOneLayer. A bare-bones reader function is then let r = readOneLayer proxy r in r. A poly-traversal is a function that is inserted into this recursive call chain. For instance, cycReadCompoundData is a poly-traversal implementing cycle detection for circular data dependencies, but it leaves the programmer free to determine exactly how the layers are to be read. The types of poly-traversals are found in PolyTraversal and PolyTraversalW.

Technically, the type of poly-traversals encompasses all co-recursive definitions at that type. Well-founded recursion cannot be guaranteed owing to the cyclical nature of data structures. If one needs recursion to be well-founded, one can use cycReadCompoundData -- the well-foundedness then follows from the finitude of the addresses.

Documentation

module Data.Columbia.SeekableStream

module Data.Columbia.SeekableWriter

module Data.Generics.SYB.WithClass.Instances

module Data.Columbia.SeekableStream

module Data.Columbia.SeekableWriter

class Typeable t => RW t where

The RW class describes operations that can locate entities in a stream by seeking, and also read and write primitive types.

Methods

readData :: Monad m => ReaderT (SeekableStream m Word8) m t

writeData :: Monad m => t -> ReaderT (SeekableWriter m Word8) m ()

Instances

RW Bool

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Bool

writeData :: Monad m => Bool -> ReaderT * (SeekableWriter m Word8) m ()

RW Char

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Char

writeData :: Monad m => Char -> ReaderT * (SeekableWriter m Word8) m ()

RW Float

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Float

writeData :: Monad m => Float -> ReaderT * (SeekableWriter m Word8) m ()

RW Int

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Int

writeData :: Monad m => Int -> ReaderT * (SeekableWriter m Word8) m ()

RW Int8

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Int8

writeData :: Monad m => Int8 -> ReaderT * (SeekableWriter m Word8) m ()

RW Int16

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Int16

writeData :: Monad m => Int16 -> ReaderT * (SeekableWriter m Word8) m ()

RW Int32

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Int32

writeData :: Monad m => Int32 -> ReaderT * (SeekableWriter m Word8) m ()

RW Ordering

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Ordering

writeData :: Monad m => Ordering -> ReaderT * (SeekableWriter m Word8) m ()

RW Word

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Word

writeData :: Monad m => Word -> ReaderT * (SeekableWriter m Word8) m ()

RW Word8

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Word8

writeData :: Monad m => Word8 -> ReaderT * (SeekableWriter m Word8) m ()

RW Word16

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Word16

writeData :: Monad m => Word16 -> ReaderT * (SeekableWriter m Word8) m ()

RW Word32

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Word32

writeData :: Monad m => Word32 -> ReaderT * (SeekableWriter m Word8) m ()

RW ()

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m ()

writeData :: Monad m => () -> ReaderT * (SeekableWriter m Word8) m ()

Typeable * t => RW [t]

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m [t]

writeData :: Monad m => [t] -> ReaderT * (SeekableWriter m Word8) m ()

Typeable * t => RW (Maybe t)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (Maybe t)

writeData :: Monad m => Maybe t -> ReaderT * (SeekableWriter m Word8) m ()

Typeable * t => RW (Set t)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (Set t)

writeData :: Monad m => Set t -> ReaderT * (SeekableWriter m Word8) m ()

Typeable1 f => RW (LazyFix f)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (LazyFix f)

writeData :: Monad m => LazyFix f -> ReaderT * (SeekableWriter m Word8) m ()

Typeable * t => RW (WithAddress t)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (WithAddress t)

writeData :: Monad m => WithAddress t -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * t, Typeable * u) => RW (Either t u)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (Either t u)

writeData :: Monad m => Either t u -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * t, Typeable * u) => RW (t, u)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (t, u)

writeData :: Monad m => (t, u) -> ReaderT * (SeekableWriter m Word8) m ()

RW (UArray Int32 Int8)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (UArray Int32 Int8)

writeData :: Monad m => UArray Int32 Int8 -> ReaderT * (SeekableWriter m Word8) m ()

RW (UArray Int32 Int16)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (UArray Int32 Int16)

writeData :: Monad m => UArray Int32 Int16 -> ReaderT * (SeekableWriter m Word8) m ()

RW (UArray Int32 Int32)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (UArray Int32 Int32)

writeData :: Monad m => UArray Int32 Int32 -> ReaderT * (SeekableWriter m Word8) m ()

RW (UArray Int32 Word8)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (UArray Int32 Word8)

writeData :: Monad m => UArray Int32 Word8 -> ReaderT * (SeekableWriter m Word8) m ()

RW (UArray Int32 Word16)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (UArray Int32 Word16)

writeData :: Monad m => UArray Int32 Word16 -> ReaderT * (SeekableWriter m Word8) m ()

RW (UArray Int32 Word32)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (UArray Int32 Word32)

writeData :: Monad m => UArray Int32 Word32 -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * i, Typeable * t) => RW (Array i t)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (Array i t)

writeData :: Monad m => Array i t -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * t, Typeable * u) => RW (Map t u)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (Map t u)

writeData :: Monad m => Map t u -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * k, Typeable * v) => RW (Pair k v)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (Pair k v)

writeData :: Monad m => Pair k v -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * t, Typeable * u, Typeable * v) => RW (t, u, v)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (t, u, v)

writeData :: Monad m => (t, u, v) -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * t, Typeable * u, Typeable * v, Typeable * w) => RW (t, u, v, w)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (t, u, v, w)

writeData :: Monad m => (t, u, v, w) -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * t, Typeable * u, Typeable * v, Typeable * w, Typeable * x) => RW (t, u, v, w, x)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (t, u, v, w, x)

writeData :: Monad m => (t, u, v, w, x) -> ReaderT * (SeekableWriter m Word8) m ()

data RWCtx a

Constructors

RW a => RWCtx

Instances

RW t => Sat (RWCtx t)

Methods

dict :: RWCtx t

Strategy/traversal combinators

(#.) :: Data ctx t => PolyTraversal ctx m t -> (forall t2. Data ctx t2 => PolyTraversal ctx m t2) -> PolyTraversal ctx m t infixl 9

(##.) :: Data ctx t => PolyTraversalW ctx m t -> (forall t2. Data ctx t2 => PolyTraversalW ctx m t2) -> PolyTraversalW ctx m t infixl 9

fixT :: Data ctx t => Proxy ctx -> (forall t2. Data ctx t2 => PolyTraversal ctx m t2) -> ReaderT (SeekableStream m Word8) m t

fixTW :: Data ctx t => Proxy ctx -> (forall t2. Data ctx t2 => PolyTraversalW ctx m t2) -> t -> ReaderT (SeekableWriter m Word8) m Word32

typeCoerce :: (Typeable t, Data ctx t2) => PolyTraversal ctx m t -> (forall t3. Data ctx t3 => PolyTraversal ctx m t3) -> PolyTraversal ctx m t2

Try to cast from the first traversal; if that fails, use the second traversal.

Compound data read/write strategies

class Typeable t => RW t where

The RW class describes operations that can locate entities in a stream by seeking, and also read and write primitive types.

Methods

readData :: Monad m => ReaderT (SeekableStream m Word8) m t

writeData :: Monad m => t -> ReaderT (SeekableWriter m Word8) m ()

Instances

RW Bool

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Bool

writeData :: Monad m => Bool -> ReaderT * (SeekableWriter m Word8) m ()

RW Char

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Char

writeData :: Monad m => Char -> ReaderT * (SeekableWriter m Word8) m ()

RW Float

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Float

writeData :: Monad m => Float -> ReaderT * (SeekableWriter m Word8) m ()

RW Int

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Int

writeData :: Monad m => Int -> ReaderT * (SeekableWriter m Word8) m ()

RW Int8

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Int8

writeData :: Monad m => Int8 -> ReaderT * (SeekableWriter m Word8) m ()

RW Int16

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Int16

writeData :: Monad m => Int16 -> ReaderT * (SeekableWriter m Word8) m ()

RW Int32

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Int32

writeData :: Monad m => Int32 -> ReaderT * (SeekableWriter m Word8) m ()

RW Ordering

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Ordering

writeData :: Monad m => Ordering -> ReaderT * (SeekableWriter m Word8) m ()

RW Word

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Word

writeData :: Monad m => Word -> ReaderT * (SeekableWriter m Word8) m ()

RW Word8

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Word8

writeData :: Monad m => Word8 -> ReaderT * (SeekableWriter m Word8) m ()

RW Word16

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Word16

writeData :: Monad m => Word16 -> ReaderT * (SeekableWriter m Word8) m ()

RW Word32

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m Word32

writeData :: Monad m => Word32 -> ReaderT * (SeekableWriter m Word8) m ()

RW ()

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m ()

writeData :: Monad m => () -> ReaderT * (SeekableWriter m Word8) m ()

Typeable * t => RW [t]

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m [t]

writeData :: Monad m => [t] -> ReaderT * (SeekableWriter m Word8) m ()

Typeable * t => RW (Maybe t)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (Maybe t)

writeData :: Monad m => Maybe t -> ReaderT * (SeekableWriter m Word8) m ()

Typeable * t => RW (Set t)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (Set t)

writeData :: Monad m => Set t -> ReaderT * (SeekableWriter m Word8) m ()

Typeable1 f => RW (LazyFix f)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (LazyFix f)

writeData :: Monad m => LazyFix f -> ReaderT * (SeekableWriter m Word8) m ()

Typeable * t => RW (WithAddress t)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (WithAddress t)

writeData :: Monad m => WithAddress t -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * t, Typeable * u) => RW (Either t u)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (Either t u)

writeData :: Monad m => Either t u -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * t, Typeable * u) => RW (t, u)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (t, u)

writeData :: Monad m => (t, u) -> ReaderT * (SeekableWriter m Word8) m ()

RW (UArray Int32 Int8)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (UArray Int32 Int8)

writeData :: Monad m => UArray Int32 Int8 -> ReaderT * (SeekableWriter m Word8) m ()

RW (UArray Int32 Int16)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (UArray Int32 Int16)

writeData :: Monad m => UArray Int32 Int16 -> ReaderT * (SeekableWriter m Word8) m ()

RW (UArray Int32 Int32)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (UArray Int32 Int32)

writeData :: Monad m => UArray Int32 Int32 -> ReaderT * (SeekableWriter m Word8) m ()

RW (UArray Int32 Word8)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (UArray Int32 Word8)

writeData :: Monad m => UArray Int32 Word8 -> ReaderT * (SeekableWriter m Word8) m ()

RW (UArray Int32 Word16)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (UArray Int32 Word16)

writeData :: Monad m => UArray Int32 Word16 -> ReaderT * (SeekableWriter m Word8) m ()

RW (UArray Int32 Word32)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (UArray Int32 Word32)

writeData :: Monad m => UArray Int32 Word32 -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * i, Typeable * t) => RW (Array i t)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (Array i t)

writeData :: Monad m => Array i t -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * t, Typeable * u) => RW (Map t u)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (Map t u)

writeData :: Monad m => Map t u -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * k, Typeable * v) => RW (Pair k v)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (Pair k v)

writeData :: Monad m => Pair k v -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * t, Typeable * u, Typeable * v) => RW (t, u, v)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (t, u, v)

writeData :: Monad m => (t, u, v) -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * t, Typeable * u, Typeable * v, Typeable * w) => RW (t, u, v, w)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (t, u, v, w)

writeData :: Monad m => (t, u, v, w) -> ReaderT * (SeekableWriter m Word8) m ()

(Typeable * t, Typeable * u, Typeable * v, Typeable * w, Typeable * x) => RW (t, u, v, w, x)

Methods

readData :: Monad m => ReaderT * (SeekableStream m Word8) m (t, u, v, w, x)

writeData :: Monad m => (t, u, v, w, x) -> ReaderT * (SeekableWriter m Word8) m ()

data RWCtx a

Constructors

RW a => RWCtx

Instances

RW t => Sat (RWCtx t)

Methods

dict :: RWCtx t

type PolyTraversal ctx m d = Proxy ctx -> (forall a. Data ctx a => ReaderT (SeekableStream m Word8) m a) -> ReaderT (SeekableStream m Word8) m d

A PolyTraversal is a reader method over a data type, parameterized over a method to read components. Think: the targets have wide appeal, making it easy to find a buyer.

readOneLayer :: forall ctx m d. (Monad m, HasField ctx RWCtx, Data ctx d) => PolyTraversal ctx m d

Function returns something PolyTraversal. We can use this to examine the top layer of a data structure, then seek to and read some of its components.

type PolyTraversalW ctx m d = Proxy ctx -> (forall a. Data ctx a => a -> ReaderT (SeekableWriter m Word8) m Word32) -> d -> ReaderT (SeekableWriter m Word8) m Word32

writeOneLayer :: forall ctx m d. (Monad m, HasField ctx RWCtx, Data ctx d) => PolyTraversalW ctx m d

Writes the top layer of a data structure, and sells each of the sub-targets in turn.

seekToField :: forall m. Monad m => Int -> ReaderT (SeekableStream m Word8) m ()