Binrep.Put.Mason

Documentation

type Builder = BuilderFor StrictByteStringBackend

class Put a where

Methods

put :: a -> Builder

Serialize to binary.

Instances

Put Void

Impossible to serialize Void.

Defined in Binrep.Put.Mason

Methods

put :: Void -> Builder

Put Int8

Defined in Binrep.Put.Mason

Methods

put :: Int8 -> Builder

Put Word8

Defined in Binrep.Put.Mason

Methods

put :: Word8 -> Builder

Put ByteString

Serialize the bytestring as-is.

Careful -- the only way you're going to be able to parse this is to read until EOF.

Defined in Binrep.Put.Mason

Methods

put :: ByteString -> Builder

Put a => Put (Binreply a)

Defined in Binrep.Via

Methods

put :: Binreply a -> Builder

Put a => Put [a]

Serialize each element in order. No length indicator, so parse until either error or EOF. Usually not what you want, but sometimes used at the "top" of binary formats.

Defined in Binrep.Put.Mason

Methods

put :: [a] -> Builder

Put (Endian end Int8)

Endianness doesn't matter for single bytes.

Defined in Binrep.Type.Int

Methods

put :: Endian end Int8 -> Builder

Put (Endian end Word8)

Endianness doesn't matter for single bytes.

Defined in Binrep.Type.Int

Methods

put :: Endian end Word8 -> Builder

(Put a, Put b) => Put (a, b)

Defined in Binrep.Put.Mason

Methods

put :: (a, b) -> Builder

runPut :: Put a => a -> ByteString

Run the serializer.

runBuilder :: Builder -> ByteString

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

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 Builder f, asserts ~ '['NoEmpty, 'NeedSum], ApplyGCAsserts asserts f) => (String -> Builder) -> a -> Builder

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!

class PutWith r a where

Put with inlined checks via an environment.

Minimal complete definition

Nothing

Methods

putWith :: r -> a -> Either String Builder

Attempt to serialize to binary with the given environment.

default putWith :: Put a => r -> a -> Either String Builder

Instances

Put a => PutWith r [a]

Defined in Binrep.Put.Mason

Methods

putWith :: r -> [a] -> Either String Builder

putWithout :: Put a => a -> Either String Builder

Helper for wrapping a BinRep into a BinRepWith (for encoding).

runPutWith :: PutWith r a => r -> a -> Either String ByteString

Run the serializer with the given environment.

Orphan instances

GenericFoldMap Builder

Associated Types

type GenericFoldMapC Builder a

Methods

genericFoldMapF :: GenericFoldMapC Builder a => a -> Builder