Struct Index 

pub struct Index { /* private fields */ }

Implementations

impl Index

pub fn file_count(&self) -> usize

Number of live (non-deleted) files known to the index.

pub fn trigram_count(&self) -> usize

pub fn build(root: impl AsRef<Path>) -> Index

Build an index over root, honoring the same ignore rules ripgrep uses by default.

pub fn from_paths(paths: &[PathBuf], progress: &AtomicUsize) -> Index

Build an index from an already-walked path set, bumping progress once per file processed so a watcher can show a climbing count during a cold build.

pub fn apply_changes(&mut self, changed: &[PathBuf], removed: &[PathBuf])

Apply a set of changed and removed paths to the resident index (incremental update).

pub fn reconcile(&mut self, root: impl AsRef<Path>) -> usize

Reconcile the index against the current tree by (size, mtime): index new/changed files and tombstone vanished ones. Used at daemon startup to catch changes made while it was down. Returns the number of files re-indexed plus removed.

pub fn candidates(&self, query: &Query) -> Vec<&Path>

Resolve a trigram query to candidate files (a sound superset of the real matches). A fallback query (no usable trigram) simply makes every live file a candidate — there is no separate “scan the tree” path; ripgrep then confirms over whatever this returns.

pub fn find( &self, needle: &str, after: Option<&str>, limit: usize, ) -> (Vec<&Path>, usize, usize)

File/dir name lookup (fd/find-style): live paths whose string contains needle. Returns the keyset page (paths whose string is strictly greater than after, capped at limit), the total number of matches, and start (matches skipped before this page) so callers can report an honest “X-Y of total”. Sorted by path string — the same order callers keyset on — so paging is deterministic and never skips or repeats.

pub fn memory_bytes(&self) -> u64

Approximate resident size of the posting lists (serialized roaring bytes), for status.

pub fn save(&self, path: impl AsRef<Path>) -> Result<()>

Serialize the index to path (atomic via temp file + rename).

pub fn load(path: impl AsRef<Path>) -> Result<Index>

Load an index snapshot from path. Errors (incl. version mismatch) signal “rebuild”.

Trait Implementations

impl Default for Index

fn default() -> Index

Returns the “default value” for a type.