License | BSD-Style |
---|---|
Maintainer | Vincent Hanquez <vincent@snarc.org> |
Stability | experimental |
Portability | unknown |
Safe Haskell | None |
Language | Haskell2010 |
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
- data Packer a
- data Result a
- pack :: ByteArray byteArray => Packer a -> Int -> Either String byteArray
- putWord8 :: Word8 -> Packer ()
- putWord16 :: Word16 -> Packer ()
- putWord32 :: Word32 -> Packer ()
- putStorable :: Storable storable => storable -> Packer ()
- putBytes :: ByteArray ba => ba -> Packer ()
- fillList :: Storable storable => [storable] -> Packer ()
- fillUpWith :: Storable storable => storable -> Packer ()
- skip :: Int -> Packer ()
- skipStorable :: Storable storable => storable -> Packer ()
Documentation
Packing result:
- PackerMore: the next state of Packing with an arbitrary value
- PackerFail: an error happened
pack :: ByteArray byteArray => Packer a -> Int -> Either String byteArray Source
pack the given packer into the given bytestring
Operations
put
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 :: ByteArray 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
skipStorable :: Storable storable => storable -> Packer () Source
skip the size of a storable from the current position in the stream