Struct bparse::Parser

pub struct Parser<'input> {
    pub pos: usize,
    /* private fields */
}

A byte parser that recognizes Patterns

Fields

pos: usize

The parser’s current position within the input

Implementations

impl<'i> Parser<'i>

pub fn new(input: &'i [u8]) -> Self

Returns a new instance of Parser that will operate on input

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

Advances the parser by step. Does nothing if the parser is at the end of the input

pub fn eof(&self) -> bool

Returns true if the parser reached the end of its input. Returns false otherwise

pub fn remaining(&self) -> &'i [u8]

Returns the part of the input that is yet to be consumed

pub fn try_match(&mut self, pattern: impl Pattern) -> Option<&'i [u8]>

Tests pattern against the remaining input. If the pattern matches, the matching portion is returned and the parser is advanced by the length of the matched slice.

Returns None if the pattern does not match.

pub fn peek_match(&self, pattern: impl Pattern) -> Option<&'i [u8]>

Tests pattern against the remaining input but does not advance the parser. The matching portion is returned.

You can use Parser::assert later to advance the parser with the same pattern.

pub fn assert(&mut self, pattern: impl Pattern) -> &'i [u8]

Similar to Parser::try_match, but panics if the pattern does not match.

This could be useful when you have previously peeked at the input (perhaps by using Pattern::test or Parser::peek_match) and later want to advance the parser