Struct Budget 

pub struct Budget { /* private fields */ }

A cloneable handle to one node in a hierarchical resource budget.

Implementations

impl Budget

pub fn builder() -> BudgetBuilder

Starts a root budget builder.

pub fn child(&self) -> BudgetBuilder

Starts a child builder whose operations will also count against this node.

pub fn id(&self) -> BudgetId

Returns this node’s process-local identifier.

pub fn consume( &self, resource: &Resource, amount: u64, ) -> Result<(), BudgetError>

Immediately and atomically consumes an amount across the entire lineage.

Errors

Returns an error when the request overflows, exceeds a limit, or begins after the effective deadline or cancellation request.

pub fn reserve( &self, resource: &Resource, amount: u64, ) -> Result<Reservation, BudgetError>

Atomically reserves capacity for one resource.

Errors

Returns an error when the request overflows, exceeds a limit, or begins after the effective deadline or cancellation request.

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

Atomically reserves several resources, combining duplicate entries.

The input is canonicalized by resource name. Overflow or exhaustion changes no accounting state.

Errors

Returns an error when canonicalization overflows, a request exceeds a limit, or the operation begins after the effective deadline or cancellation request.

pub fn remaining(&self, resource: &Resource) -> Remaining

Returns effective remaining capacity at one consistent instant.

The result is observational. Only Budget::consume, Budget::reserve, and Budget::reserve_many authorize work.

pub fn snapshot(&self) -> BudgetSnapshot

Captures a consistent snapshot across this node’s complete lineage.

Trait Implementations

impl Clone for Budget

fn clone(&self) -> Budget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Budget

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

Formats the value using the given formatter.