Struct Index 

pub struct Index<D: DirectoryWriter + 'static> { /* private fields */ }

Multi-segment async Index

The central concept for search. Owns segment lifecycle and provides:

• Index::create() / Index::open() - create or open an index
• index.writer() - get an IndexWriter for adding documents
• index.reader() - get an IndexReader for searching with reload policy

All segment management is delegated to SegmentManager.

Implementations

impl<D: DirectoryWriter + 'static> Index<D>

pub async fn create( directory: D, schema: Schema, config: IndexConfig, ) -> Result<Self>

Create a new index in the directory

pub async fn open(directory: D, config: IndexConfig) -> Result<Self>

Open an existing index from a directory

pub fn schema(&self) -> &Schema

Get the schema

pub fn directory(&self) -> &D

Get a reference to the underlying directory

pub fn segment_manager(&self) -> &Arc<SegmentManager<D>>

Get the segment manager

pub fn writer(&self) -> IndexWriter<D>

Get an IndexWriter for adding documents

pub async fn reader(&self) -> Result<IndexReader<D>>

Get an IndexReader for searching (with reload policy)

pub fn config(&self) -> &IndexConfig

Get the config

pub fn trained_centroids(&self) -> &FxHashMap<u32, Arc<CoarseCentroids>>

Get trained centroids

pub fn trained_codebooks(&self) -> &FxHashMap<u32, Arc<PQCodebook>>

Get trained codebooks

pub async fn segment_readers(&self) -> Result<Vec<Arc<SegmentReader>>>

Get segment readers for query execution (convenience method)

pub async fn num_docs(&self) -> Result<u32>

Total number of documents across all segments

pub async fn doc(&self, doc_id: DocId) -> Result<Option<Document>>

Get a document by global doc_id

pub fn default_fields(&self) -> Vec<Field>

Get default fields for search

pub fn tokenizers(&self) -> Arc<TokenizerRegistry>

Get tokenizer registry

pub fn query_parser(&self) -> QueryLanguageParser

Create a query parser for this index

pub async fn query( &self, query_str: &str, limit: usize, ) -> Result<SearchResponse>

Parse and search using a query string

pub async fn query_offset( &self, query_str: &str, limit: usize, offset: usize, ) -> Result<SearchResponse>

Query with offset for pagination

pub async fn search( &self, query: &dyn Query, limit: usize, ) -> Result<SearchResponse>

Search and return results

pub async fn search_offset( &self, query: &dyn Query, limit: usize, offset: usize, ) -> Result<SearchResponse>

Search with offset for pagination

pub async fn get_document( &self, address: &DocAddress, ) -> Result<Option<Document>>

Get a document by its unique address

pub async fn reload(&self) -> Result<()>

Reload is no longer needed - reader handles this automatically

pub async fn get_postings( &self, field: Field, term: &[u8], ) -> Result<Vec<(Arc<SegmentReader>, BlockPostingList)>>

Get posting lists for a term across all segments