Struct RouterBudget 

pub struct RouterBudget { /* private fields */ }

A circuit breaker over cumulative spend and/or token usage.

Construct with one of the constructors, wrap in an Arc, and attach via super::RouterLLM::with_budget. Cloning is not supported; share by Arc so every call of one run observes the same totals.

Implementations

impl RouterBudget

pub fn with_cost_limit(max_cost_usd: f64) -> Self

Only a USD spend cap.

pub fn with_token_limit(max_tokens: u64) -> Self

Only a cumulative token cap.

pub fn with_cost_and_token_limits( max_cost_usd: f64, max_tokens: u64, ) -> Arc<Self>

Both a USD cap and a token cap; either one tripping skips the slot.

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

Configured USD cap, if any.

pub fn max_tokens(&self) -> Option<u64>

Configured token cap, if any.

pub fn spent_usd(&self) -> f64

Cumulative recorded USD spend.

pub fn tokens(&self) -> u64

Cumulative recorded token usage.

pub fn trips(&self) -> usize

Number of times a precheck or a post-call record crossed a cap.

pub fn is_tripped(&self) -> bool

Whether either cap is already crossed.

pub fn precheck( &self, projected_cost_usd: f64, projected_tokens: u64, ) -> Result<(), BudgetExceeded>

Projects one pending call and returns the dimension that would be exceeded, if any.

projected_cost_usd is the prompt priced against the slot’s price (0.0 for free/unpriced slots); projected_tokens is the prompt-token estimate. A projected zero-cost call always passes the cost dimension even while the breaker is tripped — that is what lets free fallbacks keep serving. The token dimension is price-agnostic.

pub fn record(&self, cost_usd: f64, total_tokens: u64) -> Option<BudgetExceeded>

Records the measured cost/tokens of one finished call.

Returns the first dimension this record pushed over its cap (the breaker latches — later prechecks keep skipping paid candidates).

pub fn reset(&self)

Zeroes accumulated spend/tokens/trip count (start a new run reusing the same budget configuration).

Trait Implementations

impl Debug for RouterBudget

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

Formats the value using the given formatter.