Struct Docs

pub struct Docs { /* private fields */ }

Docs protocol.

Implementations

impl Docs

pub fn memory() -> Builder

Create a new Builder for the docs protocol, using in memory replica and author storage.

pub fn persistent(path: PathBuf) -> Builder

Create a new Builder for the docs protocol, using a persistent replica and author storage in the given directory.

pub fn new(engine: Engine) -> Self

Creates a new Docs from an Engine.

pub fn api(&self) -> &DocsApi

Returns the API for this docs instance.

Methods from Deref<Target = DocsApi>

pub fn listen(&self, endpoint: Endpoint) -> Result<AbortOnDropHandle<()>>

Listen for incoming RPC connections

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

Creates a new document author.

You likely want to save the returned AuthorId somewhere so that you can use this author again.

If you need only a single author, use Self::author_default.

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

Returns the default document author of this node.

On persistent nodes, the author is created on first start and its public key is saved in the data directory.

The default author can be set with Self::author_set_default.

pub async fn author_set_default(&self, author_id: AuthorId) -> Result<()>

Sets the node-wide default author.

If the author does not exist, an error is returned.

On a persistent node, the author id will be saved to a file in the data directory and reloaded after a restart.

pub async fn author_list(&self) -> Result<impl Stream<Item = Result<AuthorId>>>

Lists document authors for which we have a secret key.

It’s only possible to create writes from authors that we have the secret key of.

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

Exports the given author.

Warning: The Author struct contains sensitive data.

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

Imports the given author.

Warning: The Author struct contains sensitive data.

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

Deletes the given author by id.

Warning: This permanently removes this author.

Returns an error if attempting to delete the default author.

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

Creates a new document.

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>

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>

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

pub async fn import_and_subscribe( &self, ticket: DocTicket, ) -> Result<(Doc, 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)>> + Unpin + Send + 'static>

Lists all documents.

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

Returns a Doc client for a single document.

Returns None if the document cannot be found.

Trait Implementations

impl Clone for Docs

fn clone(&self) -> Docs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Docs

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

Formats the value using the given formatter.

impl Deref for Docs

type Target = DocsApi

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl ProtocolHandler for Docs

async fn accept(&self, connection: Connection) -> Result<(), AcceptError>

Handle an incoming connection.

async fn shutdown(&self)

Called when the router shuts down.

fn on_connecting( &self, connecting: Connecting, ) -> impl Future<Output = Result<Connection, AcceptError>> + Send

Optional interception point to handle the Connecting state.