Struct yrs::types::map::Map

pub struct Map(_);

Collection used to store key-value entries in an unordered manner. Keys are always represented as UTF-8 strings. Values can be any value type supported by Yrs: JSON-like primitives as well as shared data types.

In terms of conflict resolution, Map uses logical last-write-wins principle, meaning the past updates are automatically overridden and discarded by newer ones, while concurrent updates made by different peers are resolved into a single value using document id seniority to establish order.

Implementations

impl Map

pub fn to_json(&self, txn: &Transaction<'_>) -> Any

Converts all entries of a current map into JSON-like object representation.

pub fn len(&self, txn: &Transaction<'_>) -> u32

Returns a number of entries stored within current map.

pub fn keys<'a, 'b, 'txn>(
    &'a self,
    txn: &'b Transaction<'txn>
) -> Keys<'b, 'txn>

Returns an iterator that enables to traverse over all keys of entries stored within current map. These keys are not ordered.

pub fn values<'a, 'b, 'txn>(
    &'a self,
    txn: &'b Transaction<'txn>
) -> Values<'b, 'txn>

Returns an iterator that enables to traverse over all values stored within current map.

pub fn iter<'a, 'b, 'txn>(
    &'a self,
    txn: &'b Transaction<'txn>
) -> MapIter<'b, 'txn>

Returns an iterator that enables to traverse over all entries - tuple of key-value pairs - stored within current map.

pub fn insert<V: Prelim>(
    &self,
    txn: &mut Transaction<'_>,
    key: String,
    value: V
) -> Option<Value>

Inserts a new value under given key into current map. Returns a value stored previously under the same key (if any existed).

pub fn remove(&self, txn: &mut Transaction<'_>, key: &str) -> Option<Value>

Removes a stored within current map under a given key. Returns that value or None if no entry with a given key was present in current map.

pub fn get(&self, txn: &Transaction<'_>, key: &str) -> Option<Value>

Returns a value stored under a given key within current map, or None if no entry with such key existed.

pub fn contains(&self, txn: &Transaction<'_>, key: &str) -> bool

Checks if an entry with given key can be found within current map.

pub fn clear(&self, txn: &mut Transaction<'_>)

Clears the contents of current map, effectively removing all of its entries.

Trait Implementations

impl Clone for Map

fn clone(&self) -> Map

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Map

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

Formats the value using the given formatter.

impl From<BranchRef> for Map

fn from(inner: BranchRef) -> Self

Performs the conversion.

impl Into<XmlHook> for Map

fn into(self) -> XmlHook

Performs the conversion.

impl PartialEq<Map> for Map

fn eq(&self, other: &Map) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Map) -> bool

This method tests for !=.

impl Eq for Map

impl StructuralEq for Map

impl StructuralPartialEq for Map