Struct Element

pub struct Element {
    pub prefixes: Prefixes,
    /* private fields */
}

A struct representing a DOM Element.

Fields

prefixes: Prefixes

Namespace declarations

Implementations

impl Element

pub fn builder<S: AsRef<str>, NS: Into<String>>( name: S, namespace: NS, ) -> ElementBuilder

Return a builder for an Element with the given name.

Examples

use minidom::Element;

let elem = Element::builder("name", "namespace")
                   .attr("name", "value")
                   .append("inner")
                   .build();

assert_eq!(elem.name(), "name");
assert_eq!(elem.ns(), "namespace".to_owned());
assert_eq!(elem.attr("name"), Some("value"));
assert_eq!(elem.attr("inexistent"), None);
assert_eq!(elem.text(), "inner");

pub fn bare<S: Into<String>, NS: Into<String>>( name: S, namespace: NS, ) -> Element

Returns a bare minimum Element with this name.

Examples

use minidom::Element;

let bare = Element::bare("name", "namespace");

assert_eq!(bare.name(), "name");
assert_eq!(bare.ns(), "namespace");
assert_eq!(bare.attr("name"), None);
assert_eq!(bare.text(), "");

pub fn name(&self) -> &str

Returns a reference to the local name of this element (that is, without a possible prefix).

pub fn ns(&self) -> String

Returns a reference to the namespace of this element.

pub fn attr(&self, name: &str) -> Option<&str>

Returns a reference to the value of the given attribute, if it exists, else None.

pub fn attrs(&self) -> Attrs<'_>

Returns an iterator over the attributes of this element.

Example

use minidom::Element;

let elm: Element = "<elem xmlns=\"ns1\" a=\"b\" />".parse().unwrap();

let mut iter = elm.attrs();

assert_eq!(iter.next().unwrap(), ("a", "b"));
assert_eq!(iter.next(), None);

pub fn attrs_mut(&mut self) -> AttrsMut<'_>

Returns an iterator over the attributes of this element, with the value being a mutable reference.

pub fn set_attr<S: Into<String>, V: IntoAttributeValue>( &mut self, name: S, val: V, )

Modifies the value of an attribute.

pub fn is<'a, N: AsRef<str>, NS: Into<NSChoice<'a>>>( &self, name: N, namespace: NS, ) -> bool

Returns whether the element has the given name and namespace.

Examples

use minidom::{Element, NSChoice};

let elem = Element::builder("name", "namespace").build();

assert_eq!(elem.is("name", "namespace"), true);
assert_eq!(elem.is("name", "wrong"), false);
assert_eq!(elem.is("wrong", "namespace"), false);
assert_eq!(elem.is("wrong", "wrong"), false);

assert_eq!(elem.is("name", NSChoice::OneOf("namespace")), true);
assert_eq!(elem.is("name", NSChoice::OneOf("foo")), false);
assert_eq!(elem.is("name", NSChoice::AnyOf(&["foo", "namespace"])), true);
assert_eq!(elem.is("name", NSChoice::Any), true);

pub fn has_ns<'a, NS: Into<NSChoice<'a>>>(&self, namespace: NS) -> bool

Returns whether the element has the given namespace.

Examples

use minidom::{Element, NSChoice};

let elem = Element::builder("name", "namespace").build();

assert_eq!(elem.has_ns("namespace"), true);
assert_eq!(elem.has_ns("wrong"), false);

assert_eq!(elem.has_ns(NSChoice::OneOf("namespace")), true);
assert_eq!(elem.has_ns(NSChoice::OneOf("foo")), false);
assert_eq!(elem.has_ns(NSChoice::AnyOf(&["foo", "namespace"])), true);
assert_eq!(elem.has_ns(NSChoice::Any), true);

pub fn from_reader<R: BufRead>(reader: R) -> Result<Element>

Parse a document from a BufRead.

pub fn from_reader_with_prefixes<R: BufRead, P: Into<Prefixes>>( reader: R, prefixes: P, ) -> Result<Element>

