Crate loro

Crate loro 

Source
Expand description

§Loro

Loro is a high‑performance CRDT framework for local‑first apps that keeps state consistent across devices and users, works offline and in real time, automatically merges conflicts, and enables undo/redo and time travel.

Loro is a high-performance CRDTs library offering Rust, JavaScript and Swift APIs.

§Common Tasks & Examples

§Getting Started

§Real-time Collaboration

§Rich Text Editing

§Data Structures

§Ephemeral State & Presence

  • Not currently provided in the Rust crate. Model presence in your app layer alongside CRDT updates (e.g., via your network transport). Cursors can be shared using get_cursor data if needed.

§Version Control & History

§Performance & Storage

§Documentation

  • Start with the Rust API docs for LoroDoc (container management, versioning, import/export, events) That page hosts examples and details for most important methods you’ll use day-to-day.
  • Loro Website for more details and guides
  • Loro Examples for more examples and guides

§Getting Started

Add to your Cargo.toml:

[dependencies]
loro = "^1"

§LoroDoc quick tour

Optional cargo features:

[dependencies]
loro = { version = "^1", features = ["jsonpath"] }

§Quick Examples

  1. Local edits, change events, and two-peer sync
use loro::{LoroDoc, ExportMode};
use std::sync::Arc;

let a = LoroDoc::new();
let b = LoroDoc::new();

// Listen for container diffs on `a`
let _changes = a.subscribe_root(Arc::new(|e| {
    println!("changed containers: {}", e.events.len());
}));

a.get_text("text").insert(0, "Hello, Loro!").unwrap();
a.commit(); // events fire on commit/export/import/checkout

// Sync via export/import (send `updates` via your transport)
let updates = a.export(ExportMode::all_updates()).unwrap();
b.import(&updates).unwrap();

assert_eq!(a.get_deep_value(), b.get_deep_value());
  1. Time travel and revert
use loro::LoroDoc;

let doc = LoroDoc::new();
let text = doc.get_text("text");
text.insert(0, "Hello").unwrap();
let v0 = doc.state_frontiers();

text.insert(5, ", world").unwrap();
assert_eq!(text.to_string(), "Hello, world");

// Time travel to v0 (read-only)
doc.checkout(&v0).unwrap();
assert_eq!(text.to_string(), "Hello");

// Return to latest and revert
doc.checkout_to_latest();
doc.revert_to(&v0).unwrap();
assert_eq!(text.to_string(), "Hello");

Re-exports§

pub use loro_kv_store as kv_store;

Modules§

awareness
cursor
event
Loro event handling.
json
sync
undo

Macros§

loro_value
A macro for creating LoroValue. It works just like the json! macro in serde_json.

Structs§

ChangeMeta
Change is a grouped continuous operations that share the same id, timestamp, commit message.
ChangeModifier
CommitOptions
Options for configuring a commit operation.
Configure
CounterSpan
This struct supports reverse repr: from can be less than to. We need this because it’ll make merging deletions easier.
DocAnalysis
FirstCommitFromPeerPayload
The payload of the first commit from a peer callback.
FractionalIndex
FrontiersNotIncluded
ID
It’s the unique ID of an Op represented by PeerID and Counter.
IdLp
It’s the unique ID of an Op represented by PeerID and Lamport clock. It’s used to define the total order of Ops.
IdSpan
This struct supports reverse repr: CounterSpan’s from can be less than to. But we should use it conservatively. We need this because it’ll make merging deletions easier.
ImVersionVector
Immutable version vector
ImportBlobMetadata
ImportStatus
InnerUndoManager
UndoManager is responsible for managing undo/redo from the current peer’s perspective.
InternalString
JsonChange
JsonFutureOpWrapper
JsonOp
JsonSchema
LoroBinaryValue
LoroDoc
LoroDoc is the entry for the whole document. When it’s dropped, all the associated Containers will be invalidated.
LoroList
LoroList container. It’s used to model arrays.
LoroListValue
LoroMap
LoroMap container.
LoroMapValue
LoroMovableList
LoroMovableList container
LoroStringValue
LoroText
LoroText container. It’s used to model plaintext/richtext.
LoroTree
LoroTree container. It’s used to model movable trees.
LoroUnknown
Unknown container.
MemKvStore
PreCommitCallbackPayload
The payload of the pre commit callback.
StyleConfig
StyleConfigMap
Subscription
A handle to a subscription created by GPUI. When dropped, the subscription is cancelled and the callback will no longer be invoked.
TreeDeltaItem
The semantic action in movable tree.
TreeDiff
TreeDiffItem
TreeID
Each node of movable tree has a unique TreeID generated by Loro.
TreeNode
A tree node in the LoroTree.
UndoItemMeta
The metadata of an undo item.
UndoManager
UndoManager can be used to undo and redo the changes made to the document with a certain peer.
UpdateOptions
Options for controlling the text update behavior.
VersionRange
VersionVector
VersionVector is a map from PeerID to Counter. Its a right-open interval.
VersionVectorDiff

Enums§

CannotFindRelativePosition
ChangeTravelError
Container
All the CRDT containers supported by Loro.
ContainerID
ContainerID includes the Op’s ID and the type. So it’s impossible to have the same ContainerID with conflict ContainerType.
ContainerType
EncodedBlobMode
EventTriggerKind
The kind of the event trigger.
ExpandType
Whether to expand the style when inserting new text around it.
ExportMode
The mode of the export.
Frontiers
Frontiers representation.
Index
JsonFutureOp
JsonListOp
JsonMapOp
JsonMovableListOp
JsonOpContent
JsonTextOp
JsonTreeOp
LoroEncodeError
LoroError
LoroTreeError
LoroValue
LoroValue is used to represents the state of CRDT at a given version.
TextDelta
TreeExternalDiff
TreeParentId
UndoOrRedo
UpdateTimeoutError
ValueOrContainer
It’s a type that can be either a value or a container.

Constants§

LORO_VERSION
The version of the loro crate

Traits§

ApplyDiff
ContainerTrait
The common trait for all the containers. It’s used internally, you can’t implement it directly.
IntoContainerId
KvStore
ToJson

Functions§

to_value

Type Aliases§

Counter
If it’s the nth Op of a peer, the counter will be n.
FirstCommitFromPeerCallback
The callback of the first commit from a peer.
Lamport
It’s the Lamport clock
LocalUpdateCallback
The callback of the local update.
LoroResult
OnPop
OnPush
When a undo/redo item is pushed, the undo manager will call the on_push callback to get the meta data of the undo item. The returned cursors will be recorded for a new pushed undo item.
PeerID
Unique id for each peer. It’s a random u64 by default.
PeerIdUpdateCallback
The callback of the peer id change. The second argument is the next counter for the peer.
PreCommitCallback
Timestamp