Struct Usage 

pub struct Usage {
    pub requests: u64,
    pub input_tokens: u64,
    pub cache_write_tokens: u64,
    pub cache_read_tokens: u64,
    pub output_tokens: u64,
    pub total_tokens: u64,
    pub tool_calls: u64,
}

Token and request usage accumulated by model and runtime layers.

Fields

requests: u64

Number of provider requests.

input_tokens: u64

Input or prompt tokens.

Provider adapters should normalize this as total provider-billed input tokens for the request, including cache-write and cache-read tokens when those subtotals are present. Pricing helpers subtract the cache subtotals before applying cache-specific rates.

cache_write_tokens: u64

Tokens written to a provider prompt cache.

cache_read_tokens: u64

Tokens read from a provider prompt cache.

output_tokens: u64

Output or completion tokens.

total_tokens: u64

Total tokens.

tool_calls: u64

Number of successful function tool calls executed by the runtime.

Implementations

impl Usage

pub fn add_assign(&mut self, other: &Self)

Add another usage value into this one.

pub const fn is_empty(&self) -> bool

Return whether no usage has been recorded.

pub const fn with_additional_tool_calls(self, tool_calls: u64) -> Self

Return a copy with additional successful tool calls applied.

Trait Implementations

impl Clone for Usage

fn clone(&self) -> Usage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Usage

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

Formats the value using the given formatter.

impl Default for Usage

fn default() -> Usage

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Usage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Usage

impl PartialEq for Usage

fn eq(&self, other: &Usage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Usage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Usage