Struct CrdtDoc 

pub struct CrdtDoc { /* private fields */ }

A CRDT document synchronized across the mesh.

Wraps a Loro LoroDoc with automatic background sync. Local changes are broadcast to peers; remote changes are merged automatically via Loro’s CRDT algorithms.

Created via CrdtDoc::new or Node::crdt_doc.

Implementations

impl CrdtDoc

pub async fn new<N: NetworkProvider + 'static>( node: Arc<Node<N>>, doc_id: &str, ) -> Result<Arc<Self>, CrdtDocError>

Create a new CrdtDoc and start the background sync task.

Uses the default MemoryCrdtBackend (no persistence).

pub async fn new_with_backend<N: NetworkProvider + 'static>( node: Arc<Node<N>>, doc_id: &str, backend: Arc<dyn CrdtBackend>, ) -> Result<Arc<Self>, CrdtDocError>

Create a new CrdtDoc with a custom persistence backend.

On startup, attempts to restore from the backend: first loads the snapshot (if any), then replays incremental updates on top.

pub fn map(&self, name: &str) -> LoroMap

Get a LoroMap container by name.

pub fn list(&self, name: &str) -> LoroList

Get a LoroList container by name.

pub fn text(&self, name: &str) -> LoroText

Get a LoroText container by name.

pub fn tree(&self, name: &str) -> LoroTree

Get a LoroTree container by name.

pub fn movable_list(&self, name: &str) -> LoroMovableList

Get a LoroMovableList container by name.

pub fn counter(&self, name: &str) -> LoroCounter

Get a LoroCounter container by name.

pub fn get_deep_value(&self) -> LoroValue

Get the deep JSON value of the entire document.

pub fn commit(&self)

Commit pending changes. This triggers the subscribe_local_update callback, which feeds the sync task.

pub fn export_snapshot(&self) -> Result<Vec<u8>, CrdtDocError>

Export the document as a full snapshot.

pub fn export_updates_since( &self, vv: &VersionVector, ) -> Result<Vec<u8>, CrdtDocError>

Export incremental updates since the given version vector.

pub fn import(&self, data: &[u8]) -> Result<(), CrdtDocError>

Import binary data (snapshot or updates) into the document.

pub fn version_vector(&self) -> VersionVector

Get the current version vector of the document.

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

Subscribe to document events.

pub fn doc_id(&self) -> &str

The document identifier.

pub fn compact(&self) -> Result<(), CrdtDocError>

Compact the document: export a snapshot and save it to the backend, clearing incremental updates.

pub fn checkout(&self, frontiers: &Frontiers) -> Result<(), CrdtDocError>

Checkout the document to a specific version (frontiers).

The document becomes “detached” — local edits are not allowed until checkout_to_latest is called.

pub fn checkout_to_latest(&self)

Return to the latest version after a checkout.

pub fn is_detached(&self) -> bool

Whether the document is in “detached” mode (checked out to a historical version).

pub fn fork(&self) -> Result<LoroDoc, CrdtDocError>

Fork the document — create an independent LoroDoc clone.

pub fn with_doc<F, R>(&self, f: F) -> R

where F: FnOnce(&LoroDoc) -> R,

Access the underlying LoroDoc behind the mutex.

The closure runs with the mutex held. Do NOT call any async functions inside the closure.

pub async fn stop(&self)

Stop the background sync task.

Trait Implementations

impl Drop for CrdtDoc

fn drop(&mut self)

Executes the destructor for this type.