Struct Index 

pub struct Index {
    pub root: PathBuf,
    pub files: Vec<PathBuf>,
    pub lexicon: Vec<LexiconEntry>,
    pub postings: Vec<u8>,
    pub index_dir: Option<PathBuf>,
}

Fields

root: PathBuf

files: Vec<PathBuf>

lexicon: Vec<LexiconEntry>

postings: Vec<u8>

index_dir: Option<PathBuf>

Implementations

impl Index

pub const fn new( root: PathBuf, files: Vec<PathBuf>, lexicon: Vec<LexiconEntry>, postings: Vec<u8>, ) -> Self

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

Open an index directory produced by IndexBuilder::build.

Errors

Returns crate::Error::MissingMeta if sift.meta is absent, crate::Error::InvalidMeta if metadata is empty or malformed, crate::Error::MissingComponent if a trigram table file is missing, or crate::Error::Io on read failure.

pub fn save_to_dir(&self, dir: &Path) -> Result<()>

Persist the in-memory index to dir.

Errors

Propagates IO errors from creating directories or writing files.

pub fn index_dir(&self) -> Option<&Path>

pub fn explain(&self, pattern: &str) -> QueryPlan

pub fn posting_bytes_slice(&self, tri: [u8; 3]) -> &[u8]

pub fn posting_list_for_trigram(&self, tri: [u8; 3]) -> Vec<u32>

pub fn candidate_file_ids(&self, arms: &[Vec<[u8; 3]>]) -> Vec<u32>

pub fn candidate_paths(&self, arms: &[Vec<[u8; 3]>]) -> Vec<PathBuf>

Trait Implementations

impl Debug for Index

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

Formats the value using the given formatter.