Struct ywasm::YXmlElement

pub struct YXmlElement(_);

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 YXmlText type).

In terms of conflict resolution, YXmlElement 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 YXmlElement

pub fn name(&self) -> String

Returns a tag name of this XML node.

pub fn length(&self, txn: &YTransaction) -> u32

Returns a number of child XML nodes stored within this YXMlElement instance.

pub fn insert_xml_element(
    &self,
    txn: &mut YTransaction,
    index: u32,
    name: &str
) -> YXmlElement

Inserts a new instance of YXmlElement as a child of this XML node and returns it.

pub fn insert_xml_text(&self, txn: &mut YTransaction, index: u32) -> YXmlText

Inserts a new instance of YXmlText as a child of this XML node and returns it.

pub fn delete(&self, txn: &mut YTransaction, index: u32, length: u32)

Removes a range of children XML nodes from this YXmlElement instance, starting at given index.

pub fn push_xml_element(
    &self,
    txn: &mut YTransaction,
    name: &str
) -> YXmlElement

Appends a new instance of YXmlElement as the last child of this XML node and returns it.

pub fn push_xml_text(&self, txn: &mut YTransaction) -> YXmlText

Appends a new instance of YXmlText as the last child of this XML node and returns it.

pub fn first_child(&self, txn: &YTransaction) -> JsValue

Returns a first child of this XML node. It can be either YXmlElement, YXmlText or undefined if current node has not children.

pub fn next_sibling(&self, txn: &YTransaction) -> JsValue

Returns a next XML sibling node of this XMl node. It can be either YXmlElement, YXmlText or undefined if current node is a last child of parent XML node.

pub fn prev_sibling(&self, txn: &YTransaction) -> JsValue

Returns a previous XML sibling node of this XMl node. It can be either YXmlElement, YXmlText or undefined if current node is a first child of parent XML node.

pub fn parent(&self, txn: &YTransaction) -> JsValue

Returns a parent YXmlElement node or undefined if current node has no parent assigned.

pub fn to_string(&self, txn: &YTransaction) -> String

Returns a string representation of this XML node.

pub fn set_attribute(&self, txn: &mut YTransaction, name: &str, value: &str)

Sets a name and value as new attribute for this XML node. If an attribute with the same name already existed on that node, its value with be overridden with a provided one.

pub fn get_attribute(&self, txn: &YTransaction, name: &str) -> Option<String>

Returns a value of an attribute given its name. If no attribute with such name existed, null will be returned.

pub fn remove_attribute(&self, txn: &mut YTransaction, name: &str)

Removes an attribute from this XML node, given its name.

pub fn attributes(&self, txn: &YTransaction) -> JsValue

Returns an iterator that enables to traverse over all attributes of this XML node in unspecified order.

pub fn tree_walker(&self, txn: &YTransaction) -> JsValue

Returns an iterator that enables a deep traversal of this XML node - starting from first child over this XML node successors using depth-first strategy.

Trait Implementations

impl From<YXmlElement> for JsValue

fn from(value: YXmlElement) -> Self

Performs the conversion.

impl FromWasmAbi for YXmlElement

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for YXmlElement

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for YXmlElement

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for YXmlElement

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for YXmlElement

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, YXmlElement>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for YXmlElement

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, YXmlElement>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl WasmDescribe for YXmlElement

fn describe()