1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

//! A zero dependency crate to implement state machine.
//!
//! ## Current Version
//! 0.1.0
//!
//! ## Usage
//! Let's have a look at the following simple example. This example shows the state machine
//! can transit its number (it called `current_state` in this machine)
//! from given string ("next") and then, it produces outputs.
//!
//! ```rust
//! use statemachine_rs::machine::{builder::StateMachineBuilder, StateMachine};
//!
//! let sm = StateMachineBuilder::start()
//!     .initial_state(1)
//!     .transition(|state, input| match (state, input) {
//!         (1, "next") => 2,
//!         (2, "next") => 3,
//!         _ => unreachable!(),
//!     })
//!     .build()
//!     .unwrap();
//!
//! assert_eq!(1, sm.current_state());
//! sm.consume("next");
//! assert_eq!(2, sm.current_state());
//! ```
//!
//! You can assemble your state machine by using `statemachine_rs::machine::builder::StateMachineBUilder`.
//! `StateMachineBuilder::initial_state()` initializes the initial state of its machine.
//! `StateMachineBuilder::transition()` defines the transition model.
//!
//! Of cource we can use `enum`s for representing states and inputs. Let's have a look at another example.
//!
//! The following example describes if you press the button, the state turns to be `On`. Otherwise, `Off`.
//!
//! ```rust
//! use statemachine_rs::machine::{builder::StateMachineBuilder, StateMachine};
//!
//! #[derive(Clone, Debug, PartialEq)]
//! enum ButtonState {
//!     On,
//!     Off,
//! }
//!
//! enum Input {
//!     Press,
//! }
//!
//! let sm = StateMachineBuilder::start()
//!     .initial_state(ButtonState::Off)
//!     .transition(|state, input| match (state, input) {
//!         (ButtonState::On, Input::Press) => ButtonState::Off,
//!         (ButtonState::Off, Input::Press) => ButtonState::On,
//!     })
//!     .build()
//!     .unwrap();
//!
//! assert_eq!(ButtonState::Off, sm.current_state());
//! sm.consume(Input::Press);
//! assert_eq!(ButtonState::On, sm.current_state());
//! ```
//! ## License
//! MIT
//!
//! ## Contribution
//! All contributions are welcome.
//!
//! If you have an idea to improve this crate, create new issue or submit new pull request.

pub mod machine;