Struct BudgetTracker 

pub struct BudgetTracker { /* private fields */ }

Thread-safe accounting shared by a run and its descendants.

Implementations

impl BudgetTracker

pub fn new(limit: Budget) -> Self

Creates a tracker with the given hard limits.

pub fn restore(limit: Budget, usage: Usage) -> Result<Self, BudgetExceeded>

Restores a tracker from a previously persisted usage snapshot.

Errors

Returns BudgetExceeded when usage already exceeds limit.

pub fn limit(&self) -> Budget

Returns the configured limits.

pub fn usage(&self) -> Usage

Returns a snapshot of cumulative usage.

pub fn try_consume(&self, delta: Usage) -> Result<Usage, BudgetExceeded>

Atomically consumes resources or leaves all counters unchanged.

Errors

Returns BudgetExceeded when any cumulative counter would exceed its configured limit or overflow.

pub fn try_reserve( &self, amount: Usage, ) -> Result<BudgetReservation, BudgetExceeded>

Atomically reserves one scoped budget share.

Errors

Returns BudgetExceeded without creating a reservation when the requested share and all existing commitments exceed a hard limit.

pub fn try_reserve_batch( &self, amounts: impl IntoIterator<Item = Usage>, ) -> Result<Vec<BudgetReservation>, BudgetExceeded>

Atomically reserves multiple independent budget shares.

Either every requested share is created in input order or none are.

Errors

Returns BudgetExceeded without changing reservation state when the complete batch would exceed a hard limit or overflow.

Trait Implementations

impl Clone for BudgetTracker

fn clone(&self) -> BudgetTracker

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BudgetTracker

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

Formats the value using the given formatter.