rustate 0.2.0

A Rust implementation of statecharts with model-based testing support
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

use crate::{Context, Event};
use serde::{Deserialize, Serialize};
use std::fmt;

/// Type of action execution
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum ActionType {
    /// Action executed when entering a state
    Entry,
    /// Action executed when exiting a state
    Exit,
    /// Action executed during a transition
    Transition,
}

/// An action that can be executed during state transitions
#[derive(Serialize, Deserialize)]
pub struct Action {
    /// The name of this action
    pub name: String,
    /// The type of action execution
    pub action_type: ActionType,
    /// Function pointer to execute the action
    #[serde(skip)]
    pub(crate) executor: Option<Box<dyn Fn(&mut Context, &Event) + Send + Sync>>,
}

impl Clone for Action {
    fn clone(&self) -> Self {
        // Note: We can't actually clone the executor function,
        // so this creates an action with the same name and type but no executor
        Self {
            name: self.name.clone(),
            action_type: self.action_type,
            executor: None,
        }
    }
}

impl fmt::Debug for Action {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Action")
            .field("name", &self.name)
            .field("action_type", &self.action_type)
            .field(
                "executor",
                &format_args!(
                    "{}",
                    if self.executor.is_some() {
                        "Some(Fn)"
                    } else {
                        "None"
                    }
                ),
            )
            .finish()
    }
}

impl Action {
    /// Create a new action with a name and executor function
    pub fn new<F>(name: impl Into<String>, action_type: ActionType, executor: F) -> Self
    where
        F: Fn(&mut Context, &Event) + Send + Sync + 'static,
    {
        Self {
            name: name.into(),
            action_type,
            executor: Some(Box::new(executor)),
        }
    }

    /// Create a new entry action
    pub fn entry<F>(name: impl Into<String>, executor: F) -> Self
    where
        F: Fn(&mut Context, &Event) + Send + Sync + 'static,
    {
        Self::new(name, ActionType::Entry, executor)
    }

    /// Create a new exit action
    pub fn exit<F>(name: impl Into<String>, executor: F) -> Self
    where
        F: Fn(&mut Context, &Event) + Send + Sync + 'static,
    {
        Self::new(name, ActionType::Exit, executor)
    }

    /// Create a new transition action
    pub fn transition<F>(name: impl Into<String>, executor: F) -> Self
    where
        F: Fn(&mut Context, &Event) + Send + Sync + 'static,
    {
        Self::new(name, ActionType::Transition, executor)
    }

    /// Create a new action with a name only (for serialization)
    pub fn named(name: impl Into<String>, action_type: ActionType) -> Self {
        Self {
            name: name.into(),
            action_type,
            executor: None,
        }
    }

    /// Execute the action with a context and event
    pub fn execute(&self, context: &mut Context, event: &Event) {
        if let Some(executor) = &self.executor {
            executor(context, event);
        } else {
            // Default behavior for serialized actions with no executor
            // In a real implementation, you might look up an executor from a registry
        }
    }
}

impl fmt::Display for Action {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Action({}, {:?})", self.name, self.action_type)
    }
}

/// Trait for types that can be converted into an action
pub trait IntoAction {
    /// Convert into an action
    fn into_action(self, action_type: ActionType) -> Action;
}

impl IntoAction for Action {
    fn into_action(self, _action_type: ActionType) -> Action {
        self
    }
}

impl<F> IntoAction for (&str, F)
where
    F: Fn(&mut Context, &Event) + Send + Sync + 'static,
{
    fn into_action(self, action_type: ActionType) -> Action {
        Action::new(self.0, action_type, self.1)
    }
}