Skip to main content

FileMemory

Struct FileMemory 

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

JSONL-backed memory store.

Implementations§

Source§

impl FileMemory

Source

pub fn open(path: impl Into<PathBuf>) -> Result<Self, MemoryError>

Open (or create) the JSONL file at path. Creates parent directories as needed. Does not fail if the file is empty or absent.

Source

pub fn path(&self) -> &Path

Path to the underlying JSONL file. Handy for tests and for logging “memory: ” in the example banners.

Source

pub fn compact(&self) -> Result<u32, MemoryError>

Rewrite the file dropping every entry whose expires_ms <= now. Use this as a periodic janitor (cron) to keep the file from accumulating stale rows; recall already filters at read time, so compact is purely a disk-space concern.

Returns how many entries were removed.

Source

pub fn delete_by_id(&self, id: &str) -> Result<bool, MemoryError>

Delete one entry by id. Reads the file, drops the matching row, rewrites. Returns true if a row was actually removed.

Source

pub fn delete_all(&self) -> Result<u32, MemoryError>

Drop every entry. Equivalent to rm <path>; touch <path> but holds the write lock so no concurrent append races.

Trait Implementations§

Source§

impl Memory for FileMemory

Source§

fn recall<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 str, k: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<MemoryEntry>, MemoryError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Return up to k entries most relevant to query, ordered by descending relevance. The query is typically the current task description; backends choose how to score (keyword, embedding, BM25…). Returning an empty Vec is fine and must not be treated as an error.
Source§

fn write<'life0, 'async_trait>( &'life0 self, entry: MemoryEntry, ) -> Pin<Box<dyn Future<Output = Result<(), MemoryError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Persist entry. The backend assigns the id field; callers may leave it empty. Implementations must be safe to call concurrently from multiple tasks.

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> 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, 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