quick_xml::parser

Struct PiParser

Source
pub struct PiParser(pub bool);
Expand description

A parser that search a ?> sequence in the slice.

To use a parser create an instance of parser and feed data into it. After successful search the parser will return Some with position where processing instruction is ended (the position after ?>). If search was unsuccessful, a None will be returned. You typically would expect positive result of search, so that you should feed new data until you get it.

NOTE: after successful match the parser does not returned to the initial state and should not be used anymore. Create a new parser if you want to perform new search.

§Example

use quick_xml::parser::{Parser, PiParser};

let mut parser = PiParser::default();

// Parse `<?instruction with = 'some > and ?' inside?>and the text follow...`
// splitted into three chunks
assert_eq!(parser.feed(b"<?instruction"), None);
// ...get new chunk of data
assert_eq!(parser.feed(b" with = 'some > and ?"), None);
// ...get another chunk of data
assert_eq!(parser.feed(b"' inside?>and the text follow..."), Some(9));
//                       ^        ^
//                       0        9

Tuple Fields§

§0: bool

A flag that indicates was the bytes in the previous attempt to find the end ended with ?.

Trait Implementations§

Source§

impl Clone for PiParser

Source§

fn clone(&self) -> PiParser

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PiParser

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for PiParser

Source§

fn default() -> PiParser

Returns the “default value” for a type. Read more
Source§

impl Parser for PiParser

Source§

fn feed(&mut self, bytes: &[u8]) -> Option<usize>

Determines the end position of a processing instruction in the provided slice. Processing instruction ends on the first occurrence of ?> which cannot be escaped.

Returns position after the ?> or None if such sequence was not found.

Section 2.6: Parameter entity references MUST NOT be recognized within processing instructions, so parser do not search for them.

§Parameters
  • bytes: a slice to find the end of a processing instruction. Should contain text in ASCII-compatible encoding
Source§

fn eof_error() -> SyntaxError

Returns parse error produced by this parser in case of reaching end of input without finding the end of a parsed thing.
Source§

impl PartialEq for PiParser

Source§

fn eq(&self, other: &PiParser) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for PiParser

Source§

impl Eq for PiParser

Source§

impl StructuralPartialEq for PiParser

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.