pub struct Stream<'a> { /* private fields */ }Expand description
A streaming text parsing interface.
Implementations§
source§impl<'a> Stream<'a>
impl<'a> Stream<'a>
sourcepub fn jump_to_end(&mut self)
pub fn jump_to_end(&mut self)
Sets current position equal to the end.
Used to indicate end of parsing on error.
sourcepub fn at_end(&self) -> bool
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.
sourcepub fn curr_byte(&self) -> Result<u8, StreamError>
pub fn curr_byte(&self) -> Result<u8, StreamError>
sourcepub fn curr_byte_unchecked(&self) -> u8
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
sourcepub fn is_curr_byte_eq(&self, c: u8) -> bool
pub fn is_curr_byte_eq(&self, c: u8) -> bool
Checks that current byte is equal to provided.
Returns false if no bytes left.
sourcepub fn get_curr_byte(&self) -> Option<u8>
pub fn get_curr_byte(&self) -> Option<u8>
Returns a byte from a current stream position if there is one.
sourcepub fn next_byte(&self) -> Result<u8, StreamError>
pub fn next_byte(&self) -> Result<u8, StreamError>
sourcepub fn curr_char(&self) -> Result<char, StreamError>
pub fn curr_char(&self) -> Result<char, StreamError>
sourcepub fn advance(&mut self, n: usize)
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!().sourcepub fn skip_spaces(&mut self)
pub fn skip_spaces(&mut self)
Skips whitespaces.
Accepted values: ' ' \n \r \t   	 
 
.
Examples
use xmlparser::Stream;
let mut s = Stream::from(" \t\n\r   ");
s.skip_spaces();
assert_eq!(s.at_end(), true);sourcepub fn skip_ascii_spaces(&mut self)
pub fn skip_ascii_spaces(&mut self)
Skips ASCII whitespaces.
Accepted values: ' ' \n \r \t.
sourcepub fn starts_with(&self, text: &[u8]) -> bool
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);sourcepub fn starts_with_space(&self) -> bool
pub fn starts_with_space(&self) -> bool
Checks if the stream is starts with a space.
Uses skip_spaces() internally.
sourcepub fn consume_spaces(&mut self) -> Result<(), StreamError>
pub fn consume_spaces(&mut self) -> Result<(), StreamError>
Consumes whitespaces.
Like skip_spaces(), but checks that first char is actually a space.
Errors
InvalidChar
sourcepub fn consume_byte(&mut self, c: u8) -> Result<(), StreamError>
pub fn consume_byte(&mut self, c: u8) -> Result<(), StreamError>
Consumes current byte if it’s equal to the provided byte.
Errors
InvalidCharUnexpectedEndOfStream
Examples
use xmlparser::Stream;
let mut s = Stream::from("Some text.");
s.consume_byte(b'S').unwrap();
s.consume_byte(b'o').unwrap();
s.consume_byte(b'm').unwrap();
// s.consume_byte(b'q').unwrap(); // will produce an errorsourcepub fn consume_either(&mut self, list: &[u8]) -> Result<u8, StreamError>
pub fn consume_either(&mut self, list: &[u8]) -> Result<u8, StreamError>
Consumes current byte if it’s equal to one of the provided bytes.
Returns a coincidental byte.
Errors
InvalidCharUnexpectedEndOfStream
sourcepub fn skip_string(&mut self, text: &[u8]) -> Result<(), StreamError>
pub fn skip_string(&mut self, text: &[u8]) -> Result<(), StreamError>
sourcepub fn consume_name(&mut self) -> Result<StrSpan<'a>, StreamError>
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 charUnexpectedEndOfStream
sourcepub fn skip_name(&mut self) -> Result<(), StreamError>
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 charUnexpectedEndOfStream
sourcepub fn consume_qname(
&mut self
) -> Result<(StrSpan<'a>, StrSpan<'a>), StreamError>
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 charUnexpectedEndOfStream
sourcepub fn consume_eq(&mut self) -> Result<(), StreamError>
pub fn consume_eq(&mut self) -> Result<(), StreamError>
sourcepub fn consume_quote(&mut self) -> Result<u8, StreamError>
pub fn consume_quote(&mut self) -> Result<u8, StreamError>
sourcepub fn consume_bytes<F>(&mut self, f: F) -> StrSpan<'a>where
F: Fn(&Stream<'_>, u8) -> bool,
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.
sourcepub fn skip_bytes<F>(&mut self, f: F)where
F: Fn(&Stream<'_>, u8) -> bool,
pub fn skip_bytes<F>(&mut self, f: F)where
F: Fn(&Stream<'_>, u8) -> bool,
Consumes bytes by the predicate.
sourcepub fn consume_chars<F>(&mut self, f: F) -> StrSpan<'a>where
F: Fn(&Stream<'_>, char) -> bool,
pub fn consume_chars<F>(&mut self, f: F) -> StrSpan<'a>where
F: Fn(&Stream<'_>, char) -> bool,
Consumes chars by the predicate and returns them.
The result can be empty.
sourcepub fn skip_chars<F>(&mut self, f: F)where
F: Fn(&Stream<'_>, char) -> bool,
pub fn skip_chars<F>(&mut self, f: F)where
F: Fn(&Stream<'_>, char) -> bool,
Consumes chars by the predicate.
sourcepub fn try_consume_reference(&mut self) -> Option<Reference<'a>>
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.
sourcepub fn consume_reference(&mut self) -> Result<Reference<'a>, StreamError>
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
InvalidReferenceUnexpectedEndOfStream
sourcepub fn slice_back(&self, pos: usize) -> StrSpan<'a>
pub fn slice_back(&self, pos: usize) -> StrSpan<'a>
Slices data from pos to the current position.
sourcepub fn slice_tail(&self) -> StrSpan<'a>
pub fn slice_tail(&self) -> StrSpan<'a>
Slices data from the current position to the end.
sourcepub fn gen_text_pos(&self) -> TextPos
pub fn gen_text_pos(&self) -> TextPos
Calculates a current absolute position.
This operation is very expensive. Use only for errors.
sourcepub fn gen_text_pos_from(&self, pos: usize) -> TextPos
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));