Simple ByteArray Packer
Modulememory-0.18.0Haskell2010
Data.ByteArray.Pack
Simple Byte Array packer
Simple example:
> flip pack 20 $ putWord8 0x41 >> putByteString "BCD" >> putWord8 0x20 >> putStorable (42 :: Word32)
Right (ABCD *\NUL\NUL\NUL")Original code from https://hackage.haskell.org/package/bspack
generalized and adapted to run on memory, and spellchecked / tweaked. (2015-05)
Copyright (c) 2014 Nicolas DI PRIMA
Contents
Synopsis
- newtype Packer
- data Result
- value fill
- value pack
- value putWord8
- value putWord16
- value putWord32
- value putStorable
- value putBytes
- value fillList
- value fillUpWith
- value skip
- value skipStorable
- Packagememory-0.18.0
- Exports13
- LanguageHaskell2010
- LicenceBSD-3-Clause
- SourcePack.hs
Packing result:
PackerMore: the next state of Packing with an arbitrary value
PackerFail: an error happened
Constructors
Fill a given sized buffer with the result of the Packer action
Deprecated. use fill instead
Pack the given packer into the given bytestring
Operations
put
put Word8 in the current position in the stream
put Word16 in the current position in the stream /! use Host Endianness
put Word32 in the current position in the stream /! use Host Endianness
Put a storable from the current position in the stream
Put a Byte Array from the current position in the stream
If the ByteArray is null, then do nothing
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 ..>Fill up from the current position in the stream to the end
It is equivalent to:
fillUpWith s == fillList (repeat s)skip
Skip some bytes from the current position in the stream
Skip the size of a storable from the current position in the stream