Data.Bytes.Put

This module generalizes the binary PutM and cereal PutM monads in an ad hoc fashion to permit code to be written that is compatible across them.

Moreover, this class permits code to be written to be portable over various monad transformers applied to these as base monads.

Documentation

class (Applicative m, Monad m) => MonadPut m where

Methods

putWord8 :: Word8 -> m ()

Efficiently write a byte into the output buffer

putWord8 :: (m ~ t n, MonadTrans t, MonadPut n) => Word8 -> m ()

Efficiently write a byte into the output buffer

putByteString :: ByteString -> m ()

An efficient primitive to write a strict ByteString into the output buffer.

In binary this flushes the current buffer, and writes the argument into a new chunk.

putByteString :: (m ~ t n, MonadTrans t, MonadPut n) => ByteString -> m ()

An efficient primitive to write a strict ByteString into the output buffer.

In binary this flushes the current buffer, and writes the argument into a new chunk.

putLazyByteString :: ByteString -> m ()

Write a lazy ByteString efficiently.

With binary, this simply appends the chunks to the output buffer

putLazyByteString :: (m ~ t n, MonadTrans t, MonadPut n) => ByteString -> m ()

Write a lazy ByteString efficiently.

With binary, this simply appends the chunks to the output buffer

flush :: m ()

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

If we're building a strict ByteString with cereal then this does nothing.

flush :: (m ~ t n, MonadTrans t, MonadPut n) => m ()

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

If we're building a strict ByteString with cereal then this does nothing.

putWord16le :: Word16 -> m ()

Write a Word16 in little endian format

putWord16le :: (m ~ t n, MonadTrans t, MonadPut n) => Word16 -> m ()

Write a Word16 in little endian format

putWord16be :: Word16 -> m ()

Write a Word16 in big endian format

putWord16be :: (m ~ t n, MonadTrans t, MonadPut n) => Word16 -> m ()

Write a Word16 in big endian format

putWord16host :: Word16 -> m ()

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

putWord16host :: (m ~ t n, MonadTrans t, MonadPut n) => Word16 -> m ()

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

putWord32le :: Word32 -> m ()

Write a Word32 in little endian format

putWord32le :: (m ~ t n, MonadTrans t, MonadPut n) => Word32 -> m ()

Write a Word32 in little endian format

putWord32be :: Word32 -> m ()

Write a Word32 in big endian format

putWord32be :: (m ~ t n, MonadTrans t, MonadPut n) => Word32 -> m ()

Write a Word32 in big endian format

putWord32host :: Word32 -> m ()

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

putWord32host :: (m ~ t n, MonadTrans t, MonadPut n) => Word32 -> m ()

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

putWord64le :: Word64 -> m ()

Write a Word64 in little endian format

putWord64le :: (m ~ t n, MonadTrans t, MonadPut n) => Word64 -> m ()

Write a Word64 in little endian format

putWord64be :: Word64 -> m ()

Write a Word64 in big endian format

putWord64be :: (m ~ t n, MonadTrans t, MonadPut n) => Word64 -> m ()

Write a Word64 in big endian format

putWord64host :: Word64 -> m ()

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

putWord64host :: (m ~ t n, MonadTrans t, MonadPut n) => Word64 -> m ()

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

putWordhost :: Word -> m ()

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.

putWordhost :: (m ~ t n, MonadTrans t, MonadPut n) => Word -> m ()

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.

Instances

MonadPut PutM

Methods

putWord8 :: Word8 -> PutM ()

putByteString :: ByteString -> PutM ()

putLazyByteString :: ByteString -> PutM ()

flush :: PutM ()

putWord16le :: Word16 -> PutM ()

putWord16be :: Word16 -> PutM ()

putWord16host :: Word16 -> PutM ()

putWord32le :: Word32 -> PutM ()

putWord32be :: Word32 -> PutM ()

putWord32host :: Word32 -> PutM ()

