pub struct CompactionPolicyDeclaration {
pub strategy: PolicyStrategy,
pub max_tokens: Option<usize>,
pub max_turns: Option<usize>,
pub context_window: Option<usize>,
pub safety_ratio: f64,
pub keep_last: usize,
pub keep_first: usize,
pub hard_limit_tokens: Option<usize>,
pub tool_output_max_chars: Option<usize>,
pub summarize_fn: Option<VmValue>,
pub summarize_prompt: Option<String>,
pub instructions: CompactionPolicy,
}Expand description
Declared inputs that drive the compaction_check decision and the
downstream compaction_run call. Values are normalized at registration
time so consumers can rely on every threshold being either populated
or explicitly None.
Fields§
§strategy: PolicyStrategy§max_tokens: Option<usize>Hard cap on estimated tokens before compaction_check returns
compact_now. None means tokens alone never trigger.
max_turns: Option<usize>Hard cap on message count. None means message count alone never
triggers.
context_window: Option<usize>When context_window is set, compaction_check fires when
estimated tokens exceed context_window * safety_ratio. Both must
be set for the ratio rule to apply.
safety_ratio: f64§keep_last: usizeHow many recent messages to keep verbatim during compaction.
keep_first: usizeHow many initial messages to keep verbatim during compaction.
hard_limit_tokens: Option<usize>Token budget passed through to the engine for tier-2 compaction
(used by summarize-then-prune to escalate from LLM to truncate
when the LLM result still exceeds the cap).
tool_output_max_chars: Option<usize>Per-tool-result microcompaction threshold. None keeps the engine
default.
summarize_fn: Option<VmValue>Closure invoked when strategy is custom.
summarize_prompt: Option<String>Optional prompt template path used when the engine selects LLM summarization.
instructions: CompactionPolicyAuthor/scope/preserve/drop directives that the engine threads through the LLM compaction prompt and persisted metadata.
Implementations§
Source§impl CompactionPolicyDeclaration
impl CompactionPolicyDeclaration
Sourcepub fn token_threshold(&self) -> Option<usize>
pub fn token_threshold(&self) -> Option<usize>
Token budget at which the policy considers a session “full”.
Resolves the most restrictive of max_tokens and
context_window * safety_ratio; returns None when neither rule
is configured.
Sourcepub fn evaluate(
&self,
estimated_tokens: usize,
message_count: usize,
) -> EvaluationContext
pub fn evaluate( &self, estimated_tokens: usize, message_count: usize, ) -> EvaluationContext
Decision metadata describing every triggered threshold. Returned
as part of the CompactionDecision so callers can log what
pushed them over the line.
Trait Implementations§
Source§impl Clone for CompactionPolicyDeclaration
impl Clone for CompactionPolicyDeclaration
Source§fn clone(&self) -> CompactionPolicyDeclaration
fn clone(&self) -> CompactionPolicyDeclaration
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CompactionPolicyDeclaration
impl Debug for CompactionPolicyDeclaration
Auto Trait Implementations§
impl Freeze for CompactionPolicyDeclaration
impl !RefUnwindSafe for CompactionPolicyDeclaration
impl !Send for CompactionPolicyDeclaration
impl !Sync for CompactionPolicyDeclaration
impl Unpin for CompactionPolicyDeclaration
impl UnsafeUnpin for CompactionPolicyDeclaration
impl !UnwindSafe for CompactionPolicyDeclaration
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);