Struct jupiter::ig::xml::Element

pub struct Element<'a, B: BufRead> { /* private fields */ }

Represents a matched element while processing XML data.

Using this type we can enforce proper nesting when handling a stream of XML events with the help of the rust type system.

Implementations

impl<B: BufRead> Element<'_, B>

pub fn name(&self) -> Cow<'_, str>

Returns the name of the element.

Example

let mut reader = PullReader::new("<xml></xml>".as_bytes());
assert_eq!(reader.root().unwrap().name().as_ref(), "xml");

pub fn attributes(&self) -> AttributesView<'_>

Provides access to the attributes of the element.

Example

let mut reader = PullReader::new(r#"<xml test="foo"></xml>"#.as_bytes());
let root = reader.root().unwrap();
let attr = root.attributes().last().unwrap().unwrap();
assert_eq!(attr.key(), "test");
assert_eq!(attr.value().unwrap().contents().as_ref(), "foo");

pub fn find_attribute( &self, name: impl AsRef<str> ) -> Result<Option<AttributeView<'_>>>

Returns the requested attribute.

Example

let mut reader = PullReader::new(r#"<xml test="foo"></xml>"#.as_bytes());
let root = reader.root().unwrap();
assert_eq!(root.find_attribute("test").unwrap().unwrap().value().unwrap().contents().as_ref(), "foo");

pub fn next_child<'a>(&'a mut self) -> Result<Option<Element<'a, B>>>

Returns the next child element of this element.

If an empty value is returned, this element has no more children.

Example

let mut reader = PullReader::new(r#"<xml><item></item></xml>"#.as_bytes());
let mut root = reader.root().unwrap();
assert_eq!(root.next_child().unwrap().unwrap().name().as_ref(), "item");
assert_eq!(root.next_child().unwrap().is_none(), true);

pub fn find_next_child<'a>( &'a mut self, name: impl AsRef<str> ) -> Result<Option<Element<'a, B>>>

Returns the next child element of this element with the given tag name.

This will skip over all other tags until a match is found. If the end of the enclosing tag is reached, none is returned.

Example

let mut reader = PullReader::new(r#"<xml><item></item><test></test></xml>"#.as_bytes());
let mut root = reader.root().unwrap();
assert_eq!(root.find_next_child("test").unwrap().unwrap().name().as_ref(), "test");
assert_eq!(root.find_next_child("test").unwrap().is_none(), true);

pub fn try_text<'a>(&'a mut self) -> Result<Option<Text<'a>>>

Tries to fetch the text contents of this element.

Returns none if this element has no text at all.

Example

let mut reader = PullReader::new(r#"<xml><item>test</item><empty></empty></xml>"#.as_bytes());
let mut root = reader.root().unwrap();
let mut item = root.next_child().unwrap().unwrap();
assert_eq!(item.try_text().unwrap().unwrap().contents().as_ref(), "test");
drop(item);

let mut test = root.next_child().unwrap().unwrap();
assert_eq!(test.try_text().unwrap().is_none(), true);

pub fn text(&mut self) -> Result<Text<'_>>

Fetches the text contents of this element or returns an empty string if no text is present.

Example

let mut reader = PullReader::new(r#"<xml><item>test</item><empty></empty></xml>"#.as_bytes());
let mut root = reader.root().unwrap();
let mut item = root.next_child().unwrap().unwrap();
assert_eq!(item.text().unwrap().contents().as_ref(), "test");
drop(item);

let mut test = root.next_child().unwrap().unwrap();
assert_eq!(test.text().unwrap().contents().as_ref(), "");

Trait Implementations

impl<B: BufRead> Drop for Element<'_, B>

fn drop(&mut self)

Once an element is dropped, we consume all events up until the end tag of the element in the XML data.

This permits to utilize the Rust type system to ensure proper nesting when parsing XML data.