Struct lsl::XMLElement

pub struct XMLElement { /* fields omitted */ }

A lightweight XML element tree; models the .desc() field of StreamInfo.

This class can be tought of as a "cursor" in an XML document owned by the StreamInfo, which provides operations for navigating to parent, children and sibling elements, as well as modification operations for inserting or removing content. Each element has a name and can have multiple named children or have text content as value; attributes are omitted. Most operations return a node, which allows you to chain multiple operations. The API is modeled after a subset of pugixml's node type and is compatible with it. See also here for additional documentation.

Note: operations on non-existent nodes become safe no-ops instead of returning error variants or crashing. Since in most cases you will be writing data instead of navigating the tree and/or reading, you will rarely encounter this. You can rely on the is_valid() method to check the validity of the current element.

Examples: the *advanced.rs examples (found in the crate's github repository) illustrate the use of XMLElement cursors.

Panics: any strings passed into this function must be valid UTF8-encoded strings and contain no intermittent zero bytes (otherwise this will trigger an assertion).

Implementations

impl XMLElement

pub fn first_child(&self) -> XMLElement

Get the first child of the element.

pub fn last_child(&self) -> XMLElement

Get the last child of the element.

pub fn next_sibling(&self) -> XMLElement

Get the next sibling in the children list of the parent node.

pub fn previous_sibling(&self) -> XMLElement

Get the previous sibling in the children list of the parent node.

pub fn parent(&self) -> XMLElement

Get the parent node.

pub fn child(&self, name: &str) -> XMLElement

Get a child with a specified name.

pub fn next_sibling_named(&self, name: &str) -> XMLElement

Get the next sibling with the specified name.

pub fn previous_sibling_named(&self, name: &str) -> XMLElement

Get the previous sibling with the specified name.

pub fn empty(&self) -> bool

Whether this node is empty.

pub fn is_text(&self) -> bool

Whether this is a text body (instead of an XML element). True both for plain char data and CData.

pub fn name(&self) -> String

Name of the element.

pub fn value(&self) -> String

Value of the element.

pub fn child_value(&self) -> String

Get child value (value of the first child that is text).

pub fn child_value_named(&self, name: &str) -> String

Get child value of a child with a specified name.

pub fn append_child_value(&mut self, name: &str, value: &str) -> XMLElement

Append a child node with a given name, and give it a (nameless) plain-text child with the given text value.

Returns the same element on which the operation was performed (not the child).

pub fn prepend_child_value(&mut self, name: &str, value: &str) -> XMLElement

Prepend a child node with a given name and give it a (nameless) plain-text child with the given text value.

Returns the same element on which the operation was performed (not the child).

pub fn set_child_value(&mut self, name: &str, value: &str) -> bool

Set the text value of the (nameless) plain-text child of a named child node.

pub fn set_name(&mut self, rhs: &str) -> bool

Set the element's name. Returns false if the node is empty (or if out of memory).

pub fn set_value(&mut self, rhs: &str) -> bool

Set the element's value. Returns false if the node is empty (or if out of memory).

pub fn append_child(&mut self, name: &str) -> XMLElement

Append a child element with the specified name and return it.

pub fn prepend_child(&mut self, name: &str) -> XMLElement

Prepend a child element with the specified name and return it.

pub fn append_copy(&mut self, e: XMLElement) -> XMLElement

Append a copy of the specified element as a child and return a cursor to the result.

pub fn prepend_copy(&mut self, e: XMLElement) -> XMLElement

Prepend a child element with the specified name and return a cursor to the result.

pub fn remove_child(&mut self, e: XMLElement)

Remove a specified child element.

pub fn remove_child_named(&mut self, name: &str)

Remove a child element with the specified name.

pub fn is_valid(&self) -> bool

Returns true if the current node is valid, false otherwise

Trait Implementations

impl Clone for XMLElement

fn clone(&self) -> XMLElement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XMLElement

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

Formats the value using the given formatter.

impl Display for XMLElement

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

Formats the value using the given formatter.