Skip to main content

ReservationSet

Struct ReservationSet 

Source
pub struct ReservationSet { /* private fields */ }
Expand description

An atomic, cancellation-safe reservation for several resources.

Implementations§

Source§

impl ReservationSet

Source

pub fn amounts(&self) -> &BTreeMap<Resource, u64>

Returns the canonical, resource-sorted reservation amounts.

Source

pub fn commit<'a>( self, actual: impl IntoIterator<Item = (&'a Resource, u64)>, ) -> Result<(), BudgetError>

Reconciles actual usage atomically and releases unused capacity.

Duplicate actual entries are combined with checked arithmetic. Omitted resources have zero actual usage. Unknown resources and arithmetic overflow fail closed by converting the full reservation set to consumed capacity before returning an error.

§Errors

Returns an error for unknown resources, duplicate-entry overflow, or actual usage beyond a reservation. Accounting is reconciled conservatively before every error is returned.

Source

pub fn commit_all(self)

Converts every reserved amount to consumed capacity.

Source

pub fn release(self)

Explicitly releases the complete reservation set.

Trait Implementations§

Source§

impl Debug for ReservationSet

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for ReservationSet

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more