Skip to main content

TokenUsage

Struct TokenUsage 

Source
pub struct TokenUsage {
    pub input_tokens: Option<u64>,
    pub output_tokens: Option<u64>,
    pub cached_input_tokens: Option<u64>,
}
Expand description

Raw token counts from a single LLM API response.

Contract: input_tokens is the total prompt size sent to the model (every token the model saw, regardless of cache state). cached_input_tokens is the subset of input_tokens that was served from the prompt cache. So cached_input_tokens <= input_tokens, and the billable uncached portion is input_tokens - cached_input_tokens.

Providers normalize to this shape:

  • OpenAI/Compatible: prompt_tokens is already total, cached_tokens is already a subset — used directly.
  • Anthropic: the API reports three DISJOINT buckets per https://docs.anthropic.com/en/docs/build-with-claude/prompt-caching: total_input = cache_read_input_tokens + cache_creation_input_tokens + input_tokens, where Anthropic’s input_tokens is only the tokens after the last cache breakpoint. The adapter sums all three to produce the total here. cached_input_tokens is set to cache_read_input_tokens (the discount-billed subset).

Fields§

§input_tokens: Option<u64>

Total prompt size: uncached + cached input tokens.

§output_tokens: Option<u64>§cached_input_tokens: Option<u64>

Subset of input_tokens that was served from the model_provider’s prompt cache (Anthropic cache_read_input_tokens, OpenAI prompt_tokens_details.cached_tokens).

Trait Implementations§

Source§

impl Clone for TokenUsage

Source§

fn clone(&self) -> TokenUsage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TokenUsage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TokenUsage

Source§

fn default() -> TokenUsage

Returns the “default value” for a type. 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.