Struct LoroMap 

pub struct LoroMap { /* private fields */ }

LoroMap container.

It’s LWW(Last-Write-Win) Map. It can support Multi-Value Map in the future.

Example

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 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,
           "text": "Hello world!"
       }
   })
);

Implementations

impl LoroMap

pub fn new() -> Self

Create a new container that is detached from the document.

The edits on a detached container will not be persisted. To attach the container to the document, please insert it into an attached container.

pub fn is_attached(&self) -> bool

Whether the container is attached to a document.

pub fn delete(&self, key: &str) -> LoroResult<()>

Delete a key-value pair from the map.

pub fn for_each<I>(&self, f: I)

where I: FnMut(&str, ValueOrContainer),

Iterate over the key-value pairs of the map.

pub fn insert(&self, key: &str, value: impl Into<LoroValue>) -> LoroResult<()>

Insert a key-value pair into the map.

Note: When calling map.set(key, value) on a LoroMap, if map.get(key) already returns value, the operation will be a no-op (no operation recorded) to avoid unnecessary updates.

pub fn len(&self) -> usize

Get the length of the map.

pub fn is_empty(&self) -> bool

Whether the map is empty.

pub fn get(&self, key: &str) -> Option<ValueOrContainer>

Get the value of the map with the given key.

pub fn insert_container<C: ContainerTrait>( &self, key: &str, child: C, ) -> LoroResult<C>

Insert a container with the given type at the given key.

Example

let doc = LoroDoc::new();
let map = doc.get_map("m");
let text = map.insert_container("t", LoroText::new()).unwrap();
text.insert(0, "12");
text.insert(0, "0");
assert_eq!(doc.get_deep_value().to_json_value(), json!({"m": {"t": "012"}}));

Pitfalls:

• Concurrently inserting different containers at the same map key on different peers can result in one overwriting the other rather than merging. Prefer initializing heavy/primary child containers when initializing the map.

pub fn get_value(&self) -> LoroValue

Get the shallow value of the map.

It will not convert the state of sub-containers, but represent them as LoroValue::Container.

pub fn get_deep_value(&self) -> LoroValue

Get the deep value of the map.

It will convert the state of sub-containers into a nested JSON value.

pub fn get_or_create_container<C: ContainerTrait>( &self, key: &str, child: C, ) -> LoroResult<C>

Get or create a container with the given key.

Pitfalls:

• If other peers concurrently create a different container at the same key, their state may be overwritten. See the note in [insert_container].

pub fn clear(&self) -> LoroResult<()>

Delete all key-value pairs in the map.

pub fn keys(&self) -> impl Iterator<Item = InternalString> + '_

Get the keys of the map.

pub fn values(&self) -> impl Iterator<Item = ValueOrContainer> + '_

Get the values of the map.

pub fn get_last_editor(&self, key: &str) -> Option<PeerID>

Get the peer id of the last editor on the given entry

Trait Implementations

impl Clone for LoroMap

fn clone(&self) -> LoroMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ContainerTrait for LoroMap

type Handler = MapHandler

The handler of the container.

fn id(&self) -> ContainerID

Get the ID of the container.

fn to_container(&self) -> Container

Convert the container to a Container.

fn to_handler(&self) -> Self::Handler

Convert the container to a handler.

fn from_handler(handler: Self::Handler) -> Self

Convert the handler to a container.

fn is_attached(&self) -> bool

Whether the container is attached to a document.

fn get_attached(&self) -> Option<Self>

If a detached container is attached, this method will return its corresponding attached handler.

fn try_from_container(container: Container) -> Option<Self>

Try to convert the container to the handler.

fn is_deleted(&self) -> bool

Whether the container is deleted.

fn doc(&self) -> Option<LoroDoc>

Get the doc of the container.

fn subscribe(&self, callback: Subscriber) -> Option<Subscription>

Subscribe to the container.

impl Debug for LoroMap

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

Formats the value using the given formatter.

impl Default for LoroMap

fn default() -> Self

Returns the “default value” for a type.