Struct TrigramIndex 

pub struct TrigramIndex { /* private fields */ }

Implementations

impl TrigramIndex

pub fn build( config: &IndexConfig<'_>, output_dir: &Path, paths: &[PathBuf], ) -> Result<Self>

Build a trigram index from an explicit path list (or full walk when paths is empty).

Errors

Returns an error if corpus walking, extraction, or encoding fails.

pub fn open( index_dir: &Path, root: &Path, corpus_kind: CorpusKind, ) -> Result<Self>

Open a previously persisted trigram index from index_dir.

Errors

Returns an error if persistence files are missing or malformed.

pub fn update( &self, config: &IndexConfig<'_>, output_dir: &Path, paths: &[PathBuf], ) -> Result<Option<Self>>

Update the index from the current corpus, writing artifact files into output_dir.

Returns Ok(Some(index)) if a new index was written, or Ok(None) if no files changed.

Errors

Returns an error if corpus walking, extraction, or encoding fails.

impl TrigramIndex

pub fn candidates(&self, query: &QuerySpec<'_>) -> Option<Vec<Candidate>>

Produce narrowed candidate files for the query. Returns None if the query can’t be narrowed (full scan required).

pub fn explain(&self, query: &QuerySpec<'_>) -> QueryPlanOutput

Returns an explanation of how a query would be handled.

impl TrigramIndex

pub fn file_path(&self, id: FileId) -> Option<&Path>

pub fn file_abs_path(&self, id: FileId) -> Option<PathBuf>

pub fn root(&self) -> &Path

pub const fn corpus_kind(&self) -> CorpusKind

Trait Implementations

impl Debug for TrigramIndex

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

Formats the value using the given formatter.