Struct Memory 

pub struct Memory { /* private fields */ }

Memory connection. open(path) is persistent (auto-flushes every apply via atomic write); new() is in-RAM only.

Implementations

impl Memory

pub fn new() -> Self

In-RAM memory. Nothing is persisted.

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

Open (or create) a memory db at path. Reads the file if it exists; otherwise the db starts empty and the file is created on the first write.

pub fn apply(&mut self, op: Op) -> Result<()>

Apply a write op and persist. RAM is mutated before flush, so a flush failure leaves RAM ahead of disk until the next successful op (or the next open, which re-reads the file). WAL will close this window in v2.

pub fn get(&self, name: &str) -> Option<&Entry>

pub fn list(&self) -> impl Iterator<Item = &Entry>

pub fn search(&self, query: &str, limit: usize) -> Vec<SearchHit>

pub fn search_kind( &self, query: &str, limit: usize, kind: EntryKind, ) -> Vec<SearchHit>

BM25 search restricted to a single EntryKind. The inner search runs unbounded so the kind filter can’t truncate matches mid-list; we clone only the survivors that fit inside limit.

pub fn checkpoint(&self) -> Result<()>

Force a write of the current state to disk, whether or not any mutation has happened. Useful for one-shot migration paths that need the db file to exist even when every incoming op failed. A no-op when the memory is in-RAM only (no path).

pub fn dump(&self, dir: impl AsRef<Path>) -> Result<()>

Materialize the db as a markdown tree at dir. Each kind’s subdirectory is cleared before writing so renames and deletes don’t leave orphan files behind. Anything else in dir (e.g. a user’s book.toml) is left alone.

pub fn load(&mut self, dir: impl AsRef<Path>) -> Result<()>

Replace the db’s contents with entries read from a markdown tree at dir. Validates fully before mutating — a mid-load error leaves the current state untouched.

Trait Implementations

impl Default for Memory

fn default() -> Self

Returns the “default value” for a type.