2 releases (1 stable)

Uses old Rust 2015

1.0.0 Jan 15, 2016
0.1.0 Jun 13, 2015

#2215 in Algorithms

Download history 9/week @ 2023-11-20 89/week @ 2023-11-27 61/week @ 2023-12-04 80/week @ 2023-12-11 48/week @ 2024-01-01 10/week @ 2024-01-08 226/week @ 2024-01-15 153/week @ 2024-01-22 167/week @ 2024-02-05 14/week @ 2024-02-12 2/week @ 2024-02-19 31/week @ 2024-02-26 42/week @ 2024-03-04

89 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