TokenUsage

Struct TokenUsage 

Source
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§

Source§

impl TokenUsage

Source

pub const fn is_zero(&self) -> bool

Source

pub fn cached_input(&self) -> u64

Source

pub fn non_cached_input(&self) -> u64

Source

pub fn blended_total(&self) -> u64

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

Source

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.

Source

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§

Source§

impl Clone for TokenUsage

Source§

fn clone(&self) -> TokenUsage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TokenUsage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TokenUsage

Source§

fn default() -> TokenUsage

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<TokenUsage> for FinalOutput

Source§

fn from(token_usage: TokenUsage) -> Self

Converts to this type from the input type.
Source§

impl Serialize for TokenUsage

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,