Struct xmlparser::Stream

pub struct Stream<'a> { /* fields omitted */ }

A streaming XML parsing interface.

Implementations

impl<'a> Stream<'a>

pub fn from_substr(text: &'a str, fragment: Range<usize>) -> Self

Creates a new stream from a specified text substring.

pub fn span(&self) -> StrSpan<'a>

Returns an underling string span.

pub fn pos(&self) -> usize

Returns current position.

pub fn jump_to_end(&mut self)

Sets current position equal to the end.

Used to indicate end of parsing on error.

pub fn at_end(&self) -> bool

Checks if the stream is reached the end.

Any pos() value larger than original text length indicates stream end.

Accessing stream after reaching end via safe methods will produce an UnexpectedEndOfStream error.

Accessing stream after reaching end via *_unchecked methods will produce a Rust’s bound checking error.

pub fn curr_byte(&self) -> Result<u8, StreamError>

Returns a byte from a current stream position.

Errors

• UnexpectedEndOfStream

pub fn curr_byte_unchecked(&self) -> u8

Returns a byte from a current stream position.

Panics

• if the current position is after the end of the data

pub fn next_byte(&self) -> Result<u8, StreamError>

Returns a next byte from a current stream position.

Errors

• UnexpectedEndOfStream

pub fn advance(&mut self, n: usize)

Advances by n bytes.

Examples

use xmlparser::Stream;

let mut s = Stream::from("text");
s.advance(2); // ok
s.advance(20); // will cause a panic via debug_assert!().

pub fn starts_with(&self, text: &[u8]) -> bool

Checks that the stream starts with a selected text.

We are using &[u8] instead of &str for performance reasons.

Examples

use xmlparser::Stream;

let mut s = Stream::from("Some text.");
s.advance(5);
assert_eq!(s.starts_with(b"text"), true);
assert_eq!(s.starts_with(b"long"), false);

pub fn consume_byte(&mut self, c: u8) -> Result<(), StreamError>

Consumes the current byte if it’s equal to the provided byte.

Errors

• InvalidChar
• UnexpectedEndOfStream

Examples

use xmlparser::Stream;

let mut s = Stream::from("Some text.");
assert!(s.consume_byte(b'S').is_ok());
assert!(s.consume_byte(b'o').is_ok());
assert!(s.consume_byte(b'm').is_ok());
assert!(s.consume_byte(b'q').is_err());

pub fn try_consume_byte(&mut self, c: u8) -> bool

Tries to consume the current byte if it’s equal to the provided byte.

Unlike consume_byte() will not return any errors.

pub fn skip_string(&mut self, text: &'static [u8]) -> Result<(), StreamError>

Skips selected string.

Errors

• InvalidString

pub fn consume_bytes<F>(&mut self, f: F) -> StrSpan<'a> where
    F: Fn(&Stream<'_>, u8) -> bool, 

Consumes bytes by the predicate and returns them.

The result can be empty.

pub fn skip_bytes<F>(&mut self, f: F) where
    F: Fn(&Stream<'_>, u8) -> bool, 

Skips bytes by the predicate.

pub fn consume_chars<F>(&mut self, f: F) -> Result<StrSpan<'a>, StreamError> where
    F: Fn(&Stream<'_>, char) -> bool, 

Consumes chars by the predicate and returns them.

The result can be empty.

pub fn skip_chars<F>(&mut self, f: F) -> Result<(), StreamError> where
    F: Fn(&Stream<'_>, char) -> bool, 

Skips chars by the predicate.

pub fn slice_back(&self, pos: usize) -> StrSpan<'a>

Slices data from pos to the current position.

pub fn slice_tail(&self) -> StrSpan<'a>

Slices data from the current position to the end.

pub fn skip_spaces(&mut self)

Skips whitespaces.

Accepted values: ' ' \n \r \t.

pub fn starts_with_space(&self) -> bool

Checks if the stream is starts with a space.

pub fn consume_spaces(&mut self) -> Result<(), StreamError>

Consumes whitespaces.

Like skip_spaces(), but checks that first char is actually a space.

Errors

• InvalidSpace

pub fn try_consume_reference(&mut self) -> Option<Reference<'a>>

Consumes an XML character reference if there is one.

On error will reset the position to the original.

See consume_reference() for details.

pub fn consume_reference(&mut self) -> Result<Reference<'a>, StreamError>

Consumes an XML reference.

Consumes according to: https://www.w3.org/TR/xml/#NT-Reference

Errors

• InvalidReference

Examples

Escaped character:

use xmlparser::{Stream, Reference};

let mut stream = Stream::from("ณ");
assert_eq!(stream.consume_reference().unwrap(), Reference::Char('\u{e13}'));

Predefined references will not be expanded. Details.

use xmlparser::{Stream, Reference};

let mut stream = Stream::from("≤");
assert_eq!(stream.consume_reference().unwrap(), Reference::Entity("le"));

Named reference:

use xmlparser::{Stream, Reference};

let mut stream = Stream::from("&other;");
assert_eq!(stream.consume_reference().unwrap(), Reference::Entity("other"));

pub fn consume_name(&mut self) -> Result<StrSpan<'a>, StreamError>

Consumes an XML name and returns it.

Consumes according to: https://www.w3.org/TR/xml/#NT-Name

Errors

• InvalidName - if name is empty or starts with an invalid char
• UnexpectedEndOfStream

pub fn skip_name(&mut self) -> Result<(), StreamError>

Skips an XML name.

The same as consume_name(), but does not return a consumed name.

Errors

• InvalidName - if name is empty or starts with an invalid char

pub fn consume_qname(
    &mut self
) -> Result<(StrSpan<'a>, StrSpan<'a>), StreamError>

Consumes a qualified XML name and returns it.

Consumes according to: https://www.w3.org/TR/xml-names/#ns-qualnames

Errors

• InvalidName - if name is empty or starts with an invalid char

pub fn consume_eq(&mut self) -> Result<(), StreamError>

Consumes =.

Consumes according to: https://www.w3.org/TR/xml/#NT-Eq

Errors

• InvalidChar
• UnexpectedEndOfStream

pub fn consume_quote(&mut self) -> Result<u8, StreamError>

Consumes quote.

Consumes ' or " and returns it.

Errors

• InvalidQuote
• UnexpectedEndOfStream

pub fn gen_text_pos(&self) -> TextPos

Calculates a current absolute position.

This operation is very expensive. Use only for errors.

pub fn gen_text_pos_from(&self, pos: usize) -> TextPos

Calculates an absolute position at pos.

This operation is very expensive. Use only for errors.

Examples

let s = xmlparser::Stream::from("text");

assert_eq!(s.gen_text_pos_from(2), xmlparser::TextPos::new(1, 3));
assert_eq!(s.gen_text_pos_from(9999), xmlparser::TextPos::new(1, 5));

Trait Implementations

impl<'a> Clone for Stream<'a>

fn clone(&self) -> Stream<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Stream<'a>

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

Formats the value using the given formatter.

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

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

Performs the conversion.

impl<'a> From<StrSpan<'a>> for Stream<'a>

fn from(span: StrSpan<'a>) -> Self

Performs the conversion.

impl<'a> Hash for Stream<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq<Stream<'a>> for Stream<'a>

fn eq(&self, other: &Stream<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Stream<'a>) -> bool

This method tests for !=.

impl<'a> Copy for Stream<'a>

impl<'a> Eq for Stream<'a>

impl<'a> StructuralEq for Stream<'a>

impl<'a> StructuralPartialEq for Stream<'a>