Haskus.Format.Binary.Buffer

A memory buffer with a fixed address

A buffer is a strict ByteString but with:

• a better interface: use Word instead of Int for sizes
• a better name: "string" is misleading
• some additional primitives

Documentation

newtype Buffer

A buffer

Constructors

Buffer ByteString

Instances

Eq Buffer

Methods

(==) :: Buffer -> Buffer -> Bool

(/=) :: Buffer -> Buffer -> Bool

Ord Buffer

Methods

compare :: Buffer -> Buffer -> Ordering

(<) :: Buffer -> Buffer -> Bool

(<=) :: Buffer -> Buffer -> Bool

(>) :: Buffer -> Buffer -> Bool

(>=) :: Buffer -> Buffer -> Bool

max :: Buffer -> Buffer -> Buffer

min :: Buffer -> Buffer -> Buffer

Show Buffer

Methods

showsPrec :: Int -> Buffer -> ShowS

show :: Buffer -> String

showList :: [Buffer] -> ShowS

Bits Buffer

Methods

(.&.) :: Buffer -> Buffer -> Buffer

(.|.) :: Buffer -> Buffer -> Buffer

xor :: Buffer -> Buffer -> Buffer

complement :: Buffer -> Buffer

shift :: Buffer -> Int -> Buffer

rotate :: Buffer -> Int -> Buffer

zeroBits :: Buffer

bit :: Int -> Buffer

setBit :: Buffer -> Int -> Buffer

clearBit :: Buffer -> Int -> Buffer

complementBit :: Buffer -> Int -> Buffer

testBit :: Buffer -> Int -> Bool

bitSizeMaybe :: Buffer -> Maybe Int

bitSize :: Buffer -> Int

isSigned :: Buffer -> Bool

shiftL :: Buffer -> Int -> Buffer

unsafeShiftL :: Buffer -> Int -> Buffer

shiftR :: Buffer -> Int -> Buffer

unsafeShiftR :: Buffer -> Int -> Buffer

rotateL :: Buffer -> Int -> Buffer

rotateR :: Buffer -> Int -> Buffer

popCount :: Buffer -> Int

withBufferPtr :: Buffer -> (Ptr b -> IO a) -> IO a

Unsafe: be careful if you modify the buffer contents or you may break referential transparency

bufferSize :: Buffer -> Word

Buffer size

isBufferEmpty :: Buffer -> Bool

Test if the buffer is empty

emptyBuffer :: Buffer

Empty buffer

bufferZero :: Word -> Buffer

Buffer filled with zero

bufferMap :: (Word8 -> Word8) -> Buffer -> Buffer

Map

bufferReverse :: Buffer -> Buffer

Reverse

bufferDrop :: Word -> Buffer -> Buffer

Drop some bytes O(1)

bufferTail :: Buffer -> Buffer

Tail

bufferAppend :: Buffer -> Buffer -> Buffer

Append

bufferCons :: Word8 -> Buffer -> Buffer

Cons

bufferSnoc :: Buffer -> Word8 -> Buffer

Snoc

bufferInit :: Buffer -> Buffer

Init

bufferSplitOn :: Word8 -> Buffer -> [Buffer]

Split on the given Byte values

bufferHead :: Buffer -> Word8

Head

bufferIndex :: Buffer -> Word -> Word8

Index

bufferTake :: Word -> Buffer -> Buffer

Take some bytes O(1)

bufferTakeWhile :: (Word8 -> Bool) -> Buffer -> Buffer

Take some bytes O(n)

bufferTakeAtMost :: Word -> Buffer -> Buffer

Take some bytes O(1)

bufferZipWith :: (Word8 -> Word8 -> Word8) -> Buffer -> Buffer -> Buffer

Zip two buffers with the given function

bufferDup :: Buffer -> IO Buffer

Duplicate a buffer

Peek / Poke

bufferPeekStorable :: forall a. Storable a => Buffer -> a

Peek a storable

bufferPeekStorableAt :: forall a. Storable a => Buffer -> Word -> a

Peek a storable at the given offset

bufferPopStorable :: forall a. Storable a => Buffer -> (Buffer, a)

Pop a Storable and return the new buffer

bufferPoke :: Ptr a -> Buffer -> IO ()

Poke a buffer

Packing / Unpacking

bufferPackByteString :: ByteString -> Buffer

Pack a ByteString

bufferPackByteList :: [Word8] -> Buffer

Pack a list of bytes

bufferPackStorable :: forall a. Storable a => a -> Buffer

Pack a Storable

bufferPackStorableList :: forall a. Storable a => [a] -> Buffer

Pack a list of Storable

bufferPackPtr :: MonadIO m => Word -> Ptr () -> m Buffer

Pack from a pointer (copy)

bufferUnpackByteList :: Buffer -> [Word8]

Unpack

bufferUnpackByteString :: Buffer -> ByteString

Unpack

Unsafe

bufferUnsafeDrop :: Word -> Buffer -> Buffer

Unsafe drop (don't check the size)

bufferUnsafeTake :: Word -> Buffer -> Buffer

Unsafe take (don't check the size)

bufferUnsafeTail :: Buffer -> Buffer

Unsafe tail (don't check the size)

bufferUnsafeHead :: Buffer -> Word8

Unsafe head (don't check the size)

bufferUnsafeLast :: Buffer -> Word8

Unsafe last (don't check the size)

bufferUnsafeInit :: Buffer -> Buffer

Unsafe init (don't check the size)

bufferUnsafeIndex :: Buffer -> Word -> Word8

Unsafe index (don't check the size)

bufferUnsafeMapMemory :: MonadIO m => Word -> Ptr () -> m Buffer

Map memory

bufferUnsafeUsePtr :: MonadInIO m => Buffer -> (Ptr () -> Word -> m a) -> m a

Use buffer pointer

bufferUnsafePackPtr :: MonadIO m => Word -> Ptr a -> m Buffer

Pack from a pointer (add finalizer)

IO

bufferReadFile :: MonadIO m => FilePath -> m Buffer

Read file

bufferWriteFile :: MonadIO m => FilePath -> Buffer -> m ()

Write file