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>

Reserve buffers slots of buffer_size bytes each, with an alignment of 1. This is with_options applied to BufferPoolOptions::new.

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.

Returns io::ErrorKind::InvalidInput if buffers or buffer_size is zero, the alignment is not a power of two, or the total allocation is not representable.

pub fn capacity(&self) -> usize

The total number of slots, including leased and frozen ones.

pub fn buffer_size(&self) -> usize

The usable length, in bytes, of each slot.

pub fn alignment(&self) -> usize

The requested minimum alignment, in bytes, of each slot’s first byte.

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

The exclusively writable receive storage returned by acquisition.

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

The initialized length, in bytes, of each acquired buffer.

fn alignment(&self) -> usize

The minimum alignment, in bytes, of each acquired buffer’s first byte.

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.