Struct pidgin::Grammar

pub struct Grammar { /* fields omitted */ }

A compiled collection of rules ready for the building of a pidgin::Matcher or for use in the definition of a new rule.

You do not build new Grammars directly. Rather, the compile or grammar method of a Pidgin produces them for you.

Methods

impl Grammar

pub fn matcher(&self) -> Result<Matcher, Error>

Compiles a Matcher based on the Grammar's rules.

Errors

If the Grammar contains a "foreign rule" with a named capture, an error may be returned.

pub fn to_string(&self) -> String

Returns a quasi-regex representation of the grammar. This is intended mostly for debugging. Rules will be identifiable by named groups, but group names may repeat, in which case the stringification cannot be compiled into a regular expression.

Trait Implementations

impl Clone for Grammar

fn clone(&self) -> Grammar

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Grammar

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

Formats the value using the given formatter.

impl PartialOrd for Grammar

fn partial_cmp(&self, other: &Grammar) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for Grammar

fn cmp(&self, other: &Grammar) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl PartialEq for Grammar

fn eq(&self, other: &Grammar) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for Grammar