Struct Client

pub struct Client<C = BoxedConnector<RpcService>> { /* private fields */ }

Available on crate feature rpc only.

Iroh docs client.

Implementations

impl<C: Connector<RpcService>> Client<C>

pub fn new(rpc: RpcClient<RpcService, C>) -> Self

Creates a new docs client.

pub fn authors(&self) -> Client<C>

Returns an authors client.

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

Creates a client.

pub async fn drop_doc(&self, doc_id: NamespaceId) -> Result<()>

Deletes a document from the local node.

This is a destructive operation. Both the document secret key and all entries in the document will be permanently deleted from the node’s storage. Content blobs will be deleted through garbage collection unless they are referenced from another document or tag.

pub async fn import_namespace(&self, capability: Capability) -> Result<Doc<C>>

Imports a document from a namespace capability.

This does not start sync automatically. Use Doc::start_sync to start sync.

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

Imports a document from a ticket and joins all peers in the ticket.

pub async fn import_and_subscribe( &self, ticket: DocTicket, ) -> Result<(Doc<C>, impl Stream<Item = Result<LiveEvent>>)>

Imports a document from a ticket, creates a subscription stream and joins all peers in the ticket.

Returns the Doc and a Stream of LiveEvents.

The subscription stream is created before the sync is started, so the first call to this method after starting the node is guaranteed to not miss any sync events.

pub async fn list( &self, ) -> Result<impl Stream<Item = Result<(NamespaceId, CapabilityKind)>>>

Lists all documents.

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

Returns a Doc client for a single document.

Returns None if the document cannot be found.

Trait Implementations

impl<C: Clone> Clone for Client<C>

fn clone(&self) -> Client<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for Client<C>

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

Formats the value using the given formatter.