Struct CatalogService 

pub struct CatalogService { /* private fields */ }

The catalog publisher and subscriber for an indexing database.

Implementations

impl CatalogService

pub fn new( indexing: &IndexingService, docs: &DocsEngine, blobs: &BlobStore, author: AuthorId, ) -> Self

Construct a catalog service using an existing indexing database.

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

pub const fn indexing(&self) -> &IndexingService

pub async fn create_catalog(&self, name: impl Into<String>) -> Result<Catalog>

Create and register a catalog namespace.

Errors

Returns an error if the namespace or its metadata cannot be created.

pub async fn create(&self, name: impl Into<String>) -> Result<Catalog>

Create a catalog namespace. Alias for Self::create_catalog.

Errors

Returns an error if the namespace or its metadata cannot be created.

pub async fn publish_folder( &self, catalog: &Catalog, folder: &SyncwebFolder, ) -> Result<usize>

Publish all entries in a folder to a catalog.

The catalog contains searchable metadata and content hashes, not file contents. The folder’s existing document remains authoritative.

Errors

Returns an error if folder entries or catalog records cannot be read or written.

pub async fn publish_folder_with_metadata( &self, catalog: &Catalog, folder: &SyncwebFolder, folder_name: impl Into<String>, tags: &[String], ) -> Result<usize>

Publish all entries in a folder with a display name and search tags.

Errors

Returns an error if folder entries or catalog records cannot be read or written.

pub async fn publish( &self, catalog: &Catalog, folder: &SyncwebFolder, ) -> Result<usize>

Publish a folder using its namespace as the display name.

Errors

Returns an error if folder entries or catalog records cannot be read or written.

pub async fn ticket( &self, catalog: &Catalog, endpoint: EndpointAddr, writable: bool, ) -> Result<DocTicket>

Create a read-only ticket for a catalog namespace.

Errors

Returns an error if the catalog ticket cannot be created.

pub async fn subscribe(&self, ticket: DocTicket) -> Result<Catalog>

Subscribe to a catalog using its iroh-docs ticket.

Subscription starts document synchronization and keeps a background watcher which imports new records into the local FTS database.

Errors

Returns an error if the ticket cannot be imported or synchronized.

pub async fn subscribe_catalog(&self, ticket: DocTicket) -> Result<Catalog>

Subscribe to a catalog. Alias for Self::subscribe.

Errors

Returns an error if the ticket cannot be imported or synchronized.

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

Open and subscribe to a catalog namespace already available locally.

Errors

Returns an error if the namespace is not available or cannot be synced.

pub async fn sync_catalog(&self, catalog: &Catalog) -> Result<usize>

Synchronize a catalog once and import all records currently available.

Errors

Returns an error if document synchronization or record indexing fails.

pub async fn sync(&self, catalog: &Catalog) -> Result<usize>

Synchronize a catalog once. Alias for Self::sync_catalog.

Errors

Returns an error if document synchronization or record indexing fails.

pub async fn index_catalog(&self, catalog: &Catalog) -> Result<usize>

Import all currently available records from a catalog.

Errors

Returns an error if catalog entries cannot be read or decoded.

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

Search records imported from all known catalogs.

Errors

Returns an error if the FTS query is invalid.

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

Search records imported from all known catalogs. Alias for Self::search.

Errors

Returns an error if the FTS query is invalid.

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

Stop following a catalog and remove its local records.

Errors

Returns an error if the catalog index cannot be removed.

Trait Implementations

impl Clone for CatalogService

fn clone(&self) -> CatalogService

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CatalogService

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

Formats the value using the given formatter.