Struct Greplm 

pub struct Greplm { /* private fields */ }

A handle to a greplm project (a directory and its .greplm index).

Implementations

impl Greplm

pub fn open(root: impl AsRef<Path>) -> Result<Greplm>

Open (and lazily initialize) the index for root.

pub fn discover(start: impl AsRef<Path>) -> Result<Greplm>

Find the nearest ancestor of start containing a .greplm directory, falling back to start itself if none is found.

pub fn root(&self) -> &Path

pub fn config(&self) -> &Config

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

Ensure the .greplm directory exists with a default config and gitignore.

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

Build or refresh the index.

pub fn compact(&self) -> Result<IndexStats>

Merge all segments into a single compact segment, dropping tombstoned documents. Falls back to a full rebuild if the merge cannot proceed.

pub fn searcher(&self) -> Result<Searcher>

Open a searcher over the current index.

pub fn status(&self) -> Result<Status>

Report index status.

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

Remove the entire .greplm directory.

pub fn watch<F: FnMut(&IndexStats)>( &self, debounce: Duration, on_change: F, ) -> Result<()>

Watch the project tree and re-index incrementally on changes.

on_change is called after each successful incremental update. This call blocks until an error occurs or the watcher is dropped.

pub fn socket_path(&self) -> PathBuf

Path to the daemon’s Unix socket for this project.

pub fn record_savings( &self, kind: &str, files: &BTreeSet<String>, returned_chars: u64, results: u64, )

Record a query’s token savings (grep+read baseline vs. returned payload). Best-effort; never fails a query.

pub fn savings_report(&self) -> SavingsReport

Aggregate the recorded token-savings log.