fsm
fsm
cargo install fsm
fsm

fsm

A simple Finite State Machine library in Rust, define a couple of enums, construct a machine, define some transition behaviours and voila!

by Oliver Maskery

0.2.2 (see all)License:MIT
cargo install fsm
Readme

A simple Finite State Machine library in Rust. Provide State and Event types (usually enums), then generate a machine with an initial state, give it some transition behaviours and you have your state machine!

Usage

Using the simple coin-operated turnstyle example from the FSM wikipedia entry:

Define your states and events:

// states and events must be C-like enums (copyable and easily converted to primitives)
#[derive(Copy, Clone)]
enum TurnStyleState {
    Locked,
    Unlocked,
}

#[derive(Copy, Clone)]
enum TurnStyleEvent {
    Push,
    InsertCoin,
}

// implement the EnumTag trait for states and events
impl EnumTag for TurnStyleState {
    fn tag_number(&self) -> usize {
        *self as usize
    }
    fn max_tag_number() -> usize {
        TurnStyleState::Unlocked as usize
    }
}

impl EnumTag for TurnStyleEvent {
    fn tag_number(&self) -> usize {
        *self as usize
    }
    fn max_tag_number() -> usize {
        TurnStyleEvent::InsertCoin as usize
    }
}

Create your machine and define your transitions:

// create the machine initially in the Locked state
let mut machine = Machine::new(TurnStyleState::Locked);
// create the transition from Locked -> Unlocked upon inserting a coin
machine.add_transition(
    TurnStyleState::Locked, TurnStyleEvent::InsertCoin,
    TurnStyleState::Unlocked, |_,_| println!("unlocked")
);
// create the transition from Unlocked -> Locked upon pushing the turnstyle
machine.add_transition(
    TurnStyleState::Unlocked, TurnStyleEvent::Push,
    TurnStyleState::Locked, |_,_| println!("locked")
);

Trigger events as needed and huzzah, off you go:

// initially we're in the Locked state
machine.on_event(TurnStyleEvent::InsertCoin);
// now we're Unlocked, ("unlocked" was just printed)
machine.on_event(TurnStyleEvent::Push);
// now we're Locked again, ("locked" was just printed)

This example is also the test case for the library, although here I've ommitted the test-related details.

To Do

  • Expose predicate interface and write unit tests for it

Alternatives

Macro based solutions

Other

GitHub Stars

11

LAST COMMIT

7yrs ago

MAINTAINERS

1

CONTRIBUTORS

1

OPEN ISSUES

1

OPEN PRs

1
VersionTagPublished
0.2.2
7yrs ago
0.2.1
7yrs ago
0.2.0
7yrs ago
0.1.1
7yrs ago
No alternatives found
No tutorials found
Add a tutorial