Struct Workspace 

pub struct Workspace { /* private fields */ }

High-level workspace for indexing and searching

Implementations

impl Workspace

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

Open an existing workspace (fails if not indexed)

pub fn open_with_config(root: &Path, config: Config) -> Result<Self>

Open an existing workspace with custom config (fails if not indexed)

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

Create or open a workspace for indexing

pub fn create_with_config(root: &Path, config: Config) -> Result<Self>

Create or open a workspace with custom config for indexing

pub fn set_log_tx(&mut self, tx: LogSender)

Set a log channel — all progress/warning output goes here instead of stderr

pub fn index_all(&self) -> Result<IndexStats>

Index all files in the workspace (text-only by default, fast)

pub fn index_all_with_options( &self, with_embeddings: bool, ) -> Result<IndexStats>

Index all files with options

pub fn build_indexed_files_map(&self) -> HashMap<String, (u64, String)>

Build a map of all indexed files: relative_path -> (mtime, doc_id) Uses fast fields for efficient columnar reads, skipping chunk documents. Returns an empty map if the index is empty or unreadable.

pub fn index_incremental_with_options( &self, with_embeddings: bool, ) -> Result<IndexStats>

Incremental index: only re-index files that changed since last index

pub fn search(&self, query: &str, limit: Option<usize>) -> Result<SearchResult>

Search the workspace

pub fn search_filtered( &self, query: &str, limit: Option<usize>, extensions: Option<Vec<String>>, paths: Option<Vec<String>>, use_regex: bool, case_sensitive: bool, context_before: Option<usize>, context_after: Option<usize>, verbose: bool, ) -> Result<SearchResult>

Search with filters

pub fn has_semantic_index(&self) -> bool

Check if semantic search is available (always false without embeddings feature)

pub fn root(&self) -> &Path

Get the workspace root

pub fn index_path(&self) -> &Path

Get the index path

pub fn is_indexed(&self) -> bool

Check if the workspace has been indexed (workspace.json is only created after actual indexing, not just opening)

pub fn index_file(&self, path: &Path) -> Result<()>

Index or re-index a single file (for incremental updates) Note: path can be under workspace root OR under a symlink target

pub fn delete_file(&self, path: &Path) -> Result<()>

Delete a file from the index (for incremental updates)

pub fn create_watcher(&self) -> Result<FileWatcher>

Create a file watcher for this workspace

pub fn indexer_config(&self) -> &IndexerConfig

Get the indexer config

pub fn stored_semantic_flag(&self) -> Option<bool>

Read the stored semantic flag from workspace.json metadata Returns None if no metadata exists or flag is not set

pub fn stored_schema_version(&self) -> Option<u32>

Read the stored schema version from workspace.json metadata Returns None if no metadata exists or version is not set

pub fn index_file_with_options( &self, path: &Path, with_embeddings: bool, ) -> Result<()>

Index or re-index a single file with optional semantic indexing (for incremental updates)

pub fn index_file_with_indexer( &self, indexer: &Indexer, path: &Path, with_embeddings: bool, ) -> Result<()>

Index or re-index a single file using an existing Indexer (avoids lock churn)

pub fn create_indexer(&self) -> Result<Indexer>

Create a persistent Indexer for this workspace (holds a single writer lock)

pub fn create_watch_indexer(&self) -> Result<Indexer>

Create a persistent Indexer with NoMergePolicy (for watch mode) Prevents background merge threads from racing with commits. Segments accumulate but are consolidated on next incremental index.

pub fn index_file_no_commit( &self, indexer: &Indexer, path: &Path, with_embeddings: bool, ) -> Result<()>

Index a single file without committing (for batched watch operations)

pub fn delete_file_no_commit( &self, indexer: &Indexer, path: &Path, ) -> Result<()>

Delete a file from the index without committing (for batched watch operations)

pub fn commit_indexer(&self, indexer: &Indexer) -> Result<()>

Commit all pending indexer changes

pub fn delete_file_with_indexer( &self, indexer: &Indexer, path: &Path, ) -> Result<()>

Delete a file from the index using an existing Indexer (avoids lock churn)