Util.Binary

Library for converting types to and from binary, so that they can be written to and from files, stored compactly in memory, and so on.

This is a preliminary version of the library, hence I have decided not to optimise heavily, beyond putting in strictness annotations in where they seem appropriate.

A good place to start optimising would probably be the separate Bytes libary.

See also BinaryInstances, which declares instances for the standard types (and one or two others), BinaryUtils, which contains (mostly) material for declaring new instances, BinaryExtras, which contains other miscellaneous utilities, and finally BinaryAll which just imports and reexports everything.

Documentation

hWrite :: HasBinary a IO => Handle -> a -> IO ()

Write an (a) to a Handle

hRead :: HasBinary a IO => Handle -> IO a

Read an (a) from a Handle

writeToBytes :: HasBinary a StateBinArea => a -> IO (Bytes, Int)

Write an (a) to memory. The Int is the length of the area.

writeToBytes0 :: HasBinary a StateBinArea => Int -> a -> IO (Bytes, Int)

Write an (a) to memory. The integer argument is an initial guess at the number of bytes that will be needed. This should be greater than 0. If it is too small, there will be unnecessary reallocations; if too large, too much memory will be used.

readFromBytes :: HasBinary a StateBinArea => (Bytes, Int) -> IO a

Read a value from binary data in memory. The Int is the length, and there will be an error if this is either too small or too large.

class HasBinary a m where

Minimal complete definition

writeBin, readBin

Methods

writeBin

Arguments

:: WriteBinary m

-> a

-> m ()

Given a consumer of binary data, and an (a), write out the (a)

readBin

Arguments

:: ReadBinary m

-> m a

Given a source of binary data, provide an (a)

Instances

Monad m => HasBinary Bool m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> Bool -> m ()

readBin :: ReadBinary m -> m Bool

Monad m => HasBinary Char m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> Char -> m ()

readBin :: ReadBinary m -> m Char

Monad m => HasBinary Int m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> Int -> m ()

readBin :: ReadBinary m -> m Int

Monad m => HasBinary Int32 m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> Int32 -> m ()

readBin :: ReadBinary m -> m Int32

Monad m => HasBinary Integer m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> Integer -> m ()

readBin :: ReadBinary m -> m Integer

Monad m => HasBinary Word m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> Word -> m ()

readBin :: ReadBinary m -> m Word

Monad m => HasBinary Word32 m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> Word32 -> m ()

readBin :: ReadBinary m -> m Word32

Monad m => HasBinary () m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> () -> m ()

readBin :: ReadBinary m -> m ()

Monad m => HasBinary CSize m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> CSize -> m ()

readBin :: ReadBinary m -> m CSize

Monad m => HasBinary ClockTime m

Defined in Util.BinaryExtras

Methods

writeBin :: WriteBinary m -> ClockTime -> m ()

readBin :: ReadBinary m -> m ClockTime

HasBinary Byte m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> Byte -> m ()

readBin :: ReadBinary m -> m Byte

MonadIO m => HasBinary ICStringLen m

Defined in Util.ICStringLen

Methods

writeBin :: WriteBinary m -> ICStringLen -> m ()

readBin :: ReadBinary m -> m ICStringLen

(Monad m, HasBinary a m) => HasBinary [a] m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> [a] -> m ()

readBin :: ReadBinary m -> m [a]

(Monad m, HasBinary a m) => HasBinary (Maybe a) m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> Maybe a -> m ()

readBin :: ReadBinary m -> m (Maybe a)

HasBinary (WrapBinary m) m

Defined in Util.BinaryUtils

Methods

writeBin :: WriteBinary m -> WrapBinary m -> m ()

readBin :: ReadBinary m -> m (WrapBinary m)

(Monad m, Enum a) => HasBinary (ViaEnum a) m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> ViaEnum a -> m ()

readBin :: ReadBinary m -> m (ViaEnum a)

(Read a, Show a, Monad m) => HasBinary (ReadShow a) m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> ReadShow a -> m ()

readBin :: ReadBinary m -> m (ReadShow a)

(Monad m, HasWrapper wrapper m) => HasBinary (Wrapped wrapper) m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> Wrapped wrapper -> m ()

readBin :: ReadBinary m -> m (Wrapped wrapper)

(Monad m, Integral integral, Bits integral) => HasBinary (Unsigned integral) m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> Unsigned integral -> m ()

readBin :: ReadBinary m -> m (Unsigned integral)

