Binrep.Put

Documentation

type Builder = BuilderFor StrictByteStringBackend

class Put a where

Methods

put :: a -> Builder

Serialize to binary.

Instances

Put Int8

Defined in Binrep.Put

Methods

put :: Int8 -> Builder

Put Word8

Defined in Binrep.Put

Methods

put :: Word8 -> Builder

Put DCS

Defined in Binrep.Example

Methods

put :: DCS -> Builder

Put DSS

Defined in Binrep.Example

Methods

put :: DSS -> Builder

Put DU

Defined in Binrep.Example

Methods

put :: DU -> Builder

Put Tar

Defined in Binrep.Example.Tar

Methods

put :: Tar -> Builder

Put Tiff

Defined in Binrep.Example.Tiff

Methods

put :: Tiff -> Builder

Put WavHeader

Defined in Binrep.Example.Wav

Methods

put :: WavHeader -> 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

Methods

put :: ByteString -> Builder

(bs ~ MagicVals (TiffMagic end), ByteVals bs, irep ~ I 'U 'I4 end, Put irep) => Put (TiffBody end)

Defined in Binrep.Example.Tiff

Methods

put :: TiffBody end -> Builder

Put (AsciiNat 8)

Defined in Binrep.Type.AsciiNat

Methods

put :: AsciiNat 8 -> Builder

Put (AsByteString 'C)

Defined in Binrep.Type.ByteString

Methods

put :: AsByteString 'C -> Builder

(itype ~ I 'U size end, irep ~ IRep 'U size, Put itype, Num irep) => Put (AsByteString ('Pascal size end))

Defined in Binrep.Type.ByteString

Methods

put :: AsByteString ('Pascal size end) -> Builder

KnownSymbol str => Put (MagicUTF8 str)

Defined in Binrep.Type.Magic.UTF8

Methods

put :: MagicUTF8 str -> 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

Methods

put :: [a] -> Builder

(Put a, BLen a) => Put (Table 'Strong a)

Defined in Binrep.Example.FileTable

Methods

put :: Table 'Strong a -> Builder

KnownNat n => Put (TarNat n)

No need to check for underflow etc. as TarNat guarantees good sizing.

Defined in Binrep.Example.Tar

Methods

put :: TarNat n -> Builder

(bs ~ MagicVals a, ByteVals bs) => Put (Magic a)

Forces magic values to be individual bytes.

Defined in Binrep.Type.Magic

Methods

put :: Magic a -> Builder

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

Defined in Binrep.Type.NullPadded

Methods

put :: NullPadded n a -> Builder

Put a => Put (Sized n a)

Defined in Binrep.Type.Sized

Methods

put :: Sized n a -> Builder

Put a => Put (Vector n a)

Defined in Binrep.Type.Vector

Methods

put :: Vector n a -> Builder

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

Defined in Binrep.Put

Methods

put :: (a, b) -> Builder

Put (I 'S 'I1 e)

Defined in Binrep.Type.Int

Methods

put :: I 'S 'I1 e -> Builder

Put (I 'S 'I2 'BE)

Defined in Binrep.Type.Int

Methods

put :: I 'S 'I2 'BE -> Builder

Put (I 'S 'I2 'LE)

Defined in Binrep.Type.Int

Methods

put :: I 'S 'I2 'LE -> Builder

Put (I 'S 'I4 'BE)

Defined in Binrep.Type.Int

Methods

put :: I 'S 'I4 'BE -> Builder

Put (I 'S 'I4 'LE)

Defined in Binrep.Type.Int

Methods

put :: I 'S 'I4 'LE -> Builder

Put (I 'S 'I8 'BE)

Defined in Binrep.Type.Int

Methods

put :: I 'S 'I8 'BE -> Builder

Put (I 'S 'I8 'LE)

Defined in Binrep.Type.Int

Methods

put :: I 'S 'I8 'LE -> Builder

Put (I 'U 'I1 e)

Defined in Binrep.Type.Int

Methods

put :: I 'U 'I1 e -> Builder

Put (I 'U 'I2 'BE)

Defined in Binrep.Type.Int

Methods

put :: I 'U 'I2 'BE -> Builder

Put (I 'U 'I2 'LE)

Defined in Binrep.Type.Int

Methods

put :: I 'U 'I2 'LE -> Builder

Put (I 'U 'I4 'BE)

Defined in Binrep.Type.Int

Methods

put :: I 'U 'I4 'BE -> Builder

Put (I 'U 'I4 'LE)

Defined in Binrep.Type.Int

Methods

put :: I 'U 'I4 'LE -> Builder

Put (I 'U 'I8 'BE)

Defined in Binrep.Type.Int

Methods

put :: I 'U 'I8 'BE -> Builder

Put (I 'U 'I8 'LE)

Defined in Binrep.Type.Int

Methods

put :: I 'U 'I8 'LE -> Builder

(itype ~ I 'U size end, irep ~ IRep 'U size, Put a, Put itype, Num irep) => Put (LenPfx size end a)

Defined in Binrep.Type.LenPfx

Methods

put :: LenPfx size end a -> Builder

runPut :: Put a => a -> ByteString

Run the serializer.

runBuilder :: Builder -> ByteString

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

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.