Parse a document from a BufRead, allowing Prefixes to be specified. Useful to provide knowledge of namespaces that would have been declared on parent elements not present in the reader.

pub fn write_to<W: Write>(&self, writer: &mut W) -> Result<()>

Output a document to a Writer.

pub fn write_to_decl<W: Write>(&self, writer: &mut W) -> Result<()>

Output a document to a Writer.

pub fn to_writer<W: Write>(&self, writer: &mut ItemWriter<W>) -> Result<()>

Output the document to an ItemWriter

pub fn to_writer_decl<W: Write>(&self, writer: &mut ItemWriter<W>) -> Result<()>

Output the document to an ItemWriter

pub fn write_to_inner<W: Write>(&self, writer: &mut ItemWriter<W>) -> Result<()>

Like write_to() but without the <?xml?> prelude

pub fn take_nodes(&mut self) -> Vec<Node>

Extracts all children into a collection.

pub fn nodes(&self) -> Nodes<'_>

Returns an iterator over references to every child node of this element.

Examples

use minidom::Element;

let elem: Element = "<root xmlns=\"ns1\">a<c1 />b<c2 />c</root>".parse().unwrap();

let mut iter = elem.nodes();

assert_eq!(iter.next().unwrap().as_text().unwrap(), "a");
assert_eq!(iter.next().unwrap().as_element().unwrap().name(), "c1");
assert_eq!(iter.next().unwrap().as_text().unwrap(), "b");
assert_eq!(iter.next().unwrap().as_element().unwrap().name(), "c2");
assert_eq!(iter.next().unwrap().as_text().unwrap(), "c");
assert_eq!(iter.next(), None);

pub fn nodes_mut(&mut self) -> NodesMut<'_>

Returns an iterator over mutable references to every child node of this element.

pub fn children(&self) -> Children<'_>

Returns an iterator over references to every child element of this element.

Examples

use minidom::Element;

let elem: Element = "<root xmlns=\"ns1\">hello<child1 xmlns=\"ns1\"/>this<child2 xmlns=\"ns1\"/>is<child3 xmlns=\"ns1\"/>ignored</root>".parse().unwrap();

let mut iter = elem.children();
assert_eq!(iter.next().unwrap().name(), "child1");
assert_eq!(iter.next().unwrap().name(), "child2");
assert_eq!(iter.next().unwrap().name(), "child3");
assert_eq!(iter.next(), None);

pub fn children_mut(&mut self) -> ChildrenMut<'_>

Returns an iterator over mutable references to every child element of this element.

pub fn texts(&self) -> Texts<'_>

Returns an iterator over references to every text node of this element.

Examples

use minidom::Element;

let elem: Element = "<root xmlns=\"ns1\">hello<c /> world!</root>".parse().unwrap();

let mut iter = elem.texts();
assert_eq!(iter.next().unwrap(), "hello");
assert_eq!(iter.next().unwrap(), " world!");
assert_eq!(iter.next(), None);

pub fn texts_mut(&mut self) -> TextsMut<'_>

Returns an iterator over mutable references to every text node of this element.

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

Appends a child node to the Element, returning the appended node.

Examples

use minidom::Element;

let mut elem = Element::bare("root", "ns1");

assert_eq!(elem.children().count(), 0);

elem.append_child(Element::bare("child", "ns1"));

{
    let mut iter = elem.children();
    assert_eq!(iter.next().unwrap().name(), "child");
    assert_eq!(iter.next(), None);
}

let child = elem.append_child(Element::bare("new", "ns1"));

assert_eq!(child.name(), "new");

pub fn append_text_node<S: Into<String>>(&mut self, child: S)

Appends a text node to an Element.

Examples

use minidom::Element;

let mut elem = Element::bare("node", "ns1");

assert_eq!(elem.text(), "");

elem.append_text_node("text");

assert_eq!(elem.text(), "text");

pub fn append_text<S: Into<String>>(&mut self, text: S)

