Struct Reader 

pub struct Reader<'r> {
    pub index: usize,
    pub line: usize,
    pub column: usize,
    /* private fields */
}

Fields

index: usize

line: usize

location feature required
Line of current parsing point

column: usize

location feature required
Column of current parsing point

Implementations

impl<'r> Reader<'r>

pub const fn new(buf: &'r [u8]) -> Self

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

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

Advance by max bytes (or, if remaining bytes is shorter than max, read all remaining bytes)

pub fn unwind_by(&mut self, max: usize)

Unwind the parsing point by max bytes (or, if already-read bytes is shorter than max, rewind all)

When "location" feature is activated, this may be less performant for some extensive input

pub fn skip_while(&mut self, condition: impl Fn(&u8) -> bool)

Skip next byte while condition holds on it

pub fn skip_whitespace(&mut self)

skip_while(u8::is_ascii_whitespace)

pub fn read_while(&mut self, condition: impl Fn(&u8) -> bool) -> &'r [u8]

Read next byte while the condition holds on it

pub fn read_until(&mut self, pattern: impl AsRef<[u8]>) -> &'r [u8]

Read through until the pattern comes in front of reader.

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

Read next byte, or return None if the remaining bytes is empty

pub fn next_if(&mut self, condition: impl Fn(&u8) -> bool) -> Option<u8>

Read next byte if the condition holds on it

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

Peek next byte (without consuming)

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

Peek next byte of next byte (without consuming)

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

Peek next byte of next byte of next byte (without consuming)

pub fn consume(&mut self, token: impl AsRef<[u8]>) -> Option<()>

Read token if the remaining bytes start with it

pub fn consume_oneof<const N: usize>( &mut self, tokens: [impl AsRef<[u8]>; N], ) -> Option<usize>

Read the first token in tokens that matches the start with the remaining bytes, and returns the index of the (matched) token, or None if none matches

impl<'r> Reader<'r>

pub fn read_camel(&mut self) -> Option<&'r str>

text feature required
Read a camelCase word like helloWorld, userID, … as &str if found

pub fn read_snake(&mut self) -> Option<&'r str>

text feature required
Read a snake_case word like hello_world, user_id, … as &str if found

pub fn read_kebab(&mut self) -> Option<&'r str>

text feature required
Read a kebeb-case word like hello-world, Content-Type, … as &str if found

pub fn read_quoted_by(&mut self, left: u8, right: u8) -> Option<&'r [u8]>

text feature required
Read all bytes enclosed between left and right, then consume left, the bytes and right, and return the bytes.

Or, returns None if left or right is not found in remaining bytes.

pub fn read_uint(&mut self) -> Option<usize>

text feature required
Read an unsigned integer literal like 42, 123 as usize if found

• Panics if the integer is larger than usize::MAX

pub fn read_int(&mut self) -> Option<isize>

text feature required
Read an integer literal like 42, -1111 as isize if found

• Panics if not isize::MIN <= {the integer} <= isize::MAX