Struct yaml_peg::parser::Parser

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

Basic greedy parser with YAML syntax.

Its methods are actually the sub-parser of the syntax.

Fields

pos: usize

Current position.

eaten: usize

Read position.

Implementations

impl Parser<'_>

The implementation of the directives.

pub fn directive(&mut self) -> PResult<()>

Match directives.

impl Parser<'_>

The low level grammar implementation for YAML.

These sub-parser returns Result<R, PError>, and calling Parser::backward if mismatched.

pub fn bound(&mut self) -> PResult<()>

Match invisible boundaries and keep the gaps. (must matched once)

pub fn complex_mapping(&mut self) -> PResult<()>

Match complex mapping indicator (?).

pub fn int(&mut self) -> PResult<String>

Match integer.

pub fn float(&mut self) -> PResult<String>

Match float.

pub fn sci_float(&mut self) -> PResult<String>

Match float with scientific notation.

pub fn string_quoted(&mut self, sym: u8, ignore: &[u8]) -> PResult<String>

Match quoted string.

pub fn string_plain(&mut self, level: usize, inner: bool) -> PResult<String>

Match plain string.

pub fn string_literal(&mut self, level: usize) -> PResult<String>

Match literal string.

pub fn string_folded(&mut self, level: usize) -> PResult<String>

Match folded string.

pub fn chomp(&mut self) -> impl Fn(String) -> String

Match chomping option.

pub fn string_wrapped(
    &mut self,
    level: usize,
    sep: u8,
    leading: bool
) -> PResult<String>

Match wrapped string.

pub fn escape(doc: &str) -> String

String escaping, return a new string.

pub fn identifier(&mut self) -> PResult<()>

Match valid YAML identifier.

pub fn tag(&mut self) -> PResult<String>

Match tags.

pub fn anchor(&mut self) -> PResult<String>

Match anchor definition.

pub fn anchor_use(&mut self) -> PResult<String>

Match anchor used.

pub fn ws(&mut self, opt: TakeOpt) -> PResult<()>

Match any invisible characters except newline.

pub fn nl(&mut self) -> PResult<()>

Match newline characters.

pub fn inv(&mut self, opt: TakeOpt) -> PResult<()>

Match any invisible characters.

pub fn ind_define(&mut self, level: usize) -> PResult<()>

Match and define new indent size.

pub fn unind(&mut self, level: usize) -> PResult<bool>

Match indent with previous level.

This sub-parser returns true if downgrading indent is used.

The downgrading can only use a level as unit, not a whitespace.

pub fn gap(&mut self, cmt: bool) -> PResult<usize>

Match any optional invisible characters between two lines.

Set cmt to true to ignore comments at the line end.

pub fn comment(&mut self) -> PResult<()>

Match comment.

impl<'a> Parser<'a>

The implementation of string pointer.

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

Create a parser with the string.

pub fn with_doc(self, doc: &'a [u8]) -> Self

Attach document on the parser.

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

Show the right hand side string after the current cursor.

pub fn text(&mut self) -> String

Get the text from the eaten cursor to the current position.

impl Parser<'_>

The low level grammar implementation.

These sub-parser returns Result<(), PError>, and calling Parser::backward if mismatched.

pub fn pos(self, pos: usize) -> Self

Set the starting point if character boundary is valid.

pub fn indicator(&self) -> u64

Get the indicator.

pub fn err<R>(&self, name: &'static str) -> PResult<R>

A short function to raise error.

pub fn consume(&mut self)

Consume and move the pointer.

pub fn forward(&mut self)

Consume the eaten part.

pub fn backward(&mut self)

Move the current position back.

pub fn back(&mut self, n: usize)

Move back current cursor.

pub fn sym(&mut self, s: u8) -> PResult<()>

Match symbol.

pub fn sym_set(&mut self, s: &[u8]) -> PResult<()>

Match symbol set.

pub fn sym_seq(&mut self, s: &[u8]) -> PResult<()>

Match symbol sequence.

pub fn take_while<F>(&mut self, f: F, opt: TakeOpt) -> PResult<()> where
    F: Fn(&u8) -> bool, 

Match until the condition failed.

The argument opt matches different terminate requirement.

pub fn count<F, R>(&mut self, f: F) -> PResult<usize> where
    F: FnOnce(&mut Self) -> PResult<R>, 

Count the position that parser goes, expect error.

pub fn context<F, R>(&mut self, f: F) -> R where
    F: FnOnce(&mut Self) -> R, 

A wrapper for saving checkpoint locally.

pub fn is_in(s: &[u8]) -> impl Fn(&u8) -> bool + '_

A SET detector.

pub fn not_in(s: &[u8]) -> impl Fn(&u8) -> bool + '_

A NOT detector.

pub fn ind(&mut self, level: usize) -> PResult<()>

Match indent.

Trait Implementations

impl Default for Parser<'_>

fn default() -> Self

Returns the “default value” for a type.