fluent_fsm/
lib.rs

1// MIT License
2//
3// Copyright (c) 2024 Wes Kelly
4//
5// Permission is hereby granted, free of charge, to any person obtaining a copy
6// of this software and associated documentation files (the "Software"), to deal
7// in the Software without restriction, including without limitation the rights
8// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9// copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in all
13// copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21// SOFTWARE.
22
23pub(crate) mod machine;
24
25pub use machine::active;
26pub use machine::builder;
27pub use machine::passive;
28
29#[cfg(test)]
30pub mod tests {
31    use crate::builder::*;
32    use DoorEvents::*;
33    use DoorStates::*;
34
35    #[derive(Eq, PartialEq, Copy, Clone, Hash)]
36    enum DoorStates {
37        Closed,
38        Opened,
39    }
40
41    #[derive(Eq, PartialEq, Copy, Clone, Hash)]
42    enum DoorEvents {
43        OpenDoor,
44        CloseDoor,
45    }
46
47    struct DoorModel {
48        door_open: bool,
49    }
50
51    #[test]
52    pub fn test_readme_example() {
53        // Initial state: closed
54        let builder = StateMachineBuilder::create(Closed, DoorModel { door_open: false })
55            .on_enter_mut(|model: &mut DoorModel| {
56                model.door_open = false;
57            })
58            .on(OpenDoor, || {
59                println!("opening door");
60            })
61            .goto(Opened)
62            .in_state(Opened)
63            .on_enter_mut(|model: &mut DoorModel| {
64                model.door_open = true;
65            })
66            .on(CloseDoor, || {
67                println!("closing door");
68            })
69            .goto(Closed);
70
71        let mut machine = builder.build_passive();
72        machine.start();
73
74        assert_eq!(machine.model().door_open, false);
75
76        machine.fire(OpenDoor);
77
78        assert_eq!(machine.model().door_open, true);
79    }
80}
fluent_fsm/lib.rs

fluent_fsm/
lib.rs
