Struct Index 

pub struct Index { /* private fields */ }

A lazily-maintained fst-segment index rooted at a directory (.ct/okf/).

Implementations

impl Index

pub fn open(dir: &Path) -> Result<Index, String>

Open the index at dir, loading manifest.json if present (an absent or unreadable manifest yields an empty index). The directory is created on the first Index::save.

pub fn doc_count(&self) -> usize

Number of live (non-tombstoned) documents.

pub fn segment_count(&self) -> usize

Number of live segments.

pub fn tombstone_count(&self) -> usize

Number of tombstoned documents awaiting condense.

pub fn generation(&self) -> u64

Atomically-published manifest generation. It advances on every successful content delta, rebuild, or compaction.

pub fn source_bytes(&self) -> u64

Bytes of live source documents represented by the manifest.

pub fn provider(&self) -> (&str, u64)

pub fn pending(&self, current: &[FileStat]) -> (usize, usize, usize)

How many of current are new / changed / removed relative to the manifest — a read-only staleness probe for index status that mutates nothing (the same diff update would act on).

pub fn update<F>( &mut self, current: &[FileStat], load: F, ) -> Result<UpdateReport, String>

where F: Fn(&FileStat) -> Result<DocSource, String>,

Reconcile the index against current (the live files of the OKF roots), re-indexing only what changed. load is called to read a file’s DocSource only when it is new or modified. Writes at most one new segment. Call save afterwards to persist the manifest.

pub fn update_delta<F>( &mut self, upserts: &[FileStat], removed: &[String], load: F, ) -> Result<UpdateReport, String>

where F: Fn(&FileStat) -> Result<DocSource, String>,

Apply a watcher-derived partial change set without walking unchanged scopes. removed entries are keys or directory-key prefixes; every matching live document is removed before upserts replace/add paths. Periodic full update calls remain the correctness audit.

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

Search the index, returning up to limit hits ranked by a tf-idf score. Reads every live segment; tombstoned documents are filtered out.

pub fn condense(&mut self) -> Result<bool, String>

Merge every segment into one, dropping tombstoned documents and their postings, then delete the old segment files. Reclaims space without re-reading any source file. A no-op when there is nothing to gain (≤1 segment and no tombstones).

pub fn reset(&mut self)

Discard the whole index (segments + manifest state), so the next update re-indexes every file from scratch.

pub fn save(&self) -> Result<(), String>

Persist manifest.json (creating the index directory if needed).