Struct TokenUsage 

pub struct TokenUsage {
    pub prompt_tokens: u64,
    pub cached_prompt_tokens: u64,
    pub input_image_tokens: u64,
    pub input_audio_tokens: u64,
    pub content_tokens: u64,
    pub reasoning_tokens: u64,
    pub tool_call_tokens: u64,
    pub undeterminable_tokens: u64,
}

Fields

prompt_tokens: u64

cached_prompt_tokens: u64

input_image_tokens: u64

input_audio_tokens: u64

content_tokens: u64

reasoning_tokens: u64

tool_call_tokens: u64

undeterminable_tokens: u64

Implementations

impl TokenUsage

pub const fn new() -> TokenUsage

pub const fn record_prompt_tokens(&mut self, count: u64)

pub const fn record_cached_prompt_tokens( &mut self, count: u64, ) -> Result<(), TokenUsageError>

Errors

Returns TokenUsageError::CachedExceedsPrompt when the running cached total would exceed Self::prompt_tokens.

pub const fn record_input_image_tokens(&mut self, count: u64)

pub const fn record_input_audio_tokens(&mut self, count: u64)

pub const fn record_content_token(&mut self)

pub const fn record_reasoning_token(&mut self)

pub const fn record_tool_call_token(&mut self)

pub const fn record_undeterminable_token(&mut self)

pub const fn completion_tokens(&self) -> u64

pub const fn total_tokens(&self) -> u64

Trait Implementations

impl Add<&TokenUsage> for TokenUsage

type Output = TokenUsage

The resulting type after applying the + operator.

fn add(self, other: &TokenUsage) -> TokenUsage

Performs the + operation.

impl Add for TokenUsage

type Output = TokenUsage

The resulting type after applying the + operator.

fn add(self, other: TokenUsage) -> TokenUsage

Performs the + operation.

impl AddAssign<&TokenUsage> for TokenUsage

fn add_assign(&mut self, other: &TokenUsage)

Performs the += operation.

impl AddAssign for TokenUsage

fn add_assign(&mut self, other: TokenUsage)

Performs the += operation.

impl Clone for TokenUsage

fn clone(&self) -> TokenUsage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenUsage

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

Formats the value using the given formatter.

impl Default for TokenUsage

fn default() -> TokenUsage

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TokenUsage

fn deserialize<__D>( __deserializer: __D, ) -> Result<TokenUsage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TokenUsage

fn eq(&self, other: &TokenUsage) -> 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 TokenUsage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'usage> Sum<&'usage TokenUsage> for TokenUsage

fn sum<TIter>(iter: TIter) -> TokenUsage

where TIter: Iterator<Item = &'usage TokenUsage>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for TokenUsage

fn sum<TIter>(iter: TIter) -> TokenUsage

where TIter: Iterator<Item = TokenUsage>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for TokenUsage

impl Eq for TokenUsage

impl StructuralPartialEq for TokenUsage