Struct DocsEngine 

pub struct DocsEngine { /* private fields */ }

Implementations

impl DocsEngine

pub fn new(docs: &Docs) -> Self

pub const fn inner(&self) -> &Docs

pub async fn create_namespace(&self) -> Result<Doc>

Errors

Returns an error if the namespace cannot be created.

pub async fn create_or_open_namespace( &self, existing: Option<NamespaceId>, ) -> Result<(Doc, DocTicket)>

Provision a namespace and a shareable ticket for it.

With existing == None a fresh namespace is created; with existing == Some(id) an already-local namespace is opened instead. In both cases a write ticket is returned so the caller can hand the namespace to a peer. Folder, catalog, and membership-doc provisioning all funnel through this single helper.

Errors

Returns an error if the namespace cannot be created, opened, or shared.

pub async fn provision( &self, kind: ProvisionKind, existing: Option<NamespaceId>, metadata: impl AsRef<[u8]>, ) -> Result<ProvisionedDoc>

Provision a namespace of the given kind and stamp its sys/ metadata.

Unifies folder, catalog, and network-membership namespace creation: every kind funnels through Self::create_or_open_namespace and writes its kind-specific metadata key under sys/.

Errors

Returns an error if the namespace cannot be created, opened, shared, or stamped.

pub async fn import_ticket(&self, ticket: DocTicket) -> Result<Doc>

Errors

Returns an error if the ticket cannot be imported.

pub async fn open(&self, namespace_id: NamespaceId) -> Result<Option<Doc>>

Errors

Returns an error if the document cannot be opened.

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

Errors

Returns an error if the namespace cannot be dropped.

pub async fn start_sync( &self, doc: &Doc, peers: Vec<EndpointAddr>, ) -> Result<()>

Start live synchronization for a document.

An empty peer list uses peers already learned by iroh-docs for the namespace.

Errors

Returns an error if the document cannot be opened for synchronization.

pub async fn share(&self, doc: &Doc, mode: ShareMode) -> Result<DocTicket>

Errors

Returns an error if the document cannot be shared.

pub async fn share_ticket(&self, doc: &Doc, writable: bool) -> Result<DocTicket>

Share a read or write ticket for a document.

Errors

Returns an error if the document cannot be shared.

pub async fn author(&self) -> Result<AuthorId>

Errors

Returns an error if the default author cannot be retrieved.

pub async fn export_author(&self, author_id: AuthorId) -> Result<Option<Author>>

Errors

Returns an error if the author cannot be exported.

pub async fn import_author(&self, author: Author) -> Result<AuthorId>

Errors

Returns an error if the author cannot be imported.

pub async fn set( &self, doc: &Doc, author: AuthorId, key: impl AsRef<[u8]>, value: impl AsRef<[u8]>, ) -> Result<Hash>

Errors

Returns an error if setting the document entry fails.

pub async fn set_blob( &self, doc: &Doc, author: AuthorId, key: impl AsRef<[u8]>, hash: Hash, size: u64, ) -> Result<()>

Errors

Returns an error if setting the document blob fails.

pub async fn get( &self, doc: &Doc, author: AuthorId, key: impl AsRef<[u8]>, ) -> Result<Option<Entry>>

Errors

Returns an error if getting the document entry fails.

pub async fn get_any( &self, doc: &Doc, key: impl AsRef<[u8]>, ) -> Result<Option<Entry>>

Read the latest entry for a key regardless of which author wrote it.

Errors

Returns an error if the document query fails.

pub async fn list_latest(&self, doc: &Doc) -> Result<Vec<Entry>>

Read the latest non-empty entry for every document key.

Errors

Returns an error if the document query fails.

pub async fn delete( &self, doc: &Doc, author: AuthorId, key: impl AsRef<[u8]>, ) -> Result<()>

Delete the current value for a document key.

Errors

Returns an error if the document entry cannot be deleted.

pub async fn watch( &self, doc: &Doc, ) -> Result<impl Stream<Item = Result<LiveEvent>> + Send + Unpin + 'static>

Errors

Returns an error if watching the document fails.

pub async fn watch_and_sync( &self, doc: &Doc, ) -> Result<impl Stream<Item = Result<LiveEvent>> + Send + Unpin + 'static>

Subscribe to a document’s live events and start live synchronization.

This is the shared prologue for every background doc consumer: catalog subscribers, indexing watchers, and sync intents all pair Self::watch with Self::start_sync before spawning a consumer task over the returned stream.

Errors

Returns an error if the document cannot be watched or synchronized.

pub fn namespace_id(&self, doc: &Doc) -> NamespaceId

Trait Implementations

impl Clone for DocsEngine

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.