Skip to main content

MarkdownMemoryStore

Struct MarkdownMemoryStore 

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

A store for managing memories in markdown format.

This store uses a single markdown file (.ralph/agent/memories.md) to persist memories. The file format is human-readable and version-control friendly.

§Multi-loop Safety

All read operations use shared locks, and all write operations use exclusive locks. This ensures safe concurrent access from multiple Ralph loops running in worktrees.

Implementations§

Source§

impl MarkdownMemoryStore

Source

pub fn new(path: impl AsRef<Path>) -> Self

Creates a new store at the given path.

The path should point to a .md file (typically .ralph/agent/memories.md). The file does not need to exist - it will be created when first written to.

Source

pub fn with_default_path(root: impl AsRef<Path>) -> Self

Creates a store with the default path (.ralph/agent/memories.md) under the given root.

Source

pub fn path(&self) -> &Path

Returns the path to the memories file.

Source

pub fn exists(&self) -> bool

Returns true if the memories file exists.

Source

pub fn init(&self, force: bool) -> Result<()>

Initializes the memories file with an empty template.

If force is false and the file already exists, this returns an error. Uses an exclusive lock to prevent concurrent writes.

Source

pub fn load(&self) -> Result<Vec<Memory>>

Reads all memories from the file.

Returns an empty vector if the file doesn’t exist. Uses a shared lock to allow concurrent reads from multiple loops.

Source

pub fn append(&self, memory: &Memory) -> Result<()>

Appends a new memory to the file.

The memory is inserted into its appropriate section (based on type). If the file doesn’t exist, it’s created with the template first. Uses an exclusive lock to prevent concurrent writes.

Source

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

Deletes a memory by ID.

Returns Ok(true) if the memory was found and deleted, Ok(false) if the memory was not found. Uses an exclusive lock to prevent concurrent writes.

Source

pub fn get(&self, id: &str) -> Result<Option<Memory>>

Returns the memory with the given ID, if it exists.

Source

pub fn search(&self, query: &str) -> Result<Vec<Memory>>

Searches memories by query string.

Matches against content and tags (case-insensitive).

Source

pub fn filter_by_type(&self, memory_type: MemoryType) -> Result<Vec<Memory>>

Filters memories by type.

Source

pub fn filter_by_tags(&self, tags: &[String]) -> Result<Vec<Memory>>

Filters memories by tags (OR logic - matches if any tag matches).

Trait Implementations§

Source§

impl Clone for MarkdownMemoryStore

Source§

fn clone(&self) -> MarkdownMemoryStore

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 MarkdownMemoryStore

Source§

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

Formats the value using the given formatter. 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> 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