Struct Parser 

pub struct Parser<'a> { /* private fields */ }

A consistent front door for parsing XML.

from(source) → optional options → a terminal (parse for a DOM, or events for a buffered event list).

Implementations

impl<'a> Parser<'a>

pub fn from_reader<R: BufRead + 'a>(reader: R) -> Self

Creates a parser that reads its input from any BufRead.

from cannot be used for readers because of Rust coherence (From<&str> and a blanket From<R: BufRead> cannot coexist).

pub fn options(self, options: ParserOptions) -> Self

Sets the parser options (buffer size, memory limits, libxml-compat, …).

pub fn parse(self) -> Result<XmlDocument>

Parses the input into a DOM XmlDocument.

pub fn events(self) -> Result<Vec<XmlEvent>>

Parses the input and returns all XML events as a buffered Vec.

This collects the full event stream into memory. For push-based streaming without buffering, use for_each_event.

pub fn for_each_event<F>(self, on_event: F) -> Result<()>

where F: FnMut(&XmlEvent) -> Result<()>,

Streams the input, invoking on_event for every event as it is read, with constant memory (nothing is buffered).

The callback is borrowed for the duration of the call, so it may capture and mutate local state. Return Err(..) to stop early.

let mut elements = 0;
Parser::from_reader(file).for_each_event(|event| {
    if matches!(event, XmlEvent::StartElement { .. }) {
        elements += 1;
    }
    Ok(())
})?;

Trait Implementations

impl<'a> From<&'a [u8]> for Parser<'a>

fn from(xml: &'a [u8]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for Parser<'a>

fn from(xml: &'a str) -> Self

Converts to this type from the input type.