(Monad m, StringClass a) => HasBinary (Str a) m

Defined in Util.AtomString

Methods

writeBin :: WriteBinary m -> Str a -> m ()

readBin :: ReadBinary m -> m (Str a)

(Monad m, HasBinary a m, HasBinary b m) => HasBinary (Either a b) m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> Either a b -> m ()

readBin :: ReadBinary m -> m (Either a b)

(Monad m, HasBinary v1 m, HasBinary v2 m) => HasBinary (v1, v2) m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> (v1, v2) -> m ()

readBin :: ReadBinary m -> m (v1, v2)

Monad m => HasBinary (Bytes, Int) m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> (Bytes, Int) -> m ()

readBin :: ReadBinary m -> m (Bytes, Int)

(HasBinary (from, to) m, Ord from, MonadIO m) => HasBinary (Registry from to) m

Defined in Util.Registry

Methods

writeBin :: WriteBinary m -> Registry from to -> m ()

readBin :: ReadBinary m -> m (Registry from to)

(Monad m, HasBinary v1 m, HasBinary (v2, v3) m) => HasBinary (v1, v2, v3) m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> (v1, v2, v3) -> m ()

readBin :: ReadBinary m -> m (v1, v2, v3)

(Monad m, HasBinary v1 m, HasBinary (v2, v3, v4) m) => HasBinary (v1, v2, v3, v4) m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> (v1, v2, v3, v4) -> m ()

readBin :: ReadBinary m -> m (v1, v2, v3, v4)

(Monad m, HasBinary v1 m, HasBinary (v2, v3, v4, v5) m) => HasBinary (v1, v2, v3, v4, v5) m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> (v1, v2, v3, v4, v5) -> m ()

readBin :: ReadBinary m -> m (v1, v2, v3, v4, v5)

(Monad m, HasBinary v1 m, HasBinary v2 m, HasBinary v3 m, HasBinary v4 m, HasBinary v5 m) => HasBinary (Choice5 v1 v2 v3 v4 v5) m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> Choice5 v1 v2 v3 v4 v5 -> m ()

readBin :: ReadBinary m -> m (Choice5 v1 v2 v3 v4 v5)

(Monad m, HasBinary v1 m, HasBinary (v2, v3, v4, v5, v6) m) => HasBinary (v1, v2, v3, v4, v5, v6) m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> (v1, v2, v3, v4, v5, v6) -> m ()

readBin :: ReadBinary m -> m (v1, v2, v3, v4, v5, v6)

(Monad m, HasBinary v1 m, HasBinary (v2, v3, v4, v5, v6, v7) m) => HasBinary (v1, v2, v3, v4, v5, v6, v7) m

Defined in Util.BinaryInstances

Methods

writeBin :: WriteBinary m -> (v1, v2, v3, v4, v5, v6, v7) -> m ()

readBin :: ReadBinary m -> m (v1, v2, v3, v4, v5, v6, v7)

data WriteBinary m

A consumer of binary data

Constructors

WriteBinary

Fields

• writeByte :: Byte -> m ()

  write one byte

• writeBytes :: Bytes -> Int -> m ()

  write multiple bytes

data ReadBinary m

A source of binary data

Constructors

ReadBinary

Fields

• readByte :: m Byte

  read one byte

• readBytes :: Int -> m Bytes

  read multiple bytes

toWriteBinaryHandle :: Handle -> WriteBinary IO

toReadBinaryHandle :: Handle -> ReadBinary IO

data BinArea

Somewhere to where you write binary data in memory.

type StateBinArea = StateT BinArea IO

a state monad containing the BinArea.

mkEmptyBinArea :: Int -> IO BinArea

Create an empty BinArea, given the initial size.

writeBinaryBinArea :: WriteBinary StateBinArea

A BinArea as somewhere to put binary data.

closeBinArea :: BinArea -> IO (Bytes, Int)

Return all the data currently in the BinArea

mkBinArea :: (Bytes, Int) -> BinArea

Turn binary data in memory into a BinArea (so that you can read from it).

readBinaryBinArea :: ReadBinary StateBinArea

A BinArea as a source of binary data.

checkFullBinArea :: BinArea -> IO ()

liftWriteBinary :: (forall a. m a -> n a) -> WriteBinary m -> WriteBinary n

Transform the monad used by a WriteBinary

liftReadBinary :: (forall a. m a -> n a) -> ReadBinary m -> ReadBinary n

Transform the monad used by a ReadBinary