Skip to main content

FileHistoryProvider

Struct FileHistoryProvider 

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

A HistoryProvider that persists to a JSON file on disk, loading any existing history from path on construction and rewriting the whole file after every successful run.

Persistence is atomic and concurrency-safe: after_run serializes the whole append→snapshot→write sequence behind an async write_lock (shared across clones), writes to a temporary sibling file, and atomically renames it into place. The in-memory history is only updated after the on-disk write succeeds, so a failed write never diverges memory from disk, and two concurrent runs sharing cloned providers can’t lose each other’s messages via a snapshot/overwrite race.

Implementations§

Source§

impl FileHistoryProvider

Source

pub fn new(path: impl Into<PathBuf>) -> Result<FileHistoryProvider, Error>

Open (or create) a file-backed history provider at path. A missing or empty file starts with no history; an existing file is parsed eagerly, so a malformed file fails the constructor rather than silently discarding history.

Source

pub fn path(&self) -> &Path

The path this provider persists to.

Source

pub fn list_messages(&self) -> Vec<Message>

The stored messages, in chronological order.

Source

pub fn to_dict(&self) -> Value

Serialize the stored history to {"messages": [...]}.

Trait Implementations§

Source§

impl Clone for FileHistoryProvider

Source§

fn clone(&self) -> FileHistoryProvider

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 ContextProvider for FileHistoryProvider

Source§

fn before_run<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 mut SessionContext, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, FileHistoryProvider: 'async_trait,

Called before the model is invoked; mutate ctx to inject instructions, messages, and/or tools. Read ctx.input_messages / ctx.session_id.
Source§

fn after_run<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, request_messages: &'life1 [Message], response_messages: &'life2 [Message], error: Option<&'life3 Error>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, FileHistoryProvider: 'async_trait,

Called after an invocation completes, on BOTH success and failure. On success, error is None and response_messages holds the output. On failure, error is Some and response_messages is empty.
Source§

fn is_history_provider(&self) -> bool

Whether this provider manages conversation history (a HistoryProvider). Agent and WorkflowAgent use this to detect an already-attached history provider among a session’s context_providers and avoid auto-attaching a redundant InMemoryHistoryProvider. Defaults to false; history providers override it to true.
Source§

impl HistoryProvider for FileHistoryProvider

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, 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: Sized + 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: Sized + 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<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