Buffer

Documentation

type BufferPtr = AlignedBlockPtr BufferAlignment Prim

data Buffer (n :: Nat)

A buffer buf :: Buffer n is a memory element that has enough space for the n blocks of the primitive and, if required by the implementation, any additional blocks that might be used for padding of the last chunk of message.

Instances

KnownNat n => Memory (Buffer n)

Defined in Buffer

Methods

memoryAlloc :: Alloc (Buffer n)

unsafeToPointer :: Buffer n -> Ptr Word8

KnownNat n => ReadAccessible (Buffer n)

Defined in Buffer

Methods

beforeReadAdjustment :: Buffer n -> IO ()

readAccess :: Buffer n -> [Access]

KnownNat n => WriteAccessible (Buffer n)

Defined in Buffer

Methods

writeAccess :: Buffer n -> [Access]

afterWriteAdjustment :: Buffer n -> IO ()

withBufferPtr :: KnownNat n => (BufferPtr -> BlockCount Prim -> a) -> Buffer n -> a

Run the action on the buffer pointer.

unsafeWithBufferPtr :: KnownNat n => (BufferPtr -> a) -> Buffer n -> a

This takes a buffer pointer action and runs it with the underlying pointer associated with the buffer. The action is supposed to use

memsetBuffer :: KnownNat n => Word8 -> Buffer n -> IO ()

Memset the given buffer.

Some unsafe functions

unsafeGetBufferPointer :: Buffer n -> BufferPtr

Get the underlying pointer for the buffer.

bufferSize :: KnownNat n => Proxy (Buffer n) -> BlockCount Prim

The size of data (measured in blocks) that can be safely processed inside this buffer.