Struct Usage 

#[non_exhaustive]
pub struct Usage {
    pub input_tokens: u32,
    pub output_tokens: u32,
    pub total_tokens: u32,
    pub cache_read_tokens: u32,
    pub cache_creation_tokens: u32,
    pub reasoning_tokens: u32,
    pub api_duration_ms: u64,
    pub prompt_details: PromptTokensDetails,
    pub completion_details: CompletionTokensDetails,
}

Aggregated token usage for a sample or turn.

Fields (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

Input / prompt tokens.

output_tokens: u32

Output / completion tokens.

total_tokens: u32

Total tokens when provided by the provider.

cache_read_tokens: u32

Cache-read tokens (provider-specific; ledger convenience field).

cache_creation_tokens: u32

Cache-creation / write tokens.

reasoning_tokens: u32

Reasoning tokens (top-level mirror of completion details when set).

api_duration_ms: u64

Provider API wall time for this sample, when known (milliseconds).

prompt_details: PromptTokensDetails

Prompt details.

completion_details: CompletionTokensDetails

Completion details.

Implementations

impl Usage

pub const fn zero() -> Self

Zero usage.

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

Construct from input/output token counts.

pub const fn normalized(self) -> Self

Recompute total_tokens as input + output when total is zero.

Trait Implementations

impl Add for Usage

type Output = Usage

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Usage

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

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

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

Equality operator ==.

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

Inequality operator !=.

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