Struct Stream

pub struct Stream<'a> {
    pub phases: Vec<Phase>,
    /* private fields */
}

Fields

phases: Vec<Phase>

Implementations

impl<'a> Stream<'a>

pub fn new(source: &'a [u8]) -> Self

pub fn is_eof(&self) -> bool

Returns whether the stream is currently at end of file.

pub fn peek(&self) -> Option<u8>

Returns the first character without consuming it.

pub fn advance_by(&mut self, len: usize)

Advances the stream by len bytes.

pub fn untake(&mut self)

Undoes a take.

pub fn take(&mut self) -> Option<u8>

Returns the first character of the stream and advances. If at end of stream, returns None.

pub fn take_n<const N: usize>(&mut self) -> Option<[u8; N]>

Returns the first character of the stream and advances. If at end of stream, returns None.

pub fn remainder(&self) -> &'a [u8]

The remaining bytes in the source stream

pub fn take_if<C: TakeCondition<'a>>( &mut self, condition: C, ) -> Option<C::Output>

Advances the stream forward if condition matches.

pub fn advance_if<C: TakeCondition<'a>>(&mut self, condition: C) -> bool

Advances the stream forward if condition matches.

pub fn take_while<F: FnMut(u8) -> bool>(&mut self, condition: F) -> &'a [u8]

Same

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> PartialEq for Stream<'a>

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

Tests for self and other values to be equal, and is used by ==.

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

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

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