Struct IndexingService 

pub struct IndexingService { /* private fields */ }

The opt-in indexing service for synchronized folders.

Implementations

impl IndexingService

pub fn new(path: impl AsRef<Path>) -> Result<Self>

Start an indexing service backed by path.

Errors

Returns an error if the database cannot be opened or initialized.

pub fn in_memory() -> Result<Self>

Start an in-memory indexing service.

Errors

Returns an error if SQLite cannot initialize the schema.

pub fn with_database(database: IndexingDatabase) -> Result<Self>

Start a service from an already opened database.

Errors

Returns an error if the denylist rules cannot be loaded from the database.

pub fn catalog_service( &self, docs: &DocsEngine, blobs: &BlobStore, author: AuthorId, ) -> CatalogService

Create a catalog service backed by this indexing service.

pub fn denylist_service(&self) -> DenylistService

Return the thread-safe local denylist used by indexing hooks.

pub const fn database(&self) -> &IndexingDatabase

pub fn search_local( &self, query: &str, limit: usize, ) -> Result<Vec<IndexedEntry>>

Search entries in folders enabled for local indexing.

Errors

Returns an error if the query is invalid or SQLite cannot read results.

pub fn search_global( &self, query: &str, limit: usize, ) -> Result<Vec<CatalogRecord>>

Search records imported from subscribed catalogs.

Errors

Returns an error if the query is invalid or SQLite cannot read results.

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

Search records imported from subscribed catalogs.

This is the service-level search used by indexing search. Records blocked by the local denylist are excluded from discovery.

Errors

Returns an error if the query is invalid or SQLite cannot read results.

pub fn subscribe(&self) -> Receiver<IndexingEvent>

Subscribe to indexing and core-engine events.

pub async fn enable_folder( &self, folder: &SyncwebFolder, ) -> Result<IndexingHandle>

Opt a folder into indexing and begin consuming its document events.

Existing document entries are indexed before the method returns.

Errors

Returns an error if the folder cannot be registered, read, or watched.

pub async fn disable_folder(&self, namespace_id: NamespaceId) -> Result<()>

Stop indexing a folder and remove its local index entries.

Errors

Returns an error if the folder index cannot be removed.

pub fn is_folder_enabled(&self, namespace_id: NamespaceId) -> Result<bool>

Return whether an indexing task is active for a folder.

Errors

Returns an error if the task registry lock is poisoned.

pub fn index_entry( &self, namespace_id: NamespaceId, entry: &Entry, ) -> Result<IndexedEntry>

Index an entry supplied by another catalog or an application.

This method does not require a folder task, but the namespace must already be enabled.

Errors

Returns an error if the namespace is not enabled or the entry cannot be stored.

Trait Implementations

impl Clone for IndexingService

fn clone(&self) -> IndexingService

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IndexingService

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

Formats the value using the given formatter.