Safe Haskell	None
Language	Haskell2010

Haskus.Binary.Buffer

Contents

Peek / Poke
Packing / Unpacking
Unsafe
IO

Description

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

Synopsis

newtype Buffer = Buffer ByteString
withBufferPtr :: Buffer -> (Ptr b -> IO a) -> IO a
bufferSize :: Buffer -> Word
isBufferEmpty :: Buffer -> Bool
emptyBuffer :: Buffer
bufferZero :: Word -> Buffer
bufferMap :: (Word8 -> Word8) -> Buffer -> Buffer
bufferReverse :: Buffer -> Buffer
bufferDrop :: Word -> Buffer -> Buffer
bufferTail :: Buffer -> Buffer
bufferAppend :: Buffer -> Buffer -> Buffer
bufferCons :: Word8 -> Buffer -> Buffer
bufferSnoc :: Buffer -> Word8 -> Buffer
bufferInit :: Buffer -> Buffer
bufferSplitOn :: Word8 -> Buffer -> [Buffer]
bufferHead :: Buffer -> Word8
bufferIndex :: Buffer -> Word -> Word8
bufferTake :: Word -> Buffer -> Buffer
bufferTakeWhile :: (Word8 -> Bool) -> Buffer -> Buffer
bufferTakeAtMost :: Word -> Buffer -> Buffer
bufferZipWith :: (Word8 -> Word8 -> Word8) -> Buffer -> Buffer -> Buffer
bufferDup :: Buffer -> IO Buffer
bufferPeekStorable :: forall a. Storable a => Buffer -> a
bufferPeekStorableAt :: forall a. Storable a => Buffer -> Word -> a
bufferPopStorable :: forall a. Storable a => Buffer -> (Buffer, a)
bufferPoke :: Ptr a -> Buffer -> IO ()
bufferPackByteString :: ByteString -> Buffer
bufferPackByteList :: [Word8] -> Buffer
bufferPackStorable :: forall a. Storable a => a -> Buffer
bufferPackStorableList :: forall a. Storable a => [a] -> Buffer
bufferPackPtr :: MonadIO m => Word -> Ptr () -> m Buffer
bufferUnpackByteList :: Buffer -> [Word8]
bufferUnpackByteString :: Buffer -> ByteString
bufferUnsafeDrop :: Word -> Buffer -> Buffer
bufferUnsafeTake :: Word -> Buffer -> Buffer
bufferUnsafeTail :: Buffer -> Buffer
bufferUnsafeHead :: Buffer -> Word8
bufferUnsafeLast :: Buffer -> Word8
bufferUnsafeInit :: Buffer -> Buffer
bufferUnsafeIndex :: Buffer -> Word -> Word8
bufferUnsafeMapMemory :: MonadIO m => Word -> Ptr () -> m Buffer
bufferUnsafeUsePtr :: MonadInIO m => Buffer -> (Ptr () -> Word -> m a) -> m a
bufferUnsafePackPtr :: MonadIO m => Word -> Ptr a -> m Buffer
bufferReadFile :: MonadIO m => FilePath -> m Buffer
bufferWriteFile :: MonadIO m => FilePath -> Buffer -> m ()

Documentation

newtype Buffer Source #

A buffer

Constructors

Buffer ByteString

Instances

Eq Buffer Source #
Instance details Defined in Haskus.Binary.Buffer Methods (==) :: Buffer -> Buffer -> Bool # (/=) :: Buffer -> Buffer -> Bool #
Ord Buffer Source #
Instance details Defined in Haskus.Binary.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 Source #
Instance details Defined in Haskus.Binary.Buffer Methods showsPrec :: Int -> Buffer -> ShowS # show :: Buffer -> String # showList :: [Buffer] -> ShowS #
Bitwise Buffer Source #
Instance details Defined in Haskus.Binary.Buffer Methods (.&.) :: Buffer -> Buffer -> Buffer Source # (.\|.) :: Buffer -> Buffer -> Buffer Source # xor :: Buffer -> Buffer -> Buffer Source #
IndexableBits Buffer Source #
Instance details Defined in Haskus.Binary.Buffer Methods bit :: Word -> Buffer Source # setBit :: Buffer -> Word -> Buffer Source # clearBit :: Buffer -> Word -> Buffer Source # complementBit :: Buffer -> Word -> Buffer Source # testBit :: Buffer -> Word -> Bool Source # popCount :: Buffer -> Word Source #