Skip to main content

Parser

Struct Parser 

Source
pub struct Parser { /* private fields */ }
Expand description

The incremental parser. Create one per stream and feed it each chunk as it arrives, with feed_with or feed.

Implementations§

Source§

impl Parser

Source

pub fn new() -> Self

A parser in the ground state.

Source

pub fn is_ground(&self) -> bool

True when no escape sequence or string is in progress: the next byte starts fresh. A consumer that snapshots its own state (a terminal checkpoint) can do so here without saving the parser’s internals, because a fresh Parser is then indistinguishable from this one.

UTF-8 is not the parser’s concern in feed_with (text arrives as raw bytes); a caller decoding text checks its Utf8Decoder as well.

Source

pub fn feed_with<F: FnMut(Event<'_>)>(&mut self, input: &[u8], f: F)

Tokenize input, calling f once per Event, allocating nothing.

Partial sequences are held for the next call. A text run in progress is always delivered before returning, so no input byte is buffered except inside an unfinished escape sequence.

Source

pub fn feed(&mut self, input: &[u8]) -> Vec<Token>

Feed a chunk of bytes; returns the tokens completed by this chunk.

Any accumulated text run is flushed at the end of the call; partial escape sequences and partial UTF-8 characters are held for the next. This is feed_with with the events copied into owned Tokens; prefer the engine where the allocation matters.

Trait Implementations§

Source§

impl Debug for Parser

Source§

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

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

impl Default for Parser

Source§

fn default() -> Self

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

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.