Struct ContextUsageSnapshot 

pub struct ContextUsageSnapshot {
    pub used_tokens: usize,
    pub max_tokens: Option<usize>,
    pub remaining_tokens: Option<usize>,
    pub used_percent: Option<u8>,
    pub source: TokenUsageSource,
    pub prompt_tokens: usize,
    pub cached_input_tokens: usize,
    pub cache_creation_input_tokens: usize,
    pub completion_tokens: usize,
    pub reasoning_output_tokens: usize,
    pub breakdown: Option<PromptTokenBreakdown>,
}

The model-visible context for the latest request. This is separate from cumulative session usage, which is an API/accounting total.

Fields

used_tokens: usize

max_tokens: Option<usize>

remaining_tokens: Option<usize>

used_percent: Option<u8>

source: TokenUsageSource

prompt_tokens: usize

cached_input_tokens: usize

cache_creation_input_tokens: usize

completion_tokens: usize

reasoning_output_tokens: usize

breakdown: Option<PromptTokenBreakdown>

Implementations

impl ContextUsageSnapshot

pub fn from_usage(usage: &TokenUsage, max_tokens: Option<usize>) -> Self

pub fn from_estimate( breakdown: PromptTokenBreakdown, max_tokens: Option<usize>, ) -> Self

pub fn is_estimate(&self) -> bool

Trait Implementations

impl Clone for ContextUsageSnapshot

fn clone(&self) -> ContextUsageSnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContextUsageSnapshot

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

Formats the value using the given formatter.

impl PartialEq for ContextUsageSnapshot

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

impl StructuralPartialEq for ContextUsageSnapshot