Appends a string as plain text to an Element.

If the last child node of the element is a text node, the string will be appended to it. Otherwise, a new text node will be created.

Examples

use minidom::Element;

let mut elem = Element::bare("node", "ns1");

assert_eq!(elem.text(), "");

elem.append_text_node("text");

elem.append_text(" and more text");

assert_eq!(elem.nodes().count(), 1);

pub fn append_node(&mut self, node: Node)

Appends a node to an Element.

Examples

use minidom::{Element, Node};

let mut elem = Element::bare("node", "ns1");

elem.append_node(Node::Text("hello".to_owned()));

assert_eq!(elem.text(), "hello");

pub fn text(&self) -> String

Returns the concatenation of all text nodes in the Element.

Examples

use minidom::Element;

let elem: Element = "<node xmlns=\"ns1\">hello,<split /> world!</node>".parse().unwrap();

assert_eq!(elem.text(), "hello, world!");

pub fn get_child<'a, N: AsRef<str>, NS: Into<NSChoice<'a>>>( &self, name: N, namespace: NS, ) -> Option<&Element>

Returns a reference to the first child element with the specific name and namespace, if it exists in the direct descendants of this Element, else returns None.

Examples

use minidom::{Element, NSChoice};

let elem: Element = r#"<node xmlns="ns"><a/><a xmlns="other_ns" /><b/></node>"#.parse().unwrap();
assert!(elem.get_child("a", "ns").unwrap().is("a", "ns"));
assert!(elem.get_child("a", "other_ns").unwrap().is("a", "other_ns"));
assert!(elem.get_child("b", "ns").unwrap().is("b", "ns"));
assert_eq!(elem.get_child("c", "ns"), None);
assert_eq!(elem.get_child("b", "other_ns"), None);
assert_eq!(elem.get_child("a", "inexistent_ns"), None);

pub fn get_child_mut<'a, N: AsRef<str>, NS: Into<NSChoice<'a>>>( &mut self, name: N, namespace: NS, ) -> Option<&mut Element>

Returns a mutable reference to the first child element with the specific name and namespace, if it exists in the direct descendants of this Element, else returns None.

pub fn has_child<'a, N: AsRef<str>, NS: Into<NSChoice<'a>>>( &self, name: N, namespace: NS, ) -> bool

Returns whether a specific child with this name and namespace exists in the direct descendants of the Element.

Examples

use minidom::{Element, NSChoice};

let elem: Element = r#"<node xmlns="ns"><a /><a xmlns="other_ns" /><b /></node>"#.parse().unwrap();
assert_eq!(elem.has_child("a", "other_ns"), true);
assert_eq!(elem.has_child("a", "ns"), true);
assert_eq!(elem.has_child("a", "inexistent_ns"), false);
assert_eq!(elem.has_child("b", "ns"), true);
assert_eq!(elem.has_child("b", "other_ns"), false);
assert_eq!(elem.has_child("b", "inexistent_ns"), false);

pub fn remove_child<'a, N: AsRef<str>, NS: Into<NSChoice<'a>>>( &mut self, name: N, namespace: NS, ) -> Option<Element>

Removes the first child with this name and namespace, if it exists, and returns an Option<Element> containing this child if it succeeds. Returns None if no child matches this name and namespace.

Examples

use minidom::{Element, NSChoice};

let mut elem: Element = r#"<node xmlns="ns"><a /><a xmlns="other_ns" /><b /></node>"#.parse().unwrap();
assert!(elem.remove_child("a", "ns").unwrap().is("a", "ns"));
assert!(elem.remove_child("a", "ns").is_none());
assert!(elem.remove_child("inexistent", "inexistent").is_none());

pub fn unshift_child(&mut self) -> Option<Element>

Remove the leading nodes up to the first child element and return it

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<'a> From<&'a Element> for String

fn from(elem: &'a Element) -> String

Converts to this type from the input type.

impl FromStr for Element

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Element>

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

impl PartialEq for Element

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