Struct BudgetTracker 

pub struct BudgetTracker { /* private fields */ }

Cumulative USD budget tracker with threshold callbacks.

See the module docs for the full design.

Implementations

impl BudgetTracker

pub fn builder() -> BudgetBuilder

Start building a tracker.

pub fn record(&self, cost_usd: f64)

Record an additional cost in USD. Fires on_warning the first time the running total reaches warn_at_usd, and on_exceeded the first time it reaches max_usd.

pub fn check(&self) -> Result<()>

Return Err(Error::BudgetExceeded) if the running total is at or above the configured max_usd. Returns Ok(()) when no ceiling is set.

pub fn total_usd(&self) -> f64

Cumulative cost recorded so far, in USD.

pub fn remaining_usd(&self) -> Option<f64>

Remaining budget in USD, if a ceiling is set. Clamped at zero once the ceiling is reached.

pub fn max_usd(&self) -> Option<f64>

Configured ceiling, if any.

pub fn warn_at_usd(&self) -> Option<f64>

Configured warning threshold, if any.

pub fn reset(&self)

Clear the running total and re-arm both callbacks.

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.