statig 0.4.1

Hierarchical state machines for designing event-driven systems
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

use core::future::{self, Future};

use crate::StateOrSuperstate;

/// Trait for transforming a type into a state machine.
pub trait IntoStateMachine
where
    Self: Sized,
{
    /// Event that is processed by the state machine.
    type Event<'evt>;

    /// External context that can be passed in.
    type Context<'ctx>;

    /// Enumeration of the various states.
    type State;

    /// Enumeration of the various superstates.
    type Superstate<'sub>
    where
        Self::State: 'sub;

    /// Constructor for the initial state of the state machine.
    fn initial() -> Self::State;

    /// Method that is called *before* an event is dispatched to a state or
    /// superstate handler.
    fn before_dispatch(
        &mut self,
        _state_or_superstate: StateOrSuperstate<'_, Self::State, Self::Superstate<'_>>,
        _event: &Self::Event<'_>,
        _context: &mut Self::Context<'_>,
    ) -> impl Future<Output = ()> {
        future::ready(())
    }

    /// Method that is called *after* an event is dispatched to a state or
    /// superstate handler.
    fn after_dispatch(
        &mut self,
        _state_or_superstate: StateOrSuperstate<'_, Self::State, Self::Superstate<'_>>,
        _event: &Self::Event<'_>,
        _context: &mut Self::Context<'_>,
    ) -> impl Future<Output = ()> {
        future::ready(())
    }

    /// Method that is called *before* every transition.
    fn before_transition(
        &mut self,
        _source: &Self::State,
        _target: &Self::State,
        _context: &mut Self::Context<'_>,
    ) -> impl Future<Output = ()> {
        future::ready(())
    }

    /// Method that is called *after* every transition.
    fn after_transition(
        &mut self,
        _source: &Self::State,
        _target: &Self::State,
        _context: &mut Self::Context<'_>,
    ) -> impl Future<Output = ()> {
        future::ready(())
    }
}

pub trait DispatchHook<T, P>
where
    T: IntoStateMachine,
{
    fn call_dispatch_hook(
        self,
        shared_storage: &mut T,
        state_or_superstate: StateOrSuperstate<'_, T::State, T::Superstate<'_>>,
        event: &T::Event<'_>,
        context: &mut T::Context<'_>,
    ) -> impl Future<Output = ()>;
}

impl<T, F> DispatchHook<T, ((),)> for F
where
    T: IntoStateMachine,
    F: AsyncFnOnce(&mut T, StateOrSuperstate<'_, T::State, T::Superstate<'_>>, &T::Event<'_>),
{
    fn call_dispatch_hook(
        self,
        shared_storage: &mut T,
        state_or_superstate: StateOrSuperstate<'_, T::State, T::Superstate<'_>>,
        event: &T::Event<'_>,
        _context: &mut T::Context<'_>,
    ) -> impl Future<Output = ()> {
        (self)(shared_storage, state_or_superstate, event)
    }
}

impl<T, F> DispatchHook<T, ((), ())> for F
where
    T: IntoStateMachine,
    F: AsyncFnOnce(
        &mut T,
        StateOrSuperstate<'_, T::State, T::Superstate<'_>>,
        &T::Event<'_>,
        &mut T::Context<'_>,
    ),
{
    fn call_dispatch_hook(
        self,
        shared_storage: &mut T,
        state_or_superstate: StateOrSuperstate<'_, T::State, T::Superstate<'_>>,
        event: &T::Event<'_>,
        context: &mut T::Context<'_>,
    ) -> impl Future<Output = ()> {
        (self)(shared_storage, state_or_superstate, event, context)
    }
}

pub trait TransitionHook<T, P>
where
    T: IntoStateMachine,
{
    fn call_transition_hook(
        self,
        shared_storage: &mut T,
        source: &T::State,
        target: &T::State,
        context: &mut T::Context<'_>,
    ) -> impl Future<Output = ()>;
}

impl<T, F> TransitionHook<T, ((),)> for F
where
    T: IntoStateMachine,
    F: AsyncFnOnce(&mut T, &T::State, &T::State),
{
    fn call_transition_hook(
        self,
        shared_storage: &mut T,
        source: &T::State,
        target: &T::State,
        _context: &mut T::Context<'_>,
    ) -> impl Future<Output = ()> {
        (self)(shared_storage, source, target)
    }
}

impl<T, F> TransitionHook<T, ((), ())> for F
where
    T: IntoStateMachine,
    F: AsyncFnOnce(&mut T, &T::State, &T::State, &mut T::Context<'_>),
{
    fn call_transition_hook(
        self,
        shared_storage: &mut T,
        source: &T::State,
        target: &T::State,
        context: &mut T::Context<'_>,
    ) -> impl Future<Output = ()> {
        (self)(shared_storage, source, target, context)
    }
}