Skip to main content

Usage

Struct Usage 

Source
#[non_exhaustive]
pub struct Usage { pub input_tokens: u32, pub output_tokens: u32, pub cached_input_tokens: u32, pub cache_creation_input_tokens: u32, pub cache_creation_5m_tokens: u32, pub cache_creation_1h_tokens: u32, }
Expand description

Token counters reported by the provider for a turn.

Aggregated to the run level by the engine and surfaced on StreamChunk::RunFinished / StreamChunk::TurnFinished. Fields not surfaced by a given provider stay at 0.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§input_tokens: u32

Total prompt tokens charged this turn (cached + uncached).

§output_tokens: u32

Tokens generated by the model this turn.

§cached_input_tokens: u32

Subset of input_tokens that were served from prompt cache rather than recomputed. Zero when the provider does not support prompt caching or when this turn missed the cache.

§cache_creation_input_tokens: u32

Total tokens written to a cache during this turn. When the provider reports a TTL breakdown (Anthropic), this equals the sum of Self::cache_creation_5m_tokens + Self::cache_creation_1h_tokens. When only the legacy flat field is reported, the breakdown stays at zero and only this total is populated.

§cache_creation_5m_tokens: u32

Cache writes with a 5-minute TTL (Anthropic ephemeral default). Zero when the provider does not surface a TTL breakdown.

§cache_creation_1h_tokens: u32

Cache writes with a 1-hour TTL (Anthropic explicit ttl=“1h”). Zero when the provider does not surface a TTL breakdown.

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) -> Usage

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 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() -> Usage

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

impl Copy for Usage

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> 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.