Skip to main content

TokenBudget

Struct TokenBudget 

Source
pub struct TokenBudget {
Show 14 fields pub max_context_tokens: u32, pub max_output_tokens: u32, pub strategy: BudgetStrategy, pub safety_margin: u32, pub compression_trigger_percent: u8, pub compression_target_percent: u8, pub working_reserve_tokens: u32, pub fallback_trigger_percent: u8, pub prompt_cache_min_tool_output_chars: u32, pub prompt_cache_head_chars: u32, pub prompt_cache_tail_chars: u32, pub prompt_cache_recent_user_turns: u8, pub prompt_cache_recent_tool_chains: u8, pub max_tool_output_tokens: u32,
}
Expand description

Token budget configuration for a conversation.

Fields§

§max_context_tokens: u32

Maximum context window size for the model (input + output)

§max_output_tokens: u32

Maximum tokens reserved for model output

§strategy: BudgetStrategy

Budget enforcement strategy

§safety_margin: u32

Safety margin for tokenizer estimation errors

§compression_trigger_percent: u8

Proactive compression trigger threshold as a percentage of context window tokens.

Legacy field — only used when working_reserve_tokens == 0.

§compression_target_percent: u8

Compression target threshold as a percentage of context window tokens.

§working_reserve_tokens: u32

Fixed number of tokens reserved for model reasoning and output.

Compression triggers when (max_context_tokens - working_reserve_tokens) is exceeded. This provides consistent reasoning space regardless of model context window size (Claude Code uses ~50K).

When working_reserve_tokens == 0, falls back to percentage-based triggering via compression_trigger_percent for backward compatibility.

§fallback_trigger_percent: u8

Fallback percentage trigger when the context window is too small for the fixed reserve (i.e. max_context_tokens < working_reserve_tokens * 2).

§prompt_cache_min_tool_output_chars: u32

Minimum tool output character length required before prompt-side cache compaction.

§prompt_cache_head_chars: u32

Leading excerpt length (chars) kept in cached tool output summaries.

§prompt_cache_tail_chars: u32

Trailing excerpt length (chars) kept in cached tool output summaries.

§prompt_cache_recent_user_turns: u8

Number of latest user turns protected from prompt-side cache compaction.

§prompt_cache_recent_tool_chains: u8

Number of latest tool call chains protected from prompt-side cache compaction.

§max_tool_output_tokens: u32

Maximum tokens allowed per single tool output. 0 = use byte-based fallback only.

Implementations§

Source§

impl TokenBudget

Source

pub fn new( max_context_tokens: u32, max_output_tokens: u32, strategy: BudgetStrategy, ) -> TokenBudget

Source

pub fn with_safety_margin( max_context_tokens: u32, max_output_tokens: u32, strategy: BudgetStrategy, safety_margin: u32, ) -> TokenBudget

Source

pub fn compression_trigger_context_tokens(&self) -> u32

Source

pub fn compression_target_context_tokens(&self) -> u32

Source

pub fn for_model(max_context_tokens: u32) -> TokenBudget

Trait Implementations§

Source§

impl Clone for TokenBudget

Source§

fn clone(&self) -> TokenBudget

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TokenBudget

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TokenBudget

Source§

fn default() -> TokenBudget

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for TokenBudget

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<TokenBudget, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for TokenBudget

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,