Struct peepmatic_automata::Builder

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

A builder for a transducer automata.

Type Parameters

Generic over the following parameters:

• TAlphabet -- the alphabet of the input strings. If your input keys are Strings, this would be char. If your input keys are arbitrary byte strings, this would be u8.

• TState -- extra, custom data associated with each state. This isn't used by the automata itself, but you can use it to annotate states with extra information for your own purposes.

• TOutput -- the output type. See the Output trait for the requirements that any output type must fulfill.

Insertions

Insertions must happen in lexicographic order. Failure to do this, or inserting duplicates, will trigger panics.

Example

use peepmatic_automata::Builder;

let mut builder = Builder::<u8, (), u64>::new();

// Insert "mon" -> 1
let mut insertion = builder.insert();
insertion
    .next(b'm', 1)
    .next(b'o', 0)
    .next(b'n', 0);
insertion.finish();

// Insert "sat" -> 6
let mut insertion = builder.insert();
insertion
    .next(b's', 6)
    .next(b'a', 0)
    .next(b't', 0);
insertion.finish();

// Insert "sun" -> 0
let mut insertion = builder.insert();
insertion
    .next(b's', 0)
    .next(b'u', 0)
    .next(b'n', 0);
insertion.finish();

let automata = builder.finish();

assert_eq!(automata.get(b"sun"), Some(0));
assert_eq!(automata.get(b"mon"), Some(1));
assert_eq!(automata.get(b"sat"), Some(6));

assert!(automata.get(b"tues").is_none());

Implementations

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

pub fn new() -> Self

Make a new builder to start constructing a new transducer automata.

pub fn insert(&mut self) -> InsertionBuilder<'_, TAlphabet, TState, TOutput>

Start building a new key/value insertion.

Insertions are built up incrementally, and a full entry is created from a series of TAlphabet and TOutput pairs passed to InsertionBuilder::next.

Panics

Panics if finish was not called on the last InsertionBuilder returned from this method.

pub fn finish(&mut self) -> Automaton<TAlphabet, TState, TOutput>

Finish building this transducer and return the constructed Automaton.

Panics

Panics if this builder is empty, and has never had anything inserted into it.

Panics if the last insertion's InsertionBuilder did not call its finish method.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TAlphabet: Debug, TState: Debug, TOutput: Debug> Debug for Builder<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.