Struct HeapBufferPool 

pub struct HeapBufferPool(/* private fields */);

A bounded, shareable collection of stable initialized slots in one contiguous slab. Construction reserves all payload storage; acquiring, freezing, slicing, and returning leases allocate no payload or reference-count wrappers.

Pools may be shared across connections and file pipelines. Exhaustion waits with cancellation instead of growing the pool. Retained views count against capacity. This portable implementation of BufferPool uses a heap allocation. Backends may supply another pool implementation with the same ownership contract.

Implementations

impl HeapBufferPool

pub fn new(buffers: usize, buffer_size: usize) -> Result<Self>

pub fn with_options(options: BufferPoolOptions) -> Result<Self>

Reserve one contiguous initialized allocation. Slot starts satisfy the requested alignment; padding is outside the usable payload budget.

pub fn capacity(&self) -> usize

pub fn buffer_size(&self) -> usize

pub fn alignment(&self) -> usize

pub fn try_acquire(&self) -> Option<BufferLease>

Acquire exclusive writable storage immediately, or return None without allocating.

pub async fn acquire( &self, cancellation: &Cancellation, ) -> Result<BufferLease, Cancelled>

Wait for one lease. Pre-cancellation leaves capacity unchanged; a successfully acquired lease wins a later cancellation race.

Trait Implementations

impl BufferPool for HeapBufferPool

type Buffer = BufferLease

fn capacity(&self) -> usize

Total slot capacity, including leased and published buffers, rather than the number currently free. Worker-local caches are part of this total.

fn buffer_size(&self) -> usize

fn alignment(&self) -> usize

fn try_acquire(&self) -> Option<Self::Buffer>

Acquire immediately, or return None without waiting for capacity.

async fn acquire( &self, cancellation: &Cancellation, ) -> Result<Self::Buffer, Cancelled>

Pre-cancellation leaves capacity unchanged. Acquisition wins a subsequent cancellation race. Dropping or forgetting a pending acquisition must not release storage still accessible by another owner.

impl Clone for HeapBufferPool

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.