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

data Packer a
data Result a
- = PackerMore a MemView
- | PackerFail String
fill :: ByteArray byteArray => Int -> Packer a -> Either String byteArray
pack :: ByteArray byteArray => Packer a -> Int -> Either String byteArray
putWord8 :: Word8 -> Packer ()
putWord16 :: Word16 -> Packer ()
putWord32 :: Word32 -> Packer ()
putStorable :: Storable storable => storable -> Packer ()
putBytes :: ByteArrayAccess ba => ba -> Packer ()
fillList :: Storable storable => [storable] -> Packer ()
fillUpWith :: Storable storable => storable -> Packer ()
skip :: Int -> Packer ()
skipStorable :: Storable storable => storable -> Packer ()

Documentation

data Packer a #

Simple ByteArray Packer

Instances

Instances details

Monad Packer #
Instance details Defined in Data.ByteArray.Pack.Internal Methods (>>=) :: Packer a -> (a -> Packer b) -> Packer b # (>>) :: Packer a -> Packer b -> Packer b # return :: a -> Packer a #
Functor Packer #
Instance details Defined in Data.ByteArray.Pack.Internal Methods fmap :: (a -> b) -> Packer a -> Packer b # (<$) :: a -> Packer b -> Packer a #
Applicative Packer #
Instance details Defined in Data.ByteArray.Pack.Internal Methods pure :: a -> Packer a # (<>) :: Packer (a -> b) -> Packer a -> Packer b # liftA2 :: (a -> b -> c) -> Packer a -> Packer b -> Packer c # (>) :: Packer a -> Packer b -> Packer b # (<*) :: Packer a -> Packer b -> Packer a #

data Result a #

Packing result:

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

Constructors

PackerMore a MemView
PackerFail String

Instances

Instances details

Show a => Show (Result a) #
Instance details Defined in Data.ByteArray.Pack.Internal Methods showsPrec :: Int -> Result a -> ShowS # show :: Result a -> String # showList :: [Result a] -> ShowS #

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

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

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

Deprecated: use fill instead

Pack the given packer into the given bytestring

Operations

put

putWord8 :: Word8 -> Packer () #

put Word8 in the current position in the stream

putWord16 :: Word16 -> Packer () #

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

putWord32 :: Word32 -> Packer () #

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

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

Put a storable from the current position in the stream

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

Put a Byte Array from the current position in the stream

If the ByteArray is null, then do nothing

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

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
"\1\2\3\4\5\6\7\8\9"
> pack (fillList $ [1..] :: Word32) 4
"\1\0\0\0"
> pack (fillList $ [1..] :: Word32) 64
.. <..succesful..>
> pack (fillList $ [1..] :: Word32) 1
.. <.. not enough space ..>
> pack (fillList $ [1..] :: Word32) 131
.. <.. not enough space ..>

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

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

It is equivalent to:

fillUpWith s == fillList (repeat s)

skip

skip :: Int -> Packer () #

Skip some bytes from the current position in the stream

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

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