Skip to main content

TemplateCompactor

Struct TemplateCompactor 

Source
pub struct TemplateCompactor { /* private fields */ }
Expand description

A zero-dependency reference Compactor that produces a textual rollup of evicted messages without calling an LLM.

The artifact is a single Message::System whose body concatenates a header, the previous summary (if any), and the textual content of each newly-evicted message. It is intentionally simple: useful as a default for tests and examples, and as a placeholder before wiring a real summarising LLM through a custom Compactor implementation.

§Bounding the summary

By default the summary grows monotonically: every compaction pass embeds the previous summary verbatim and appends newly-evicted lines. Long-running conversations should call Self::with_max_bytes to cap the rolled-up text. When the cap is exceeded, the oldest portion of the body (after the header) is dropped at a UTF-8 boundary and replaced with a "[…truncated…]" marker, preserving the most recent context.

§Example

use rig_memory::TemplateCompactor;

// Default header is "[Conversation summary so far]", unbounded.
let _compactor = TemplateCompactor::new();

// Custom header plus a 4 KiB cap for use with token-budgeted policies.
let _bounded = TemplateCompactor::with_header("Earlier context")
    .with_max_bytes(4 * 1024);

Implementations§

Source§

impl TemplateCompactor

Source

pub fn new() -> Self

Create a TemplateCompactor with the default header "[Conversation summary so far]" and no size cap.

Source

pub fn with_header(header: impl Into<String>) -> Self

Create a TemplateCompactor with a custom header line and no size cap.

Source

pub fn with_max_bytes(self, max_bytes: usize) -> Self

Cap the rolled-up summary at max_bytes bytes (UTF-8). When the assembled body exceeds the cap, the oldest portion after the header is dropped at a char boundary and replaced with a "[…truncated…]" marker.

max_bytes of 0 disables truncation (equivalent to the default unbounded behaviour). The header line plus the marker are always preserved even if they exceed the cap.

Trait Implementations§

Source§

impl Clone for TemplateCompactor

Source§

fn clone(&self) -> TemplateCompactor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Compactor for TemplateCompactor

Source§

type Artifact = TextSummary

The summary value produced by Compactor::compact. Read more
Source§

fn compact<'a>( &'a self, _conversation_id: &'a str, evicted: &'a [Message], carry_over: Option<&'a Self::Artifact>, ) -> WasmBoxedFuture<'a, Result<Self::Artifact, MemoryError>>

Produce a summary artifact for evicted, optionally combining it with the previous summary in carry_over. Read more
Source§

impl Debug for TemplateCompactor

Source§

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

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

impl Default for TemplateCompactor

Source§

fn default() -> Self

Returns the “default value” for a type. 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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> 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> 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,