Struct SearchIndex 

pub struct SearchIndex { /* private fields */ }

Tantivy-based search index for llms.txt documentation

Implementations

impl SearchIndex

pub fn with_metrics(self, metrics: PerformanceMetrics) -> Self

Enable performance metrics collection

pub const fn metrics(&self) -> Option<&PerformanceMetrics>

Get the performance metrics instance

pub fn create(index_path: &Path) -> Result<Self>

Creates a new search index at the specified path

pub fn create_or_open(index_path: &Path) -> Result<Self>

Creates a new search index or opens an existing one at the specified path

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

Opens an existing search index at the specified path

pub fn index_blocks(&self, alias: &str, blocks: &[HeadingBlock]) -> Result<()>

Indexes a collection of heading blocks for a given alias

pub fn search( &self, query_str: &str, alias: Option<&str>, limit: usize, ) -> Result<Vec<SearchHit>>

Searches the index with optional alias filtering

pub fn search_with_snippet_limit( &self, query_str: &str, alias: Option<&str>, limit: usize, snippet_max_chars: usize, ) -> Result<Vec<SearchHit>>

Searches the index with optional alias filtering and an explicit snippet character limit.