Struct Usage 

pub struct Usage {
    pub input_tokens: Option<u64>,
    pub cache: Option<Box<InputCacheUsage>>,
    pub output_tokens: Option<u64>,
    pub total_tokens: Option<u64>,
    pub reasoning_tokens: Option<u64>,
}

Normalized token usage counts.

Fields

input_tokens: Option<u64>

Non-cached input tokens. Provider codecs normalize aggregate OpenAI input counts by subtracting the cache detail fields.

cache: Option<Box<InputCacheUsage>>

Cache-read and cache-creation token detail, when reported.

output_tokens: Option<u64>

Generated output tokens, excluding reasoning detail when the provider reports it separately.

total_tokens: Option<u64>

Provider-reported or codec-computed total token count.

Codecs normalize OpenAI aggregate input counts before computing totals, so this may equal non-cached input plus cache detail plus output.

reasoning_tokens: Option<u64>

Reasoning output tokens, when reported separately.

Implementations

impl Usage

pub fn cache_details( cached_input_tokens: Option<u64>, cache_creation_input_tokens: Option<u64>, ) -> Option<Box<InputCacheUsage>>

Builds cache detail when at least one count is present.

pub fn cached_input_tokens(&self) -> Option<u64>

Returns the cache-read input-token count.

pub fn cache_creation_input_tokens(&self) -> Option<u64>

Returns the cache-creation input-token count.

pub fn set_cached_input_tokens(&mut self, value: u64)

Sets the cache-read count, allocating cache detail when needed.

pub fn set_cache_creation_input_tokens(&mut self, value: u64)

Sets the cache-creation count, allocating cache detail when needed.

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