License	BSD-Style
Maintainer	Vincent Hanquez <vincent@snarc.org>
Stability	experimental
Portability	unknown
Safe Haskell	None
Language	Haskell2010

Data.ByteArray.Pack

Contents

Operations
- put
- skip

Description

Simple Byte Array packer

Simple example:

> flip pack 20 $ putWord8 0x41 >> putByteString "BCD" >> putWord8 0x20 >> putStorable (42 :: Word32)
Right (ABCD *\NUL\NUL\NUL")

Synopsis

Documentation

data Packer a Source

Simple ByteArray Packer

Instances

Monad Packer Source
Functor Packer Source
Applicative Packer Source

data Result a Source

Packing result:

PackerMore: the next state of Packing with an arbitrary value
PackerFail: an error happened

Constructors

PackerMore a MemView
PackerFail String

Instances

Show a => Show (Result a) Source

fill :: ByteArray byteArray => Int -> Packer a -> Either String byteArray Source

fill a given sized buffer with the result of the Packer action

pack :: ByteArray byteArray => Packer a -> Int -> Either String byteArray Source

Deprecated: use fill instead

pack the given packer into the given bytestring

Operations

put

putWord8 :: Word8 -> Packer () Source

put Word8 in the current position in the stream

putWord16 :: Word16 -> Packer () Source

put Word16 in the current position in the stream /! use Host Endianness

putWord32 :: Word32 -> Packer () Source

put Word32 in the current position in the stream /! use Host Endianness

putStorable :: Storable storable => storable -> Packer () Source

put a storable from the current position in the stream

putBytes :: ByteArrayAccess ba => ba -> Packer () Source

put a Byte Array from the current position in the stream

If the ByteArray is null, then do nothing

fillList :: Storable storable => [storable] -> Packer () Source

Will put the given storable list from the current position in the stream to the end.

This function will fail with not enough storage if the given storable can't be written (not enough space)

example: > pack (fillList $ [1..] :: Word8) 9 ==> "123456789" > pack (fillList $ [1..] :: Word32) 4 ==> "1000" > pack (fillList $ [1..] :: Word32) 64 -- will work > pack (fillList $ [1..] :: Word32) 1 -- will fail (not enough space) > pack (fillList $ [1..] :: Word32) 131 -- will fail (not enough space)

fillUpWith :: Storable storable => storable -> Packer () Source

fill up from the current position in the stream to the end

it is basically: > fillUpWith s == fillList (repeat s)

skip

skip :: Int -> Packer () Source

skip some bytes from the current position in the stream

skipStorable :: Storable storable => storable -> Packer () Source

skip the size of a storable from the current position in the stream