Skip to main content

CostTracker

Struct CostTracker 

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

Accumulates token usage and USD spend, optionally against a budget.

§Budget semantics

CostTracker::record checks the budget before mutating any state. A record that would push total spend past the limit is rejected with RouterError::BudgetExceeded and nothing is accumulated. Therefore, as long as every call is gated through record, tracked spend can never exceed the limit.

§Example

use model_router::{CostTracker, ModelPricing};

let tracker = CostTracker::new(Some(0.01)); // $0.01 budget
let pricing = ModelPricing::new(3.0, 15.0); // Claude Sonnet class

tracker.record("claude-sonnet-4", 100, 50, &pricing).unwrap();
assert!(tracker.total_usd() < 0.01);
assert!(!tracker.is_over_budget());

Implementations§

Source§

impl CostTracker

Source

pub fn new(budget_limit_usd: Option<f64>) -> Self

Create a new cost tracker, optionally with a USD budget limit.

Source

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

The configured budget limit in USD, if any.

Source

pub fn record( &self, model: &str, input_tokens: usize, output_tokens: usize, pricing: &ModelPricing, ) -> Result<(), RouterError>

Record token usage for model, priced with pricing.

Fails with RouterError::BudgetExceeded (without mutating any state) if the record would push total spend past the budget limit.

§Precision

Costs are accumulated in fixed point at $0.0001 granularity and truncated into that grid, so a recorded delta never exceeds the true cost and tracked totals err slightly low. Costs under $0.0001 (a hundredth of a cent) truncate to zero. The budget pre-check itself runs in f64, so enforcement precision is unaffected.

Source

pub fn total_usd(&self) -> f64

Total recorded cost in USD.

Source

pub fn total_input_tokens(&self) -> u64

Total input tokens recorded across all models.

Source

pub fn total_output_tokens(&self) -> u64

Total output tokens recorded across all models.

Source

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

Unspent budget in USD (None when no budget is configured). Never negative; zero once the budget is exhausted.

Source

pub fn per_model_breakdown(&self) -> BTreeMap<String, ModelCostBreakdown>

Per-model cost breakdown.

Source

pub fn is_over_budget(&self) -> bool

Whether total spend has reached or exceeded the budget limit.

Always false when no budget is configured.

Source

pub fn report(&self) -> CostReport

Build a CostReport snapshot of the current state.

Trait Implementations§

Source§

impl Clone for CostTracker

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CostTracker

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.