Expand description
§Loro
Loro is a high-performance CRDTs framework offering Rust and JavaScript APIs.
Designed for local-first software, it enables effortless collaboration in app states.
PS: Version control is forthcoming. Time travel functionality is already accessible at https://loro.dev/docs/tutorial/time_travel.
§Examples
§Map/List/Text
use loro::{LoroDoc, LoroList, LoroText, LoroValue, ToJson};
use serde_json::json;
let doc = LoroDoc::new();
let map = doc.get_map("map");
map.insert("key", "value").unwrap();
map.insert("true", true).unwrap();
map.insert("null", LoroValue::Null).unwrap();
map.insert("deleted", LoroValue::Null).unwrap();
map.delete("deleted").unwrap();
let list = map.insert_container("list", LoroList::new()).unwrap();
list.insert(0, "List").unwrap();
list.insert(1, 9).unwrap();
let text = map.insert_container("text", LoroText::new()).unwrap();
text.insert(0, "Hello world!").unwrap();
assert_eq!(
doc.get_deep_value().to_json_value(),
json!({
"map": {
"key": "value",
"true": true,
"null": null,
"list": ["List", 9],
"text": "Hello world!"
}
})
);
§Rich Text
use loro::{ExpandType, LoroDoc, ToJson};
use serde_json::json;
let doc = LoroDoc::new();
let text = doc.get_text("text");
text.insert(0, "Hello world!").unwrap();
text.mark(0..5, "bold", true).unwrap();
assert_eq!(
text.to_delta().to_json_value(),
json!([
{ "insert": "Hello", "attributes": {"bold": true} },
{ "insert": " world!" },
])
);
text.unmark(3..5, "bold").unwrap();
assert_eq!(
text.to_delta().to_json_value(),
json!([
{ "insert": "Hel", "attributes": {"bold": true} },
{ "insert": "lo world!" },
])
);
§Sync
use loro::{LoroDoc, ToJson, ExpandType};
use serde_json::json;
let doc = LoroDoc::new();
let text = doc.get_text("text");
text.insert(0, "Hello world!").unwrap();
let bytes = doc.export_from(&Default::default());
let doc_b = LoroDoc::new();
doc_b.import(&bytes).unwrap();
assert_eq!(doc.get_deep_value(), doc_b.get_deep_value());
let text_b = doc_b.get_text("text");
text_b
.mark(0..5, "bold", true)
.unwrap();
doc.import(&doc_b.export_from(&doc.oplog_vv())).unwrap();
assert_eq!(
text.to_delta().to_json_value(),
json!([
{ "insert": "Hello", "attributes": {"bold": true} },
{ "insert": " world!" },
])
);
§Save
use loro::LoroDoc;
let doc = LoroDoc::new();
let text = doc.get_text("text");
text.insert(0, "123").unwrap();
let snapshot = doc.export_snapshot();
let new_doc = LoroDoc::new();
new_doc.import(&snapshot).unwrap();
assert_eq!(new_doc.get_deep_value(), doc.get_deep_value());
Modules§
- Loro event handling.
Macros§
- A macro for creating
LoroValue
. It works just like thejson!
macro inserde_json
.
Structs§
- UndoManager is responsible for managing undo/redo from the current peer’s perspective.
LoroDoc
is the entry for the whole document. When it’s dropped, all the associated [Handler
]s will be invalidated.- LoroList container. It’s used to model array.
- LoroMap container.
- LoroText container. It’s used to model plaintext/richtext.
- LoroTree container. It’s used to model movable trees.
- Unknown container.
- The semantic action in movable tree.
- Each node of movable tree has a unique
TreeID
generated by Loro. - UndoManager can be used to undo and redo the changes made to the document with a certain peer.
Enums§
- All the CRDT containers supported by loro.
- ContainerID includes the Op’s ID and the type. So it’s impossible to have the same ContainerID with conflict ContainerType.
- Whether to expand the style when inserting new text around it.
- LoroValue is used to represents the state of CRDT at a given version.
- It’s a type that can be either a value or a container.
Traits§
- The common trait for all the containers. It’s used internally, you can’t implement it directly.
Functions§
Type Aliases§
- Unique id for each peer. It’s a random u64 by default.