Struct TokenUsage 

pub struct TokenUsage {
    pub input_tokens: u64,
    pub cached_input_tokens: Option<u64>,
    pub output_tokens: u64,
    pub reasoning_output_tokens: Option<u64>,
    pub total_tokens: u64,
}

Fields

input_tokens: u64

cached_input_tokens: Option<u64>

output_tokens: u64

reasoning_output_tokens: Option<u64>

total_tokens: u64

Implementations

impl TokenUsage

pub const fn is_zero(&self) -> bool

pub fn cached_input(&self) -> u64

pub fn non_cached_input(&self) -> u64

pub fn blended_total(&self) -> u64

Primary count for display as a single absolute value: non-cached input + output.

pub fn tokens_in_context_window(&self) -> u64

For estimating what % of the model’s context window is used, we need to account for reasoning output tokens from prior turns being dropped from the context window. We approximate this here by subtracting reasoning output tokens from the total. This will be off for the current turn and pending function calls.

pub fn percent_of_context_window_remaining( &self, context_window: u64, baseline_used_tokens: u64, ) -> u8

Estimate the remaining user-controllable percentage of the model’s context window.

context_window is the total size of the model’s context window. baseline_used_tokens should capture tokens that are always present in the context (e.g., system prompt and fixed tool instructions) so that the percentage reflects the portion the user can influence.

This normalizes both the numerator and denominator by subtracting the baseline, so immediately after the first prompt the UI shows 100% left and trends toward 0% as the user fills the effective window.

Trait Implementations

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 From<TokenUsage> for FinalOutput

fn from(token_usage: TokenUsage) -> FinalOutput

Converts to this type from the input type.

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.