A memory buffer

Wrapper containing any kind of buffer

Is the buffer pinned into memory?

Is the memory automatically garbage collected?

Is the memory mutable or not?

Allocation heap

Allocate a buffer (mutable, unpinned)

>>> b <- newBuffer 1024

Allocate a buffer (mutable, pinned)

Allocate an aligned buffer (mutable, pinned)

Get buffer size

Buffer that can be frozen (converted from mutable to immutable)

Buffer that can be thawed (converted from immutable to mutable)

Some buffers managed by GHC can be pinned as an optimization. This function reports this.

Transform type-level NotPinned buffers into type-level Pinned if the buffer is dynamically pinned (see bufferIsDynamicallyPinned).

Do something with a buffer address

Do something with a buffer pointer

Do something with a buffer address

Note: don't write into immutable buffer as it would break referential consistency

Do something with a buffer pointer

Note: don't write into immutable buffer as it would break referential consistency

Read a Word8, offset in bytes

We don't check that the offset is valid

>>> let b = [25,26,27,28] :: BufferI
>>> bufferReadWord8IO b 2
27

Read a Word8 in an immutable buffer, offset in bytes

We don't check that the offset is valid

>>> let b = [25,26,27,28] :: BufferI
>>> putStrLn $ "Word8 at offset 2 is " ++ show (bufferReadWord8 b 2)
Word8 at offset 2 is 27

Read a Word16, offset in bytes

We don't check that the offset is valid

>>> let b = [0x12,0x34,0x56,0x78] :: BufferI
>>> x <- bufferReadWord16IO b 0
>>> (x == 0x1234) || (x == 0x3412)
True

Read a Word16 in an immutable buffer, offset in bytes

We don't check that the offset is valid

Read a Word32, offset in bytes

We don't check that the offset is valid

>>> let b = [0x12,0x34,0x56,0x78] :: BufferI
>>> x <- bufferReadWord32IO b 0
>>> (x == 0x12345678) || (x == 0x78563412)
True

Read a Word32 in an immutable buffer, offset in bytes

We don't check that the offset is valid

Read a Word64, offset in bytes

We don't check that the offset is valid

>>> let b = [0x12,0x34,0x56,0x78,0x9A,0xBC,0xDE,0xF0] :: BufferI
>>> x <- bufferReadWord64IO b 0
>>> (x == 0x123456789ABCDEF0) || (x == 0xF0DEBC9A78563412)
True

Read a Word64 in an immutable buffer, offset in bytes

We don't check that the offset is valid

Write a Word8, offset in bytes

We don't check that the offset is valid

>>> b <- newBuffer 10
>>> bufferWriteWord8IO b 1 123
>>> bufferReadWord8IO b 1
123

Write a Word16, offset in bytes

We don't check that the offset is valid

>>> b <- newBuffer 10
>>> let v = 1234 :: Word16
>>> bufferWriteWord16IO b 1 v
>>> bufferReadWord16IO b 1
1234

>>> (x :: Word16) <- fromIntegral <$> bufferReadWord8IO b 1
>>> (y :: Word16) <- fromIntegral <$> bufferReadWord8IO b 2
>>> (((x `shiftL` 8) .|. y) == v)   ||   (((y `shiftL` 8) .|. x) == v)
True

Write a Word32, offset in bytes

We don't check that the offset is valid

>>> b <- newBuffer 10
>>> let v = 1234 :: Word32
>>> bufferWriteWord32IO b 1 v
>>> bufferReadWord32IO b 1
1234

Write a Word64, offset in bytes

We don't check that the offset is valid

>>> b <- newBuffer 10
>>> let v = 1234 :: Word64
>>> bufferWriteWord64IO b 1 v
>>> bufferReadWord64IO b 1
1234

Copy a buffer into another from/to the given offsets

We don't check buffer limits.

>>> let b = [0,1,2,3,4,5,6,7,8] :: BufferI
>>> b2 <- newBuffer 8
>>> copyBuffer b 4 b2 0 4
>>> copyBuffer b 0 b2 4 4
>>> forM [0..7] (bufferReadWord8IO b2)
[4,5,6,7,0,1,2,3]

Add a finalizer.

The latest added finalizers are executed first. Finalizers are not guaranteed to run (e.g. if the program exits before the buffer is collected).

Make a buffer finalizable

The new buffer liveness is used to trigger finalizers.

Touch a buffer

Touch a data

Get contents as a list of bytes