Struct SemanticIndex 

pub struct SemanticIndex { /* private fields */ }

The semantic indexing pipeline.

Orchestrates directory walking, AST-aware chunking, embedding, and vector storage. VFS providers hold an instance of this struct and delegate index, status, and search calls to it.

Thread safety

SemanticIndex is Send + Sync and may be shared across async tasks via Arc<SemanticIndex>.

Implementations

impl SemanticIndex

pub fn new( embeddings: Arc<dyn Embeddings>, reranker: Option<Arc<dyn Reranker>>, store_factory: StoreFactory, config: IndexConfig, event_tx: Option<Sender<IndexEvent>>, ) -> Self

Create a new SemanticIndex with the given dependencies.

• embeddings — embedding model used to vectorise chunks.
• reranker — optional cross-encoder for result reranking.
• store_factory — factory that produces a VectorStore for a cache path.
• config — pipeline configuration (chunk sizes, cache directory).
• event_tx — optional channel for streaming IndexEvents to a caller.

pub async fn index( &self, path: &Path, opts: &IndexOptions, ) -> Result<IndexHandle, VfsError>

Start indexing path asynchronously. Returns immediately with an IndexHandle.

If opts.force is false and a valid cache exists for this path, the index is considered fresh and no work is performed.

Errors

• VfsError::IndexDenied — path resolves to the filesystem root.
• VfsError::Io — path cannot be canonicalised or the store factory fails.

pub async fn status(&self, index_id: &str) -> Result<IndexStatus, VfsError>

Check the status of an indexing operation by its index_id.

Errors

Returns VfsError::NotFound if index_id is unknown.

pub async fn search( &self, path: &Path, query: &str, opts: &SemanticSearchOptions, ) -> Result<Vec<SemanticSearchResult>, VfsError>

Semantic search across indexed content for path.

Errors

• VfsError::IndexNotReady — the index is still building or has never been started.
• VfsError::Io — store factory or similarity search fails.

pub async fn unwatch(&self, path: &Path)

Stop the background watcher for path.

Does nothing if path cannot be canonicalised or has no active watcher.