Struct TokenOverview 

pub struct TokenOverview {

    pub estimate_kind: String,
    pub estimator: String,
    pub estimate_scope: String,
    pub calls: usize,
    pub estimated_without_projectatlas: usize,
    pub estimated_with_projectatlas: usize,
    pub estimated_saved: isize,
    pub savings_rate: Option<f64>,
    pub buckets: Vec<TokenBucketOverview>,
    pub measured_tokens_saved: isize,
    pub gross_modeled_tokens_avoided: isize,
    pub deduped_modeled_tokens_avoided: isize,
    pub average_modeled_tokens_avoided: isize,
    pub average_tokens_avoided: isize,
    pub maximum_tokens_avoided: isize,
    pub average_policy: TokenAveragePolicy,
    pub tokens_avoided: isize,
    pub legacy_gross_estimated_saved: isize,
    pub repeated_baselines_deduped: usize,
    pub observed_file_read_replacements: usize,
    pub modeled_file_reads_avoided: usize,
    pub likely_file_reads_avoided: usize,
    pub read_avoidance_scope: String,
    pub read_avoidance_confidence: String,
    pub calibration: Option<TokenCalibrationOverview>,
    pub detail_availability: UsageDetailAvailability,
    pub agent_efficiency: AgentEfficiencyComparison,
}

Token savings overview.

Fields

estimate_kind: String

Counting mode for the reported numbers.

estimator: String

Estimator used to produce the reported numbers.

estimate_scope: String

Scope and accuracy boundary for the reported numbers.

calls: usize

Number of tracked calls.

estimated_without_projectatlas: usize

Total baseline estimate.

estimated_with_projectatlas: usize

Total ProjectAtlas estimate.

estimated_saved: isize

Total saved tokens.

savings_rate: Option<f64>

Signed savings ratio, or None when the baseline estimate is zero.

buckets: Vec<TokenBucketOverview>

Bucketed token savings grouped by baseline and accuracy semantics.

measured_tokens_saved: isize

Observed before/after saved tokens.

gross_modeled_tokens_avoided: isize

Gross modeled avoided-token estimate before dedupe.

deduped_modeled_tokens_avoided: isize

Deduped modeled avoided-token estimate.

average_modeled_tokens_avoided: isize

Average-policy modeled avoided-token estimate.

average_tokens_avoided: isize

Explicit average-policy tokens avoided estimate.

maximum_tokens_avoided: isize

Explicit all-files maximum tokens avoided estimate.

average_policy: TokenAveragePolicy

Fixed policy metadata shared by JSON, TOON, CLI, and MCP reports.

tokens_avoided: isize

Primary compatibility alias for average_tokens_avoided.

legacy_gross_estimated_saved: isize

Legacy all-bucket gross estimate retained for migration diagnostics.

repeated_baselines_deduped: usize

Number of duplicate modeled baseline events collapsed by dedupe.

observed_file_read_replacements: usize

Observed ProjectAtlas summary/search/slice calls compared with whole-file reads.

modeled_file_reads_avoided: usize

Modeled ProjectAtlas navigation calls that likely avoided whole-file reads.

likely_file_reads_avoided: usize

Total likely whole-file reads avoided.

read_avoidance_scope: String

Scope label for read-avoidance counters.

read_avoidance_confidence: String

Confidence label for read-avoidance counters.

calibration: Option<TokenCalibrationOverview>

Optional local tokenizer calibration for indexed UTF-8 files.

detail_availability: UsageDetailAvailability

Availability of caller-label and retained raw detail for this report.

agent_efficiency: AgentEfficiencyComparison

Optional validated controlled benchmark evidence kept separate from live accounting.

Implementations

impl TokenOverview

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

Build an overview from usage events.

pub fn from_estimated_totals(calls: u128, without: u128, with: u128) -> Self

Build an overview from aggregate heuristic token totals.

pub fn from_buckets(buckets: Vec<TokenBucketOverview>) -> Self

Build an overview from pre-aggregated buckets.

pub fn set_calibration(&mut self, calibration: TokenCalibrationOverview)

Attach a local tokenizer calibration section.

pub fn set_agent_efficiency(&mut self, comparison: AgentEfficiencyComparison)

Attach one validated controlled benchmark comparison.

pub fn apply_accounting_totals(&mut self, totals: TokenAccountingTotals)

Apply exact separated accounting totals loaded from durable aggregates.

pub const fn set_detail_availability( &mut self, availability: UsageDetailAvailability, )

Set the truth state for caller-label and retained raw detail.

pub fn apply_accounting_from_events(&mut self, events: &[UsageEvent])

Apply separated measured/modeled accounting totals from raw usage events.

Trait Implementations

impl Clone for TokenOverview

fn clone(&self) -> TokenOverview

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenOverview

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TokenOverview

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TokenOverview

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

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 TokenOverview