Struct TokenEstimate 

pub struct TokenEstimate {
    pub model: String,
    pub request_tokens: usize,
    pub budget: usize,
}

Pre-flight estimate of the next request’s token footprint.

Emitted before the provider is contacted so the TUI can render budget-aware warnings (“73 % of 128k window”) and the compaction pipeline can decide whether to run a pre-emptive summary pass.

The budget field is the usable window after the implementation has subtracted its completion reserve and protocol overhead — it is not the raw context window from the model card.

Examples

use codetether_agent::session::TokenEstimate;

let est = TokenEstimate {
    model: "anthropic/claude-opus-4-7".into(),
    request_tokens: 94_000,
    budget: 128_000,
};
assert!(est.fraction() > 0.7);
assert!(!est.is_over_budget());

Fields

model: String

Provider-qualified model identifier the estimate targets.

request_tokens: usize

Estimated total request tokens (system + messages + tools).

budget: usize

Usable token budget for the request after reserves are subtracted.

Implementations

impl TokenEstimate

pub fn fraction(&self) -> f64

Fraction of the budget the request is projected to consume.

Returns 0.0 when budget == 0 rather than panicking, so callers may feed the value directly into UI colour ramps.

Examples

use codetether_agent::session::TokenEstimate;

let e = TokenEstimate { model: "m".into(), request_tokens: 50, budget: 100 };
assert!((e.fraction() - 0.5).abs() < 1e-9);

let z = TokenEstimate { model: "m".into(), request_tokens: 10, budget: 0 };
assert_eq!(z.fraction(), 0.0);

pub fn is_over_budget(&self) -> bool

Returns true when the estimate strictly exceeds the usable budget.

Examples

use codetether_agent::session::TokenEstimate;

let e = TokenEstimate { model: "m".into(), request_tokens: 129_000, budget: 128_000 };
assert!(e.is_over_budget());

Trait Implementations

impl Clone for TokenEstimate

fn clone(&self) -> TokenEstimate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenEstimate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TokenEstimate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TokenEstimate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.