smlang 0.8.0

A no-std state machine language DSL
Documentation 
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

//! Guard and action syntax example
//!
//! An example of using guards and actions with state and event data.

#![deny(missing_docs)]

use smlang::statemachine;

/// Custom guard errors
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum GuardError {
    /// This is a custom guard error variant
    Custom,
}

/// Event data
#[derive(PartialEq)]
pub struct MyEventData(pub u32);

/// State data
#[derive(PartialEq)]
pub struct MyStateData(pub u32);

statemachine! {
    transitions: {
        *State1 + Event1(MyEventData) [guard1] / action1 = State2,
        State2(MyStateData) + Event2  [guard2] / action2 = State3,
        // ...
    },
    custom_error: true,
}

/// Context
pub struct Context;

impl StateMachineContext for Context {
    type Error = GuardError; // Guard1 has access to the data from Event1
    fn guard1(&self, _event_data: &MyEventData) -> Result<bool, GuardError> {
        Err(GuardError::Custom)
    }

    // Action1 has access to the data from Event1, and need to return the state data for State2
    fn action1(&mut self, _event_data: MyEventData) -> Result<MyStateData, Self::Error> {
        todo!()
    }

    // Guard2 has access to the data from State2
    fn guard2(&self, _state_data: &MyStateData) -> Result<bool, GuardError> {
        todo!()
    }

    // Action2 has access to the data from State2
    fn action2(&mut self, _state_data: &MyStateData) -> Result<(), Self::Error> {
        todo!()
    }
}

fn main() {
    let mut sm = StateMachine::new(Context {});

    let r = sm.process_event(Events::Event1(MyEventData(1)));

    assert!(matches!(r, Err(Error::GuardFailed(GuardError::Custom))));
}