Struct Usage 

pub struct Usage { /* private fields */ }

Provider-neutral token usage.

Implementations

impl Usage

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

Creates usage with required input and output token counts.

pub const fn input_tokens(&self) -> TokenCount

Returns input tokens.

pub const fn output_tokens(&self) -> TokenCount

Returns output tokens.

pub const fn cache_read_tokens(&self) -> Option<TokenCount>

Returns cache-read tokens when reported.

pub const fn cache_write_tokens(&self) -> Option<TokenCount>

Returns cache-write tokens when reported.

pub const fn reasoning_tokens(&self) -> Option<TokenCount>

Returns reasoning tokens when reported.

pub const fn with_cache_read(self, value: TokenCount) -> Self

Adds the cache-read token count.

pub const fn with_cache_write(self, value: TokenCount) -> Self

Adds the cache-write token count.

pub fn with_reasoning(self, value: TokenCount) -> Result<Self, UsageError>

Adds reasoning tokens, which must be a subset of output tokens.

Errors

Returns UsageError::ReasoningExceedsOutput when the reasoning count exceeds the output count.

pub fn total_tokens(&self) -> Result<TokenCount, UsageError>

Returns the total billable/context token count without double-counting reasoning.

Errors

Returns UsageError::TotalOverflow when the sum overflows or exceeds the JSON safe-integer range.

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