Struct Automaton

pub struct Automaton { /* private fields */ }

A regex automaton is a compiled regular expression.

It represents the state machine corresponding to the Regex. This struct can either be turned into a

• DynamicMatcher to match on a regex that was compiled at runtime.
• An implementation of RegexMatcher generated using emit.

This function can be called at compile time (through the compile_regex! macro) and it emits the Rust code that can match the regular expression.

You can create an automaton using Regex::compile

Implementations

impl Automaton

pub fn matcher(&self) -> DynamicMatcher<'_>

Instantiate a (dynamic) matcher of this automaton.

A matcher holds, in addition to the state machine, also information about which state the machine is currently in. This current state can then be updated by taking transitions using step.

impl Automaton

pub fn emit( &self, name: &Ident, alphabet: &Type, errors: Vec<Error>, ) -> TokenStream

Convert this compiled regex into rust code that accepts this regular expression. name is the name of the type that is emitted, and alphabet is the type of symbols that the machine should accept.

impl Automaton

pub fn render(&self, w: &mut impl Write) -> Result<(), Error>

Visualize the automaton as a graph, by emitting a graphviz dot file.

Trait Implementations

impl Clone for Automaton

fn clone(&self) -> Automaton

Returns a duplicate of the value.

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

Performs copy-assignment from source.