Data.ByteString.Pack

Copyright : Copyright © 2014 Nicolas DI PRIMA

Maintainer : Nicolas DI PRIMA [e-mail] Stability : experimental Portability : unknown

Documentation

data Packer a

Simple Bytestring Packer

Instances

Monad Packer

Functor Packer

Applicative Packer

data Result a

Packing result:

• PackerOK a -> means the bytestring has been filled with the given data
• PackerMore a cache -> a temporary

Constructors

PackerMore a Cache

PackerFail String

Instances

Show a => Show (Result a)

pack :: Packer a -> Int -> Either String ByteString

pack the given packer into the given bytestring

Operations

put

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

put a storable from the current position in the stream

putByteString :: ByteString -> Packer ()

put a Bytestring from the current position in the stream

If the ByteString ins 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 ==> "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 ()

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

it is basically: > 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