Skip to main content

Reader

Struct Reader 

Source
pub struct Reader<'a> { /* private fields */ }
Expand description

Reads a sequence of generic XML events from an in-memory UTF-8 string.

This is a thin wrapper around quick_xml::Reader, scoped to xml-core’s own error type so that callers never need to depend on quick_xml directly.

§Whitespace handling

Unlike some XML tooling, this reader does not trim whitespace from text nodes automatically. Whether leading/trailing whitespace inside an element is significant depends on the vocabulary being parsed (for example, xml:space="preserve" in WordprocessingML) — a decision that belongs to the higher-level crates, not to this generic layer.

§Scope

This first version only supports reading from an in-memory &str. Real OOXML parts are read fully into memory from their ZIP entry before parsing anyway, so this covers the toolkit’s actual needs; streaming from an arbitrary std::io::Read source can be added later if needed.

Implementations§

Source§

impl<'a> Reader<'a>

Source

pub fn from_xml_str(xml: &'a str) -> Reader<'a>

Creates a new reader over the given XML string.

Source

pub fn read_event(&mut self) -> Result<Event<'a>, Error>

Reads the next XML event.

Returns Ok(Event::Eof) once the end of the input has been reached.

Auto Trait Implementations§

§

impl<'a> Freeze for Reader<'a>

§

impl<'a> RefUnwindSafe for Reader<'a>

§

impl<'a> Send for Reader<'a>

§

impl<'a> Sync for Reader<'a>

§

impl<'a> Unpin for Reader<'a>

§

impl<'a> UnsafeUnpin for Reader<'a>

§

impl<'a> UnwindSafe for Reader<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.