Struct Reservation 

pub struct Reservation { /* private fields */ }

A cancellation-safe reservation for one resource.

Implementations

impl Reservation

pub fn resource(&self) -> &Resource

Returns the resource held by this reservation.

pub fn amount(&self) -> u64

Returns the reserved amount.

pub fn commit(self, actual: u64) -> Result<(), BudgetError>

Reconciles actual usage and releases unused capacity.

If actual exceeds the reservation, the complete reservation is converted to consumed capacity before the error is returned. The caller is responsible for externally constraining operations when a hard upper bound is required.

Errors

Returns BudgetError::ReservationExceeded after retaining the full reservation as consumed when actual exceeds the reserved amount.

pub fn release(self)

Explicitly releases the complete reservation.

Trait Implementations

impl Debug for Reservation

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

Formats the value using the given formatter.

impl Drop for Reservation

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.