Struct byte_parser::Parser

pub struct Parser<'s> { /* fields omitted */ }

ParseIterator implementation for a slice.

Implementations

impl<'s> Parser<'s>

pub fn new(slice: &'s [u8]) -> Self

Creates a new Parser from a slice.

Trait Implementations

impl<'s> Debug for Parser<'s>

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

Formats the value using the given formatter.

impl<'s> ParseIterator<'s> for Parser<'s>

type PointInTime = ParserPointInTime

The type that is used to store information about the current position.

fn slice(&self) -> &'s [u8]

Returns the full underlying slice.

fn pit(&self) -> Self::PointInTime

Returns the current position. Should be used in combination with restore_pit.

fn restore_pit(&mut self, pit: Self::PointInTime)

Restore to a given position.

fn advance(&mut self) -> Option<()>

Advances the internal position.

fn recorder(&self) -> Option<&Recorder>

Returns a Recorder if recording was started.

unsafe fn is_valid_utf8() -> bool

Safety

fn byte(&self) -> Option<u8>

Returns the current byte if it exists.

fn next(&mut self) -> Option<u8>

Returns the next byte if it exists and advances the internal position.

fn next_if<F>(&mut self, next_if: F) -> Option<u8> where
    F: FnOnce(&u8) -> bool, 

Advances one if next_if returns true.

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

Returns the next byte without advancing the internal position.

fn peek_len(&mut self, len: usize) -> Option<&'s [u8]> where
    Self: Sized, 

Returns the next x bytes without advancing the internal position.

fn peek_at(&mut self, pos: usize) -> Option<u8>

Tries to get the byte at the given position, without advancing.

fn ignore_byte(&mut self, byte: u8) -> IgnoreByte<'_, Self> where
    Self: Sized, 

Skips a given byte when calling next.

fn while_byte_fn<F>(&mut self, f: F) -> WhileByteFn<'_, Self, F> where
    Self: Sized,
    F: Fn(&u8) -> bool, 

Advances while the function returns true.

fn consume(&mut self) -> &mut Self

Consumes until the iterator is empty. Meaning that advance returns None.

fn consume_and_count(&mut self) -> usize

Consumes until the iterator is empty, and returns how many times advance got called.

fn consume_len(&mut self, len: usize) -> Result<&mut Self, usize>

Consumes a given length. Returns how much was consumed if could not consume all.

fn consume_at_least(&mut self, len: usize) -> Result<&mut Self, usize>

Consumes until the iterator is empty. Returns Err(len) if could not consume len.

fn consume_at_least_and_count(&mut self, len: usize) -> Result<usize, usize>

Consumes until the iterator is empty, returning how much was consumed. Returns Err(len) if could not consume len.

fn consume_while_byte_fn<F>(&mut self, f: F) -> &mut Self where
    Self: Sized,
    F: Fn(&u8) -> bool, 

Consumes while the function returns true.

fn consume_while_byte(&mut self, byte: u8) -> &mut Self where
    Self: Sized, 

Consumes while a give byte is returned.

fn split_on_byte(&mut self, byte: u8) -> SplitOnByte<'_, Self> where
    Self: Sized, 

Splits the iterator at a given byte.

fn count_byte(&mut self, byte: u8) -> usize where
    Self: Sized, 

fn record(&mut self) -> RecordIter<'_, Self> where
    Self: Sized, 

Starts a new Recorder which starts recording at this position.

fn to_slice(&self) -> &'s [u8]

Returns a slice from the start of recording until now.

unsafe fn to_str_unchecked(&self) -> &'s str

Returns a str from the start of recording until the current position without checking if the data is valid utf8.

fn to_str(&self) -> &'s str

Returns a str from the start of recording until the current position.

fn try_to_str(&self) -> Result<&'s str, Utf8Error>

Returns a str from the start of recording until the current position.

fn consume_to_slice(&mut self) -> &'s [u8]

Consumes the iterator and then returns a slice from the start of recording until the current position.

unsafe fn consume_to_str_unchecked(&mut self) -> &'s str

Consumes the iterator and then returns a str from the start of recording until the current position. Without checking if the underlying data is valid utf8.

fn consume_to_str(&mut self) -> &'s str

Consumes the iterator and then returns a str from the start of recording until the current position.

fn consume_try_to_str(&mut self) -> Result<&'s str, Utf8Error>

Consumes the iterator and then returns a str from the start of recording until the current position if the data is valid utf8.

fn expect_byte_fn<F>(&mut self, f: F) -> Result<&mut Self, Option<u8>> where
    F: Fn(u8) -> bool, 

Returns &mut Self if the function returns true on the next byte. Else returns the byte that was received.

fn expect_byte(&mut self, byte: u8) -> Result<&mut Self, Option<u8>>

Returns &mut Self if the function byte is equal to the next byte. Else returns the actual byte that was received.

fn expect_none(&mut self) -> Result<&mut Self, u8>

Returns &mut Self if the end was reached (next returns None).

fn stop(&mut self) -> Stop<'_, Self> where
    Self: Sized, 

Returns a ParseIterator that always returns None.