Struct ilex::testing::Matcher

pub struct Matcher { /* private fields */ }

A matcher for a token stream.

For usage examples, see the ilex/tests directory.

Implementations

impl Matcher

pub fn new() -> Self

Creates a new matcher.

pub fn then1<R: Match<(A1,)>, A1>(self, lexeme: Lexeme<R>, a1: A1) -> Self

Adds a new expected token for this matcher, from a lexeme and an argument.

What is allowed for arg for a particular rule type is specified by the Match trait. You can even define your own!

pub fn then2<R: Match<(A1, A2)>, A1, A2>( self, lexeme: Lexeme<R>, a1: A1, a2: A2 ) -> Self

Adds a new expected token for this matcher, from a lexeme and two arguments.

What is allowed for arg for a particular rule type is specified by the Match trait. You can even define your own!

pub fn prefix1<R: Match<(A1,)>, A1>( self, lexeme: Lexeme<R>, prefix: impl Into<Text>, a1: A1 ) -> Self

Like Matcher::then1(), but adds a prefix matcher too.

pub fn prefix2<R: Match<(A1, A2)>, A1, A2>( self, lexeme: Lexeme<R>, prefix: impl Into<Text>, a1: A1, a2: A2 ) -> Self

Like Matcher::then2(), but adds a prefix matcher too.

pub fn suffix1<R: Match<(A1,)>, A1>( self, lexeme: Lexeme<R>, a1: A1, suffix: impl Into<Text> ) -> Self

Like Matcher::then1(), but adds a suffix matcher too.

pub fn suffix2<R: Match<(A1, A2)>, A1, A2>( self, lexeme: Lexeme<R>, a1: A1, a2: A2, suffix: impl Into<Text> ) -> Self

Like Matcher::then2(), but adds a suffix matcher too.

pub fn affix1<R: Match<(A1,)>, A1>( self, lexeme: Lexeme<R>, prefix: impl Into<Text>, a1: A1, suffix: impl Into<Text> ) -> Self

Like Matcher::then1(), but adds a prefix matcher and a suffix matcher too.

pub fn affix2<R: Match<(A1, A2)>, A1, A2>( self, lexeme: Lexeme<R>, prefix: impl Into<Text>, a1: A1, a2: A2, suffix: impl Into<Text> ) -> Self

Like Matcher::then2(), but adds a prefix matcher and a suffix matcher too.

pub fn eof(self) -> Self

Adds an EOF matcher.

Every token stream ends with an EOF token, so you always need to include one.

pub fn assert_matches<'lex>( &self, ctx: &Context, that: impl IntoIterator<Item = Any<'lex>> )

Matches cursor against this matcher, and panics if it doesn’t.

pub fn span(self, text: impl Into<Text>) -> Self

Sets an expectation for the overall span of the most recently added token matcher.

Panics

Panics if none of the matcher-adding methods has been called yet.

pub fn comments<I>(self, iter: I) -> Self

where I: IntoIterator, I::Item: Into<Text>,

Adds some expected comments to the most recently added token matcher.

Panics

Panics if none of the matcher-adding methods has been called yet.

pub fn matches<'lex>( &self, ctx: &Context, that: impl IntoIterator<Item = Any<'lex>> ) -> Result<(), impl Debug>

Matches cursor against this matcher.

If matching fails, returns an error describing why.

Trait Implementations

impl Default for Matcher

fn default() -> Self

Returns the “default value” for a type.