Struct Usage 

pub struct Usage {
    pub input_tokens: u32,
    pub output_tokens: u32,
    pub total_tokens: u32,
}

Token usage statistics for a single LLM call.

This is the canonical usage type for the entire workspace. It stores token counts as u32 (token counts are never negative). The fields use the clawft naming convention (input_tokens, output_tokens), but serde aliases allow deserialization from the OpenAI naming convention (prompt_tokens, completion_tokens) as well.

Fields

input_tokens: u32

Tokens consumed by the prompt / input.

Deserializes from either "input_tokens" or "prompt_tokens".

output_tokens: u32

Tokens generated in the response.

Deserializes from either "output_tokens" or "completion_tokens".

total_tokens: u32

Total tokens used (input + output).

When deserializing from providers that include total_tokens, this field is populated directly. Otherwise it defaults to 0 and callers can use Usage::total to compute it.

Implementations

impl Usage

pub fn total(&self) -> u32

Returns the total token count.

If total_tokens was populated by the provider, returns that value. Otherwise computes input_tokens + output_tokens.

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

impl Eq for Usage

impl StructuralPartialEq for Usage