Struct CacheStats 

pub struct CacheStats {
    pub call_count: u64,
    pub total_input_tokens: u64,
    pub total_output_tokens: u64,
    pub total_cache_creation_input_tokens: u64,
    pub total_cache_read_input_tokens: u64,
    pub total_cached_input_tokens: u64,
}

Aggregated prompt-cache statistics over a window of events.

Fields

call_count: u64

Number of UsageRecorded events observed.

total_input_tokens: u64

Sum of UsageRecorded.usage.input_tokens across the window.

total_output_tokens: u64

Sum of UsageRecorded.usage.output_tokens across the window.

total_cache_creation_input_tokens: u64

Sum of CacheMetrics::cache_creation_input_tokens.

Populated by Anthropic for input tokens that were written to a cache entry during this run. None per-event is treated as 0.

total_cache_read_input_tokens: u64

Sum of CacheMetrics::cache_read_input_tokens.

Populated by Anthropic and DeepSeek for input tokens served from an existing cache entry.

total_cached_input_tokens: u64

Sum of CacheMetrics::cached_input_tokens.

Populated by OpenAI’s prompt_tokens_details.cached_tokens.

Implementations

impl CacheStats

pub fn from_events(events: &[AgentEvent]) -> Self

Computes aggregate stats by walking a slice of AgentEvent values in arrival order.

Events that are neither UsageRecorded nor CacheMetrics are ignored. Order does not matter for accumulation but is preserved for deterministic output in the returned Debug print.

pub fn from_envelopes(envelopes: &[RuntimeEventEnvelope]) -> Self

Computes aggregate stats from a slice of RuntimeEventEnvelope values (the shape returned by RuntimeEventStore::list_after).

pub const fn total_cache_tokens(&self) -> u64

Returns the total cache-related input tokens across all three provider-specific fields.

pub fn cache_hit_rate(&self) -> f64

Returns the fraction of input tokens that came from cache.

The denominator is input_tokens + cache_creation + cache_read + cached — the total input tokens actually processed by the provider, whether fresh or served from cache. The numerator is cache_read + cached (tokens that were served from a cache entry instead of recomputed).

Returns 0.0 when the window contains no input tokens.

pub fn merge(self, other: Self) -> Self

Combines two CacheStats by summing every field. Useful for aggregating per-run stats into a session-level or session-store-wide total.

Uses saturating_add to match Self::from_events and to remain panic-free at the u64 boundary when aggregating very long runs.

Trait Implementations

impl Clone for CacheStats

fn clone(&self) -> CacheStats

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheStats

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

Formats the value using the given formatter.

impl Default for CacheStats

fn default() -> CacheStats

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CacheStats

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CacheStats

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

Formats the value using the given formatter.

impl Eq for CacheStats

impl PartialEq for CacheStats

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

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 CacheStats