Struct xml::Element

pub struct Element {
    pub name: String,
    pub ns: Option<String>,
    pub attributes: HashMap<(String, Option<String>), String>,
    pub children: Vec<Xml>,
    // some fields omitted
}

A struct representing an XML element

Fields

name: String

The element's name

ns: Option<String>

The element's namespace

attributes: HashMap<(String, Option<String>), String>

The element's attributes

children: Vec<Xml>

The element's child Xml nodes

Methods

impl Element

pub fn new<A>(name: String, ns: Option<String>, attrs: A) -> Element where
    A: IntoIterator<Item = (String, Option<String>, String)>, 

Create a new Element, with specified name and namespace. Attributes are specified as a Vec of (name, namespace, value) tuples.

pub fn content_str(&self) -> String

Returns the character and CDATA contained in the element.

pub fn get_attribute<'a>(
    &'a self,
    name: &str,
    ns: Option<&str>
) -> Option<&'a str>

Gets an attribute with the specified name and namespace. When an attribute with the specified name does not exist None is returned.

pub fn set_attribute(
    &mut self,
    name: String,
    ns: Option<String>,
    value: String
) -> Option<String>

Sets the attribute with the specified name and namespace. Returns the original value.

pub fn remove_attribute(
    &mut self,
    name: &str,
    ns: Option<&str>
) -> Option<String>

Remove the attribute with the specified name and namespace. Returns the original value.

pub fn get_child<'a>(
    &'a self,
    name: &str,
    ns: Option<&str>
) -> Option<&'a Element>

Gets the first child Element with the specified name and namespace. When no child with the specified name exists None is returned.

Important traits for ChildElements<'a, 'b>

impl<'a, 'b> Iterator for ChildElements<'a, 'b> type Item = &'a Element;

pub fn get_children<'a, 'b>(
    &'a self,
    name: &'b str,
    ns: Option<&'b str>
) -> ChildElements<'a, 'b>

Get all children Element with the specified name and namespace. When no child with the specified name exists an empty vetor is returned.

pub fn tag(&mut self, child: Element) -> &mut Element

Appends a child element. Returns a reference to the added element.

pub fn tag_stay(&mut self, child: Element) -> &mut Element

Appends a child element. Returns a mutable reference to self.

pub fn text(&mut self, text: String) -> &mut Element

Appends characters. Returns a mutable reference to self.

pub fn cdata(&mut self, text: String) -> &mut Element

Appends CDATA. Returns a mutable reference to self.

pub fn comment(&mut self, text: String) -> &mut Element

Appends a comment. Returns a mutable reference to self.

pub fn pi(&mut self, text: String) -> &mut Element

Appends processing information. Returns a mutable reference to self.

Trait Implementations

impl Clone for Element

fn clone(&self) -> Element

Returns a copy 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

Formats the value using the given formatter.

impl Display for Element

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

Formats the value using the given formatter.

impl FromStr for Element

type Err = BuilderError

The associated error which can be returned from parsing.

fn from_str(data: &str) -> Result<Element, BuilderError>

Parses a string s to return a value of this type.

impl PartialEq<Element> for Element

fn eq(&self, other: &Element) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Element) -> bool

This method tests for !=.

impl StructuralPartialEq for Element