Binrep.Put.Bytezap

Serialization using the bytezap library.

bytezap serializers ("pokes") work by writing bytes into a pointer, which is assumed to have _precisely_ the space required. The user must determine the post-serialize length before the fact. For that reason, this module requires that types to be serialized have a BLen instance. In general, we are happy about this, because a binrep type should always have an efficient and preferably simple BLen instance (and if not, it shouldn't be a binrep type).

Documentation

class Put a where

Methods

put :: a -> Poke

Instances

(TypeError ENoEmpty :: Constraint) => Put Void

Defined in Binrep.Put.Bytezap

Methods

put :: Void -> Poke

Put Int8

Defined in Binrep.Put.Bytezap

Methods

put :: Int8 -> Poke

Put Word8

Defined in Binrep.Put.Bytezap

Methods

put :: Word8 -> Poke

Put Poke

Fairly useless because Poke doesn't have a BLen instance.

Defined in Binrep.Put.Bytezap

Methods

put :: Poke -> Poke

Put Write

Defined in Binrep.Put.Bytezap

Methods

put :: Write -> Poke

Put ByteString

Defined in Binrep.Put.Bytezap

Methods

put :: ByteString -> Poke

Put ()

Unit type serializes to nothing. How zen.

Defined in Binrep.Put.Bytezap

Methods

put :: () -> Poke

Put a => Put (NullTerminated a)

Serialization of null-terminated data may be defined generally using the data's underlying serializer.

Defined in Binrep.Type.NullTerminated

Methods

put :: NullTerminated a -> Poke

Put a => Put (Thin a)

Defined in Binrep.Type.Thin

Methods

put :: Thin a -> Poke

Put a => Put (Binreply a)

Defined in Binrep.Via

Methods

put :: Binreply a -> Poke

Put a => Put [a]

Defined in Binrep.Put.Bytezap

Methods

put :: [a] -> Poke

(TypeError ENoSum :: Constraint) => Put (Either a b)

Defined in Binrep.Put.Bytezap

Methods

put :: Either a b -> Poke

Put (Endian 'BE Int16)

Defined in Binrep.Type.Int

Methods

put :: Endian 'BE Int16 -> Poke

Put (Endian 'BE Int32)

Defined in Binrep.Type.Int

Methods

put :: Endian 'BE Int32 -> Poke

Put (Endian 'BE Int64)

Defined in Binrep.Type.Int

Methods

put :: Endian 'BE Int64 -> Poke

Put (Endian 'BE Word16)

Defined in Binrep.Type.Int

Methods

put :: Endian 'BE Word16 -> Poke

Put (Endian 'BE Word32)

Defined in Binrep.Type.Int

Methods

put :: Endian 'BE Word32 -> Poke

Put (Endian 'BE Word64)

Defined in Binrep.Type.Int

Methods

put :: Endian 'BE Word64 -> Poke

Put (Endian 'LE Int16)

Defined in Binrep.Type.Int

Methods

put :: Endian 'LE Int16 -> Poke

Put (Endian 'LE Int32)

Defined in Binrep.Type.Int

Methods

put :: Endian 'LE Int32 -> Poke

Put (Endian 'LE Int64)

Defined in Binrep.Type.Int

Methods

put :: Endian 'LE Int64 -> Poke

Put (Endian 'LE Word16)

Defined in Binrep.Type.Int

Methods

put :: Endian 'LE Word16 -> Poke

Put (Endian 'LE Word32)

Defined in Binrep.Type.Int

Methods

put :: Endian 'LE Word32 -> Poke

Put (Endian 'LE Word64)

Defined in Binrep.Type.Int

Methods

put :: Endian 'LE Word64 -> Poke

(bs ~ MagicBytes a, ReifyBytes bs) => Put (Magic a)

Defined in Binrep.Type.Magic

Methods

put :: Magic a -> Poke

(BLen a, Put a, KnownNat n) => Put (NullPadded n a)

Defined in Binrep.Type.NullPadded

Methods

put :: NullPadded n a -> Poke

(Prefix pfx, BLen a, Put pfx, Put a) => Put (SizePrefixed pfx a)

Defined in Binrep.Type.Prefix.Size

Methods

put :: SizePrefixed pfx a -> Poke

Put a => Put (Sized n a)

Defined in Binrep.Type.Sized

Methods

put :: Sized n a -> Poke

(Put l, Put r) => Put (l, r)

Defined in Binrep.Put.Bytezap

Methods

put :: (l, r) -> Poke

(Prefix pfx, Foldable f, Put pfx, Put (f a)) => Put (CountPrefixed pfx f a)

Defined in Binrep.Type.Prefix.Count

Methods

put :: CountPrefixed pfx f a -> Poke

runPut :: (BLen a, Put a) => a -> ByteString

putGenericNonSum :: forall {cd} {f} {asserts} a. (Generic a, Rep a ~ D1 cd f, GFoldMapNonSum Poke f, asserts ~ '['NoEmpty, 'NoSum], ApplyGCAsserts asserts f) => a -> Poke

Serialize a term of the non-sum type a via its Generic instance.

putGenericSum :: forall {cd} {f} {asserts} a. (Generic a, Rep a ~ D1 cd f, GFoldMapSum 'SumOnly Poke f, asserts ~ '['NoEmpty, 'NeedSum], ApplyGCAsserts asserts f) => (String -> Poke) -> a -> Poke

Serialize a term of the sum type a via its Generic instance.

You must provide a serializer for a's constructors. This is regrettably inefficient due to having to use Strings. Alas. Do write your own instance if you want better performance!

Orphan instances

GenericFoldMap Poke

Associated Types

type GenericFoldMapC Poke a

Methods

genericFoldMapF :: GenericFoldMapC Poke a => a -> Poke