Struct ywasm::YXmlElement

impl YXmlElement

pub fn alive(&self, txn: &YTransaction) -> bool

Checks if current YXmlElement reference is alive and has not been deleted by its parent collection. This method only works on already integrated shared types and will return false is current type is preliminary (has not been integrated into document).

pub fn name(&self) -> JsValue

Returns a tag name of this XML node.

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

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

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

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

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

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

pub fn delete(&self, index: u32, length: Option<u32>, txn: &ImplicitTransaction)

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

pub fn push_xml_element( &self, name: &str, txn: &ImplicitTransaction ) -> 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: &ImplicitTransaction) -> YXmlText

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

pub fn first_child(&self) -> 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: &ImplicitTransaction) -> 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: &ImplicitTransaction) -> 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) -> JsValue

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

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

Returns a string representation of this XML node.

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

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, name: &str, txn: &ImplicitTransaction ) -> 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, name: &str, txn: &ImplicitTransaction)

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

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

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

pub fn tree_walker(&self, txn: &ImplicitTransaction) -> 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.

pub fn observe(&mut self, f: Function) -> YXmlObserver

Subscribes to all operations happening over this instance of YXmlElement. All changes are batched and eventually triggered during transaction commit phase. Returns an YObserver which, when free’d, will unsubscribe current callback.

pub fn observe_deep(&mut self, f: Function) -> YEventObserver

Subscribes to all operations happening over this Y shared type, as well as events in shared types stored within this one. All changes are batched and eventually triggered during transaction commit phase. Returns an YEventObserver which, when free’d, will unsubscribe current callback.

Trait Implementations§

impl From<YXmlElement> for JsValue

fn from(value: YXmlElement) -> Self

Converts to this type from the input type.

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. Read more

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 LongRefFromWasmAbi for YXmlElement

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = Ref<'static, YXmlElement>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

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. Read more

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.