pub struct Document<'d> { /* private fields */ }
Expand description
An XML tree container.
A tree consists of Nodes
.
There are no separate structs for each node type.
So you should check the current node type yourself via Node::node_type()
.
There are only 5 types:
Root, Element, PI, Comment and Text.
As you can see there are no XML declaration and CDATA types. The XML declaration is basically skipped, since it doesn’t contains any valuable information (we support only UTF-8 anyway). And CDATA will be converted into a Text node as is, without any preprocessing (you can read more about it here).
Also, the Text node data can be accesses from the text node itself or from
the parent element via Node::text()
or Node::tail()
.
Implementations
sourceimpl<'d> Document<'d>
impl<'d> Document<'d>
sourcepub fn parse(text: &str) -> Result<Document<'_>, Error>
pub fn parse(text: &str) -> Result<Document<'_>, Error>
Parses the input XML string.
We do not support &[u8]
or Reader
because the input must be an already allocated
UTF-8 string.
Examples
let doc = roxmltree::Document::parse("<e/>").unwrap();
assert_eq!(doc.descendants().count(), 2); // root node + `e` element node
sourceimpl<'d> Document<'d>
impl<'d> Document<'d>
sourcepub fn root<'a>(&'a self) -> Node<'a, 'd>
pub fn root<'a>(&'a self) -> Node<'a, 'd>
Returns the root node.
Examples
let doc = roxmltree::Document::parse("<e/>").unwrap();
assert!(doc.root().is_root());
assert!(doc.root().first_child().unwrap().has_tag_name("e"));
sourcepub fn root_element(&self) -> Node<'_, '_>
pub fn root_element(&self) -> Node<'_, '_>
Returns the root element of the document.
Unlike root
, will return a first element node.
The root element is always exists.
Examples
let doc = roxmltree::Document::parse("<!-- comment --><e/>").unwrap();
assert!(doc.root_element().has_tag_name("e"));
sourcepub fn descendants(&self) -> Descendants<'_, '_> ⓘ
pub fn descendants(&self) -> Descendants<'_, '_> ⓘ
Returns an iterator over document’s descendant nodes.
Shorthand for doc.root().descendants()
.
sourcepub fn text_pos_from(&self, pos: usize) -> TextPos
pub fn text_pos_from(&self, pos: usize) -> TextPos
Calculates TextPos
in the original document from position in bytes.
Note: this operation is expensive.
Examples
let doc = roxmltree::Document::parse("\
<!-- comment -->
<e/>"
).unwrap();
assert_eq!(doc.text_pos_from(10), roxmltree::TextPos::new(1, 11));
assert_eq!(doc.text_pos_from(9999), roxmltree::TextPos::new(2, 5));