Struct EventReader 

pub struct EventReader<R: Read> { /* private fields */ }

A wrapper around an std::io::Read instance which provides pull-based XML parsing.

The reader should be wrapped in a BufReader, otherwise parsing may be very slow.

Implementations

impl<R: Read> EventReader<R>

pub fn new(source: R) -> Self

Creates a new reader, consuming the given stream. The reader should be wrapped in a BufReader, otherwise parsing may be very slow.

pub fn new_with_config(source: R, config: impl Into<ParserConfig>) -> Self

Creates a new reader with the provded configuration, consuming the given stream. The reader should be wrapped in a BufReader, otherwise parsing may be very slow.

pub fn next(&mut self) -> Result<XmlEvent>

Pulls and returns next XML event from the stream.

If this returns Err or XmlEvent::EndDocument then further calls to this method will return this event again.

pub fn skip(&mut self) -> Result<()>

Skips all XML events until the next end tag at the current level.

Convenience function that is useful for the case where you have encountered a start tag that is of no interest and want to skip the entire XML subtree until the corresponding end tag.

pub fn source(&self) -> &R

Access underlying reader

Using it directly while the event reader is parsing is not recommended

pub fn source_mut(&mut self) -> &mut R

Access underlying reader

Using it directly while the event reader is parsing is not recommended

pub fn into_inner(self) -> R

Unwraps this EventReader, returning the underlying reader.

Note that this operation is destructive; unwrapping the reader and wrapping it again with EventReader::new() will create a fresh reader which will attempt to parse an XML document from the beginning.

pub fn doctype(&self) -> Option<&str>

👎Deprecated: there is XmlEvent::Doctype now

Returns the DOCTYPE of the document if it has already been seen

Available only after the root StartElement event

pub fn add_entities<S: Into<String>, T: Into<String>>( &mut self, entities: impl IntoIterator<Item = (S, T)>, ) -> Result<(), ImmutableEntitiesError>

Add new entity definitions before any XML elements have been parsed.

Errors

It’s valid to call this after DOCTYPE, but not later. It won’t be possible to add entities to a document without either XML decl or DOCTYPE.

It will fail if the document is declared as standalone.

impl<'r> EventReader<&'r [u8]>

pub fn from_str(source: &'r str) -> Self

A convenience method to create an XmlReader from a string slice.

Trait Implementations

impl<R: Read> IntoIterator for EventReader<R>

type IntoIter = Events<R>

Which kind of iterator are we turning this into?

type Item = Result<XmlEvent, Error>

The type of the elements being iterated over.

fn into_iter(self) -> Events<R>

Creates an iterator from a value.

impl<B: Read> Position for EventReader<B>

fn position(&self) -> TextPosition

Returns the position of the last event produced by the reader.