Struct Summary 

pub struct Summary {
    pub runs: u32,
    pub usd: f64,
    pub usage: TokenUsage,
    pub unreported_runs: u32,
    pub estimated_runs: u32,
}

Totals over some set of runs.

Fields

runs: u32

How many runs contributed.

usd: f64

Total cost in US dollars.

usage: TokenUsage

Total tokens.

unreported_runs: u32

How many runs reported nothing at all.

estimated_runs: u32

How many runs were priced from a rate card rather than measured.

Implementations

impl Summary

pub fn confidence(&self) -> CostSource

How much of this total is measured rather than inferred.

The weakest source wins: one unreported run in a hundred makes the whole figure a lower bound, and saying so is the point.

pub fn measured_share(&self) -> f64

Fraction of runs whose cost the runner actually reported, from 0.0 to 1.0.

Returns 1.0 for an empty summary: nothing is unaccounted for when nothing has run.

pub fn is_fully_measured(&self) -> bool

Returns true when every figure in this total came from a runner.

Trait Implementations

impl Clone for Summary

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Summary

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

Formats the value using the given formatter.

impl Default for Summary

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Summary

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Summary