Struct BatchLease 

pub struct BatchLease<B: Batch> { /* private fields */ }

A batch whose retained bytes are charged to an execution context.

The charge is released only when the lease is dropped, keeping accounting aligned with the batch’s actual lifetime.

Implementations

impl<B: Batch> BatchLease<B>

pub fn try_new( batch: B, context: &ExecutionContext, ) -> Result<Self, MemoryBudgetError>

Charges the batch’s retained bytes and creates a lease.

Errors

Returns MemoryBudgetError::Exhausted when existing live batches and this batch would exceed the context budget.

pub fn try_from_reservation( batch: B, reservation: MemoryReservation, ) -> Result<Self, MemoryBudgetError>

Creates a lease from capacity reserved before consuming input.

Errors

Returns MemoryBudgetError::Exhausted if the batch retained more than the producer reserved before advancing its source.

pub fn try_from_reservation_recycling( batch: B, reservation: MemoryReservation, recycler: Arc<BatchBufferPool<B>>, ) -> Result<Self, MemoryBudgetError>

Creates a lease that returns its batch capacity and memory charge to a bounded pool when dropped. The producer transfers exclusive ownership; consumers share Arc<BatchLease<B>> so the charge cannot be detached.

Errors

Returns MemoryBudgetError::Exhausted if the batch retained more than the producer reserved before advancing its source.

pub fn batch(&self) -> &B

Borrows the retained batch.

Trait Implementations

impl<B: Batch + Debug> Debug for BatchLease<B>

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<B: Batch> Drop for BatchLease<B>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.