Struct XmlHookRef 

pub struct XmlHookRef(/* private fields */);

(Obsolete) an Yjs-compatible XML node used for nesting Map elements.

Trait Implementations

impl AsRef<Branch> for XmlHookRef

fn as_ref(&self) -> &Branch

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<MapRef> for XmlHookRef

fn as_ref(&self) -> &MapRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for XmlHookRef

fn clone(&self) -> XmlHookRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XmlHookRef

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

Formats the value using the given formatter.

impl From<BranchPtr> for XmlHookRef

fn from(inner: BranchPtr) -> XmlHookRef

Converts to this type from the input type.

impl Map for XmlHookRef

fn len<T>(&self, _txn: &T) -> u32

where T: ReadTxn,

Returns a number of entries stored within current map.

fn keys<'a, T>(&'a self, txn: &'a T) -> Keys<'a, &'a T, T>

where T: ReadTxn + 'a,

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

fn values<'a, T>(&'a self, txn: &'a T) -> Values<'a, &'a T, T>

where T: ReadTxn + 'a,

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

fn iter<'a, T>(&'a self, txn: &'a T) -> MapIter<'a, &'a T, T>

where T: ReadTxn + 'a,

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

fn into_iter<'a, T>(self, txn: &'a T) -> MapIntoIter<'a, T>

where T: ReadTxn + 'a,

fn insert<K, V>( &self, txn: &mut TransactionMut<'_>, key: K, value: V, ) -> <V as Prelim>::Return

where K: Into<Arc<str>>, V: Prelim,

Inserts a new value under given key into current map. Returns an integrated value.

fn try_update<K, V>( &self, txn: &mut TransactionMut<'_>, key: K, value: V, ) -> bool

where K: Into<Arc<str>>, V: Into<Any>,

Tries to update a value stored under a given key within current map, if it’s different from the current one. Returns true if the value was updated, false otherwise.

fn get_or_init<K, V>(&self, txn: &mut TransactionMut<'_>, key: K) -> V

where K: Into<Arc<str>>, V: DefaultPrelim + TryFrom<Out>,

Returns an existing instance of a type stored under a given key within current map. If the given entry was not found, has been deleted or its type is different from expected, that entry will be reset to a given type and its reference will be returned.

fn remove(&self, txn: &mut TransactionMut<'_>, key: &str) -> Option<Out>

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.

fn get<T>(&self, txn: &T, key: &str) -> Option<Out>

where T: ReadTxn,

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

fn get_as<T, V>(&self, txn: &T, key: &str) -> Result<V, Error>

where T: ReadTxn, V: DeserializeOwned,

Returns a value stored under a given key within current map, deserializing it into expected type if found. If value was not found, the Any::Null will be substituted and deserialized instead (i.e. into instance of Option type, if so desired).

fn contains_key<T>(&self, _txn: &T, key: &str) -> bool

where T: ReadTxn,

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

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

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

impl PartialEq for XmlHookRef

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToJson for XmlHookRef

fn to_json<T>(&self, txn: &T) -> Any

where T: ReadTxn,

Converts all contents of a current type into a JSON-like representation.

impl Eq for XmlHookRef