Struct Workspace 

pub struct Workspace { /* private fields */ }

A workspace for managing indexed documents.

Uses LRU cache for loaded documents to balance memory usage and access performance.

Thread Safety

The workspace is thread-safe when used with a thread-safe backend. Read operations only require &self.

Implementations

impl Workspace

pub fn with_backend(backend: Arc<dyn StorageBackend>) -> Result<Self>

Create a new workspace with a storage backend.

Example

let backend = Arc::new(FileBackend::new("./workspace")?);
let workspace = Workspace::with_backend(backend)?;

pub fn with_backend_and_options( backend: Arc<dyn StorageBackend>, options: WorkspaceOptions, ) -> Result<Self>

Create a workspace with backend and options.

pub fn new(path: impl Into<PathBuf>) -> Result<Self>

Create a new file-based workspace at the given path.

This is a convenience method that creates a FileBackend internally.

pub fn with_cache_size( path: impl Into<PathBuf>, cache_size: usize, ) -> Result<Self>

Create a new workspace with custom LRU cache size.

pub fn with_options( path: impl Into<PathBuf>, options: WorkspaceOptions, ) -> Result<Self>

Create a new workspace with custom options.

pub fn open(path: impl Into<PathBuf> + Clone) -> Result<Self>

Open an existing workspace, or create if it doesn’t exist.

pub fn open_with_cache_size( path: impl Into<PathBuf> + Clone, cache_size: usize, ) -> Result<Self>

Open with custom cache size.

pub fn open_with_options( path: impl Into<PathBuf> + Clone, options: WorkspaceOptions, ) -> Result<Self>

Open with custom options.

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

Get the workspace root path (if file-based).

pub fn backend(&self) -> &dyn StorageBackend

Get the storage backend.

pub fn list_documents(&self) -> Vec<&str>

List all document IDs in the workspace.

pub fn get_meta(&self, id: &str) -> Option<&DocumentMetaEntry>

Get metadata for a document.

pub fn contains(&self, id: &str) -> bool

Check if a document exists.

pub fn add(&mut self, doc: &PersistedDocument) -> Result<()>

Add a document to the workspace.

pub fn load(&self, id: &str) -> Result<Option<PersistedDocument>>

Load a document from the workspace.

Uses LRU cache: returns cached version if available, otherwise loads from backend and caches it.

pub fn remove(&mut self, id: &str) -> Result<bool>

Remove a document from the workspace.

pub fn len(&self) -> usize

Get the number of documents in the workspace.

pub fn is_empty(&self) -> bool

Check if the workspace is empty.

pub fn cache_len(&self) -> usize

Get the number of items currently in the LRU cache.

pub fn cache_utilization(&self) -> f64

Get cache utilization (0.0 to 1.0).

pub fn cache_stats(&self) -> CacheStats

Get cache statistics.

pub fn clear_cache(&self) -> Result<()>

Clear the LRU cache (does not remove documents from workspace).

Trait Implementations

impl Debug for Workspace

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

Formats the value using the given formatter.