Skip to main content

Usage

Struct Usage 

Source
pub struct Usage {
    pub input_tokens: u32,
    pub output_tokens: u32,
    pub cache_read_tokens: Option<u32>,
    pub cache_creation_tokens: Option<u32>,
}
Expand description

Token usage for one model response.

Convention, uniform across every provider mapping: input_tokens is the full, cache-inclusive prompt size. It always contains cache_read_tokens as a subset (verified live: OpenAI/OpenRouter/DeepSeek report it inside prompt_tokens; the Anthropic mapping adds it back since that API reports input net of cache). cache_creation_tokens is likewise inside input_tokens for providers that report cache writes (Anthropic); the OpenAI-style providers we use don’t report writes at all. So Usage::total (input + output) is the context-window occupancy.

For cost, the cache buckets bill at different rates, so subtract them from the input rate instead of charging the full rate twice: cost = (input - cache_read - cache_creation)·p_in + cache_read·p_cache_read + cache_creation·p_cache_write + output·p_out.

Fields§

§input_tokens: u32

Full prompt tokens, cache-inclusive (a superset of the two cache fields).

§output_tokens: u32

Generated output (completion) tokens.

§cache_read_tokens: Option<u32>

Subset of input_tokens served from the prompt cache (cheaper rate).

§cache_creation_tokens: Option<u32>

Subset of input_tokens written into the prompt cache (surcharge rate).

Implementations§

Source§

impl Usage

Source

pub fn new(input_tokens: u32, output_tokens: u32) -> Self

Source

pub fn total(&self) -> u32

Context-window occupancy: the full (cache-inclusive) prompt plus output.

Trait Implementations§

Source§

impl Add for Usage

Source§

type Output = Usage

The resulting type after applying the + operator.
Source§

fn add(self, other: Usage) -> Usage

Performs the + operation. Read more
Source§

impl AddAssign for Usage

Source§

fn add_assign(&mut self, other: Usage)

Performs the += operation. Read more
Source§

impl Clone for Usage

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 Copy for Usage

Source§

impl Debug for Usage

Source§

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

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

impl Default for Usage

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Usage
where Usage: Default,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Usage

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Usage

§

impl RefUnwindSafe for Usage

§

impl Send for Usage

§

impl Sync for Usage

§

impl Unpin for Usage

§

impl UnsafeUnpin for Usage

§

impl UnwindSafe for Usage

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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.