Struct peepmatic_automata::Automaton

pub struct Automaton<TAlphabet, TState, TOutput> where
    TAlphabet: Clone + Eq + Hash + Ord,
    TState: Clone + Eq + Hash,
    TOutput: Output,  { /* fields omitted */ }

A finite-state transducer automata.

These are constructed via Builder.

An Automaton is immutable: new entries cannot be inserted and existing entries cannot be removed.

To query an Automaton, there are two APIs:

1. get -- a high-level method to get the associated output value of a full input sequence.

2. query -- a low-level method to incrementally query the automata. It does not require that you have the full input sequence on hand all at once, only the next character. It also allows you to process the output as it it built up, rather than only at giving you the final, complete output value.

Implementations

impl<TAlphabet, TState, TOutput> Automaton<TAlphabet, TState, TOutput> where
    TAlphabet: Clone + Eq + Hash + Ord,
    TState: Clone + Eq + Hash,
    TOutput: Output, 

pub fn write_dot_file(
    &self,
    formatter: &impl DotFmt<TAlphabet, TState, TOutput>,
    path: impl AsRef<Path>
) -> Result<()>

Write this Automaton out as a GraphViz Dot file at the given path.

The formatter parameter controls how TAlphabet, TState, and TOutput are rendered. See the DotFmt trait for details.

This method only exists when the "dot" cargo feature is enabled.

pub fn write_dot(
    &self,
    formatter: &impl DotFmt<TAlphabet, TState, TOutput>,
    w: &mut impl Write
) -> Result<()>

Write this Automaton out to the given write-able as a GraphViz Dot file.

The formatter parameter controls how TAlphabet, TState, and TOutput are rendered. See the DotFmt trait for details.

This method only exists when the "dot" cargo feature is enabled.

impl<TAlphabet, TState, TOutput> Automaton<TAlphabet, TState, TOutput> where
    TAlphabet: Clone + Eq + Hash + Ord,
    TState: Clone + Eq + Hash,
    TOutput: Output, 

pub fn get<'a>(
    &self,
    input: impl IntoIterator<Item = &'a TAlphabet>
) -> Option<TOutput> where
    TAlphabet: 'a, 

Get the output value associated with the given input sequence.

Returns None if the input sequence is not a member of this Automaton's keys. Otherwise, returns Some(output).

pub fn query(&self) -> Query<TAlphabet, TState, TOutput>

Create a low-level query.

This allows you to incrementally query this Automaton, without providing the full input sequence ahead of time, and also incrementally build up the output.

See Query for details.

Trait Implementations

impl<TAlphabet: Clone, TState: Clone, TOutput: Clone> Clone for Automaton<TAlphabet, TState, TOutput> where
    TAlphabet: Clone + Eq + Hash + Ord,
    TState: Clone + Eq + Hash,
    TOutput: Output, 

fn clone(&self) -> Automaton<TAlphabet, TState, TOutput>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TAlphabet: Debug, TState: Debug, TOutput: Debug> Debug for Automaton<TAlphabet, TState, TOutput> where
    TAlphabet: Clone + Eq + Hash + Ord,
    TState: Clone + Eq + Hash,
    TOutput: Output, 

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

Formats the value using the given formatter.

impl<'de, TAlphabet, TState, TOutput> Deserialize<'de> for Automaton<TAlphabet, TState, TOutput> where
    TAlphabet: 'de + Deserialize<'de> + Clone + Eq + Hash + Ord,
    TState: 'de + Deserialize<'de> + Clone + Eq + Hash,
    TOutput: 'de + Deserialize<'de> + Output, 

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<TAlphabet, TState, TOutput> Serialize for Automaton<TAlphabet, TState, TOutput> where
    TAlphabet: Serialize + Clone + Eq + Hash + Ord,
    TState: Serialize + Clone + Eq + Hash,
    TOutput: Serialize + Output, 

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.