Copyright	Lennart Kolmodin, Galois Inc. 2009
License	BSD3-style (see LICENSE)
Maintainer	Trevor Elliott <trevor@galois.com>
Stability	Portability :
Safe Haskell	Safe
Language	Haskell2010

Data.Serialize.Put

Contents

The Put type
Flushing the implicit parse state
Primitives
Big-endian primitives
Little-endian primitives
Host-endian, unaligned writes
Containers

Description

The Put monad. A monad for efficiently constructing bytestrings.

Synopsis

The Put type

type Put = PutM () Source

Put merely lifts Builder into a Writer monad, applied to ().

newtype PutM a Source

The PutM type. A Writer monad over the efficient Builder monoid.

Constructors

Put
Fields unPut :: PairS a

Instances

Monad PutM Source
Functor PutM Source
Applicative PutM Source

type Putter a = a -> Put Source

runPut :: Put -> ByteString Source

Run the Put monad with a serialiser

runPutM :: PutM a -> (a, ByteString) Source

Run the Put monad with a serialiser and get its result

runPutLazy :: Put -> ByteString Source

Run the Put monad with a serialiser

runPutMLazy :: PutM a -> (a, ByteString) Source

Run the Put monad with a serialiser

putBuilder :: Putter Builder Source

execPut :: PutM a -> Builder Source

Run the Put monad

Flushing the implicit parse state

flush :: Put Source

Pop the ByteString we have constructed so far, if any, yielding a new chunk in the result ByteString.

Primitives

putWord8 :: Putter Word8 Source

Efficiently write a byte into the output buffer

putByteString :: Putter ByteString Source

An efficient primitive to write a strict ByteString into the output buffer. It flushes the current buffer, and writes the argument into a new chunk.

putLazyByteString :: Putter ByteString Source

Write a lazy ByteString efficiently, simply appending the lazy ByteString chunks to the output buffer

putShortByteString :: Putter ShortByteString Source

Big-endian primitives

putWord16be :: Putter Word16 Source

Write a Word16 in big endian format

putWord32be :: Putter Word32 Source

Write a Word32 in big endian format

putWord64be :: Putter Word64 Source

Write a Word64 in big endian format

Little-endian primitives

putWord16le :: Putter Word16 Source

Write a Word16 in little endian format

putWord32le :: Putter Word32 Source

Write a Word32 in little endian format

putWord64le :: Putter Word64 Source

Write a Word64 in little endian format

Host-endian, unaligned writes

putWordhost :: Putter Word Source

O(1). Write a single native machine word. The word is written in host order, host endian form, for the machine you're on. On a 64 bit machine the Word is an 8 byte value, on a 32 bit machine, 4 bytes. Values written this way are not portable to different endian or word sized machines, without conversion.

putWord16host :: Putter Word16 Source

O(1). Write a Word16 in native host order and host endianness. For portability issues see putWordhost.

putWord32host :: Putter Word32 Source

O(1). Write a Word32 in native host order and host endianness. For portability issues see putWordhost.

putWord64host :: Putter Word64 Source

O(1). Write a Word64 in native host order On a 32 bit machine we write two host order Word32s, in big endian form. For portability issues see putWordhost.

Containers

putTwoOf :: Putter a -> Putter b -> Putter (a, b) Source

putListOf :: Putter a -> Putter [a] Source

putIArrayOf :: (Ix i, IArray a e) => Putter i -> Putter e -> Putter (a i e) Source

putSeqOf :: Putter a -> Putter (Seq a) Source

putTreeOf :: Putter a -> Putter (Tree a) Source

putMapOf :: Ord k => Putter k -> Putter a -> Putter (Map k a) Source

putIntMapOf :: Putter Int -> Putter a -> Putter (IntMap a) Source

putSetOf :: Putter a -> Putter (Set a) Source

putIntSetOf :: Putter Int -> Putter IntSet Source

putMaybeOf :: Putter a -> Putter (Maybe a) Source

putEitherOf :: Putter a -> Putter b -> Putter (Either a b) Source

putNested :: Putter Int -> Put -> Put Source

Put a nested structure by first putting a length field and then putting the encoded value.