Struct Element

pub struct Element {
    pub prefix: Option<String>,
    pub namespace: Option<String>,
    pub namespaces: Option<Namespace>,
    pub name: String,
    pub attributes: HashMap<String, String>,
    pub children: Vec<XMLNode>,
}

Represents an XML element.

Fields

prefix: Option<String>

This elements prefix, if any

namespace: Option<String>

This elements namespace, if any

namespaces: Option<Namespace>

The full list of namespaces, if any

The Namespace type is exported from the xml-rs crate.

name: String

The name of the Element. Does not include any namespace info

attributes: HashMap<String, String>

The Element attributes

By default, this is a HashMap, but if the optional “attribute-order” feature is enabled, this is an IndexMap, which will retain item insertion order.

children: Vec<XMLNode>

Children

Implementations

impl Element

pub fn new(name: &str) -> Element

Create a new empty element with given name

All other fields are empty

pub fn parse_all<R>(r: R) -> Result<Vec<XMLNode>, ParseError>

where R: Read,

Parses some data into a list of XMLNodes

This is useful when you want to capture comments or processing instructions that appear before or after the root node

pub fn parse<R>(r: R) -> Result<Element, ParseError>

where R: Read,

Parses some data into an Element

pub fn write<W>(&self, w: W) -> Result<(), EmitterError>

where W: Write,

Writes out this element as the root element in an new XML document

pub fn write_with_config<W>( &self, w: W, config: EmitterConfig, ) -> Result<(), EmitterError>

where W: Write,

Writes out this element as the root element in a new XML document using the provided configuration

pub fn get_child<P>(&self, k: P) -> Option<&Element>

where P: ElementPredicate,

Find a child element with the given name and return a reference to it.

Both &str and String implement ElementPredicate and can be used to search for child elements that match the given element name with .get_child("element_name"). You can also search by ("element_name", "tag_name") tuple.

Note: this will only return Elements. To get other nodes (like comments), iterate through the children field.

pub fn get_mut_child<P>(&mut self, k: P) -> Option<&mut Element>

where P: ElementPredicate,

Find a child element with the given name and return a mutable reference to it.

pub fn take_child<P>(&mut self, k: P) -> Option<Element>

where P: ElementPredicate,

Find a child element with the given name, remove and return it.

pub fn get_text<'a>(&'a self) -> Option<Cow<'a, str>>

Returns the inner text/cdata of this element, if any.

If there are multiple text/cdata nodes, they will be all concatenated into one string.

Trait Implementations

impl Clone for Element

fn clone(&self) -> Element

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Element

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

Formats the value using the given formatter.

impl PartialEq for Element

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

impl StructuralPartialEq for Element