Struct XmlElementRef 

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

XML element data type. It represents an XML node, which can contain key-value attributes (interpreted as strings) as well as other nested XML elements or rich text (represented by XmlTextRef type).

In terms of conflict resolution, XmlElementRef uses following rules:

• Attribute updates use 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 an order.
• Child node insertion uses sequencing rules from other Yrs collections - elements are inserted using interleave-resistant algorithm, where order of concurrent inserts at the same index is established using peer’s document id seniority.

Implementations

impl XmlElementRef

pub fn try_tag(&self) -> Option<&Arc<str>>

A tag name of a current top-level XML node, eg. node <p></p> has “p” as it’s tag name.

pub fn tag(&self) -> &Arc<str>

A tag name of a current top-level XML node, eg. node <p></p> has “p” as it’s tag name.

Trait Implementations

impl AsPrelim for XmlElementRef

type Prelim = XmlElementPrelim

fn as_prelim<T>(&self, txn: &T) -> <XmlElementRef as AsPrelim>::Prelim

where T: ReadTxn,

Converts current type contents into a Prelim type that can be used to create a new type that’s a deep copy equivalent of a current type.

impl AsRef<ArrayRef> for XmlElementRef

fn as_ref(&self) -> &ArrayRef

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

impl AsRef<Branch> for XmlElementRef

fn as_ref(&self) -> &Branch

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

impl AsRef<XmlFragmentRef> for XmlElementRef

fn as_ref(&self) -> &XmlFragmentRef

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

impl Clone for XmlElementRef

fn clone(&self) -> XmlElementRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XmlElementRef

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

Formats the value using the given formatter.

impl DeepObservable for XmlElementRef

fn observe_deep<F>(&self, f: F) -> Arc<dyn Drop>

where F: Fn(&TransactionMut<'_>, &Events<'_>) + 'static,

Subscribe a callback f for all events emitted by this and nested collaborative types. Callback is accepting transaction which triggered that event and event itself, wrapped within an Event structure.

fn observe_deep_with<K, F>(&self, key: K, f: F)

where K: Into<Origin>, F: Fn(&TransactionMut<'_>, &Events<'_>) + 'static,

Subscribe a callback f for all events emitted by this and nested collaborative types. Callback is accepting transaction which triggered that event and event itself, wrapped within an Event structure.

fn unobserve_deep<K>(&self, key: K) -> bool

where K: Into<Origin>,

Unsubscribe a callback identified by a given key, that was previously subscribed using Self::observe_deep_with.

impl From<BranchPtr> for XmlElementRef

fn from(inner: BranchPtr) -> XmlElementRef

Converts to this type from the input type.

impl GetString for XmlElementRef

fn get_string<T>(&self, txn: &T) -> String

where T: ReadTxn,

Converts current XML node into a textual representation. This representation if flat, it doesn’t include any indentation.

impl IndexedSequence for XmlElementRef

fn sticky_index<T>( &self, txn: &T, index: u32, assoc: Assoc, ) -> Option<StickyIndex>

where T: ReadTxn,

Returns a StickyIndex equivalent to a human-readable index. Returns None if index is beyond the length of current sequence.

impl Observable for XmlElementRef

type Event = XmlEvent

fn observe<F>(&self, f: F) -> Arc<dyn Drop>