putWord64le :: Word64 -> PutM ()

putWord64be :: Word64 -> PutM ()

putWord64host :: Word64 -> PutM ()

putWordhost :: Word -> PutM ()

MonadPut PutM

Methods

putWord8 :: Word8 -> PutM ()

putByteString :: ByteString -> PutM ()

putLazyByteString :: ByteString -> PutM ()

flush :: PutM ()

putWord16le :: Word16 -> PutM ()

putWord16be :: Word16 -> PutM ()

putWord16host :: Word16 -> PutM ()

putWord32le :: Word32 -> PutM ()

putWord32be :: Word32 -> PutM ()

putWord32host :: Word32 -> PutM ()

putWord64le :: Word64 -> PutM ()

putWord64be :: Word64 -> PutM ()

putWord64host :: Word64 -> PutM ()

putWordhost :: Word -> PutM ()

MonadPut m => MonadPut (ExceptT e m)

Methods

putWord8 :: Word8 -> ExceptT e m ()

putByteString :: ByteString -> ExceptT e m ()

putLazyByteString :: ByteString -> ExceptT e m ()

flush :: ExceptT e m ()

putWord16le :: Word16 -> ExceptT e m ()

putWord16be :: Word16 -> ExceptT e m ()

putWord16host :: Word16 -> ExceptT e m ()

putWord32le :: Word32 -> ExceptT e m ()

putWord32be :: Word32 -> ExceptT e m ()

putWord32host :: Word32 -> ExceptT e m ()

putWord64le :: Word64 -> ExceptT e m ()

putWord64be :: Word64 -> ExceptT e m ()

putWord64host :: Word64 -> ExceptT e m ()

putWordhost :: Word -> ExceptT e m ()

MonadPut m => MonadPut (StateT s m)

Methods

putWord8 :: Word8 -> StateT s m ()

putByteString :: ByteString -> StateT s m ()

putLazyByteString :: ByteString -> StateT s m ()

flush :: StateT s m ()

putWord16le :: Word16 -> StateT s m ()

putWord16be :: Word16 -> StateT s m ()

putWord16host :: Word16 -> StateT s m ()

putWord32le :: Word32 -> StateT s m ()

putWord32be :: Word32 -> StateT s m ()

putWord32host :: Word32 -> StateT s m ()

putWord64le :: Word64 -> StateT s m ()

putWord64be :: Word64 -> StateT s m ()

putWord64host :: Word64 -> StateT s m ()

putWordhost :: Word -> StateT s m ()

MonadPut m => MonadPut (StateT s m)

Methods

putWord8 :: Word8 -> StateT s m ()

putByteString :: ByteString -> StateT s m ()

putLazyByteString :: ByteString -> StateT s m ()

flush :: StateT s m ()

putWord16le :: Word16 -> StateT s m ()

putWord16be :: Word16 -> StateT s m ()

putWord16host :: Word16 -> StateT s m ()

putWord32le :: Word32 -> StateT s m ()

putWord32be :: Word32 -> StateT s m ()

putWord32host :: Word32 -> StateT s m ()

putWord64le :: Word64 -> StateT s m ()

putWord64be :: Word64 -> StateT s m ()

putWord64host :: Word64 -> StateT s m ()

putWordhost :: Word -> StateT s m ()

(MonadPut m, Monoid w) => MonadPut (WriterT w m)

Methods

putWord8 :: Word8 -> WriterT w m ()

putByteString :: ByteString -> WriterT w m ()

putLazyByteString :: ByteString -> WriterT w m ()

flush :: WriterT w m ()

putWord16le :: Word16 -> WriterT w m ()

putWord16be :: Word16 -> WriterT w m ()

putWord16host :: Word16 -> WriterT w m ()

putWord32le :: Word32 -> WriterT w m ()

putWord32be :: Word32 -> WriterT w m ()

putWord32host :: Word32 -> WriterT w m ()

