2 releases (1 stable)

Uses old Rust 2015

1.0.0 Jan 15, 2016
0.1.0 Jun 13, 2015

#2302 in Algorithms

Download history 3/week @ 2024-03-13 2/week @ 2024-03-20 49/week @ 2024-03-27 158/week @ 2024-04-03 73/week @ 2024-04-10 55/week @ 2024-04-17 80/week @ 2024-04-24 56/week @ 2024-05-01 30/week @ 2024-05-08 76/week @ 2024-05-15 99/week @ 2024-05-22 92/week @ 2024-05-29 84/week @ 2024-06-05 101/week @ 2024-06-12 84/week @ 2024-06-19 183/week @ 2024-06-26

484 downloads per month

MIT license

5KB
72 lines

MicroState

Build Status

Minimal Finite State Machine.

Description

A finite state machine is in only one state at a time. From there it can change from one state to another when initiated by an triggering event: the transition. A finite state machine is fully defined by a list of states and the transitions triggering a change from one state to another.

And that's all this crate does: it let's you define the states and transitions. The rest is up to you.

Inspired by @soveran's micromachine in Ruby.

Documentation

Online documentation

Usage

First you need to import the macro:

#[macro_use] extern crate microstate;

You can then create a new state machine and call transitions.

microstate!{
    MicroMachine { New };
    states { New, Confirmed, Ignored };

    confirm {
        New => Confirmed
    }

    ignore {
        New => Ignored
    }

    reset {
        Confirmed => New
        Ignored   => New
    }
}

let mut machine = MicroMachine::new();

machine.confirm(); // => Some(Confirmed)
machine.state();   // => Confirmed

machine.ignore();  // => None
machine.state();   // => Confirmed

machine.reset();   // => Some(New)
machine.state();   // => New

machine.ignore();  // => Some(Ignored)
machine.state();   // => Ignored

Contribute

If you find bugs or want to help otherwise, please open an issue.

License

MIT. See LICENSE.

No runtime deps