where F: Fn(&TransactionMut<'_>, &Self::Event) + 'static, Event: AsRef<Self::Event>,

Subscribes a given callback to be triggered whenever current y-type is changed. A callback is triggered whenever a transaction gets committed. This function does not trigger if changes have been observed by nested shared collections.

fn observe_with<K, F>(&self, key: K, f: F)

where K: Into<Origin>, F: Fn(&TransactionMut<'_>, &Self::Event) + 'static, Event: AsRef<Self::Event>,

Subscribes a given callback to be triggered whenever current y-type is changed. A callback is triggered whenever a transaction gets committed. This function does not trigger if changes have been observed by nested shared collections.

fn unobserve<K>(&self, key: K) -> bool

where K: Into<Origin>,

Unsubscribes a given callback identified by key, that was previously subscribed using Self::observe_with.

impl PartialEq for XmlElementRef

fn eq(&self, other: &XmlElementRef) -> 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 SharedRef for XmlElementRef

fn hook(&self) -> Hook<Self>

Returns a logical descriptor of a current shared collection.

impl TryFrom<ItemPtr> for XmlElementRef

type Error = ItemPtr

The type returned in the event of a conversion error.

fn try_from( value: ItemPtr, ) -> Result<XmlElementRef, <XmlElementRef as TryFrom<ItemPtr>>::Error>

Performs the conversion.

impl TryFrom<Out> for XmlElementRef

type Error = Out

The type returned in the event of a conversion error.

fn try_from( value: Out, ) -> Result<XmlElementRef, <XmlElementRef as TryFrom<Out>>::Error>

Performs the conversion.

impl TryInto<XmlElementRef> for XmlOut

type Error = XmlOut

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<XmlElementRef, <XmlOut as TryInto<XmlElementRef>>::Error>

Performs the conversion.

impl Xml for XmlElementRef

fn parent(&self) -> Option<XmlOut>

fn remove_attribute<K>(&self, txn: &mut TransactionMut<'_>, attr_name: &K)

where K: AsRef<str>,

Removes an attribute recognized by an attr_name from a current XML element.

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

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

Inserts an attribute entry into current XML element.

fn get_attribute<T>(&self, txn: &T, attr_name: &str) -> Option<Out>

where T: ReadTxn,

Returns a value of an attribute given its attr_name. Returns None if no such attribute can be found inside of a current XML element.

fn attributes<'a, T>(&'a self, txn: &'a T) -> Attributes<'a, &'a T, T>

where T: ReadTxn,

Returns an unordered iterator over all attributes (key-value pairs), that can be found inside of a current XML element.

fn siblings<'a, T>(&self, txn: &'a T) -> Siblings<'a, T>

where T: ReadTxn,

impl XmlFragment for XmlElementRef

fn first_child(&self) -> Option<XmlOut>

fn children<'a, T>(&self, txn: &'a T) -> XmlNodes<'a, T>

where T: ReadTxn,

Returns an iterator over all children of a current XML fragment. It does NOT include nested children of its children - for such cases use Self::successors iterator.

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

where T: ReadTxn,

Returns a number of elements stored in current array.

fn insert<V>( &self, txn: &mut TransactionMut<'_>, index: u32, xml_node: V, ) -> <V as Prelim>::Return

where V: XmlPrelim,

Inserts a value at the given index. Inserting at index 0 is equivalent to prepending current array with given value, while inserting at array length is equivalent to appending that value at the end of it.

fn push_back<V>( &self, txn: &mut TransactionMut<'_>, xml_node: V, ) -> <V as Prelim>::Return

where V: XmlPrelim,

Inserts given value at the end of the current array.

fn push_front<V>( &self, txn: &mut TransactionMut<'_>, xml_node: V, ) -> <V as Prelim>::Return

where V: XmlPrelim,

Inserts given value at the beginning of the current array.

fn remove(&self, txn: &mut TransactionMut<'_>, index: u32)

Removes a single element at provided index.

fn remove_range(&self, txn: &mut TransactionMut<'_>, index: u32, len: u32)

Removes a range of elements from current array, starting at given index up until a particular number described by len has been deleted. This method panics in case when not all expected elements were removed (due to insufficient number of elements in an array) or index is outside the bounds of an array.

fn get<T>(&self, _txn: &T, index: u32) -> Option<XmlOut>

where T: ReadTxn,

Retrieves a value stored at a given index. Returns None when provided index was out of the range of a current array.

fn successors<'a, T>(&'a self, txn: &'a T) -> TreeWalker<'a, &'a T, T>

where T: ReadTxn,

Returns an iterator that can be used to traverse over the successors of a current XML element. This includes recursive step over children of its children. The recursive iteration is depth-first.

impl Eq for XmlElementRef