putWord64le :: Word64 -> WriterT w m ()

putWord64be :: Word64 -> WriterT w m ()

putWord64host :: Word64 -> WriterT w m ()

putWordhost :: Word -> WriterT w m ()

(MonadPut m, Monoid w) => MonadPut (WriterT w m)

Methods

putWord8 :: Word8 -> WriterT w m ()

putByteString :: ByteString -> WriterT w m ()

putLazyByteString :: ByteString -> WriterT w m ()

flush :: WriterT w m ()

putWord16le :: Word16 -> WriterT w m ()

putWord16be :: Word16 -> WriterT w m ()

putWord16host :: Word16 -> WriterT w m ()

putWord32le :: Word32 -> WriterT w m ()

putWord32be :: Word32 -> WriterT w m ()

putWord32host :: Word32 -> WriterT w m ()

putWord64le :: Word64 -> WriterT w m ()

putWord64be :: Word64 -> WriterT w m ()

putWord64host :: Word64 -> WriterT w m ()

putWordhost :: Word -> WriterT w m ()

MonadPut m => MonadPut (ReaderT * e m)

Methods

putWord8 :: Word8 -> ReaderT * e m ()

putByteString :: ByteString -> ReaderT * e m ()

putLazyByteString :: ByteString -> ReaderT * e m ()

flush :: ReaderT * e m ()

putWord16le :: Word16 -> ReaderT * e m ()

putWord16be :: Word16 -> ReaderT * e m ()

putWord16host :: Word16 -> ReaderT * e m ()

putWord32le :: Word32 -> ReaderT * e m ()

putWord32be :: Word32 -> ReaderT * e m ()

putWord32host :: Word32 -> ReaderT * e m ()

putWord64le :: Word64 -> ReaderT * e m ()

putWord64be :: Word64 -> ReaderT * e m ()

putWord64host :: Word64 -> ReaderT * e m ()

putWordhost :: Word -> ReaderT * e m ()

(MonadPut m, Monoid w) => MonadPut (RWST r w s m)

Methods

putWord8 :: Word8 -> RWST r w s m ()

putByteString :: ByteString -> RWST r w s m ()

putLazyByteString :: ByteString -> RWST r w s m ()

flush :: RWST r w s m ()

putWord16le :: Word16 -> RWST r w s m ()

putWord16be :: Word16 -> RWST r w s m ()

putWord16host :: Word16 -> RWST r w s m ()

putWord32le :: Word32 -> RWST r w s m ()

putWord32be :: Word32 -> RWST r w s m ()

putWord32host :: Word32 -> RWST r w s m ()

putWord64le :: Word64 -> RWST r w s m ()

putWord64be :: Word64 -> RWST r w s m ()

putWord64host :: Word64 -> RWST r w s m ()

putWordhost :: Word -> RWST r w s m ()

(MonadPut m, Monoid w) => MonadPut (RWST r w s m)

Methods

putWord8 :: Word8 -> RWST r w s m ()

putByteString :: ByteString -> RWST r w s m ()

putLazyByteString :: ByteString -> RWST r w s m ()

flush :: RWST r w s m ()

putWord16le :: Word16 -> RWST r w s m ()

putWord16be :: Word16 -> RWST r w s m ()

putWord16host :: Word16 -> RWST r w s m ()

putWord32le :: Word32 -> RWST r w s m ()

putWord32be :: Word32 -> RWST r w s m ()

putWord32host :: Word32 -> RWST r w s m ()

putWord64le :: Word64 -> RWST r w s m ()

putWord64be :: Word64 -> RWST r w s m ()

putWord64host :: Word64 -> RWST r w s m ()

putWordhost :: Word -> RWST r w s m ()

runPutL :: Put -> ByteString

Put a value into a lazy ByteString using runPut.

runPutS :: Put -> ByteString

Put a value into a strict ByteString using runPut.