Struct jupiter::ig::xml::PullReader

source ·
pub struct PullReader<B: BufRead> { /* private fields */ }
Expand description

Provides a high level abstraction above Reader as provided by quick_xml.

This takes care of buffer management and encoding of all data and provides a convenient API to process XML Data.

Implementations§

source§

impl<B: BufRead> PullReader<B>

source

pub fn new(input: B) -> Self

Creates a new reader for the given input.

This reader will automatically trim and enforce proper nesting in the XML data.

§Example
let data = r#"
<xml>
    <entry><name>42</name><value>foo</value></entry>
</xml>
"#;

let mut reader = PullReader::new(data.as_bytes());
source

pub fn from_reader(reader: Reader<B>) -> Self

Creates a new reader based on the given reader object.

source

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

Reads the root element of the underlying doc.

This is mostly used so that all parsing functionality is centralized in Element.

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

Auto Trait Implementations§

§

impl<B> !Freeze for PullReader<B>

§

impl<B> !RefUnwindSafe for PullReader<B>

§

impl<B> Send for PullReader<B>
where B: Send,

§

impl<B> !Sync for PullReader<B>

§

impl<B> Unpin for PullReader<B>
where B: Unpin,

§

impl<B> UnwindSafe for PullReader<B>
where B: UnwindSafe,

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> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more