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

//! The public Finite State Machine traits. The derive macros will implement these for your particular
//! state machines.

mod events;
mod fsm_impl;
mod fsm_factory;
mod queue;
mod states;
mod transitions;
mod tests_fsm;

pub use self::events::*;
pub use self::fsm_factory::*;
pub use self::fsm_impl::*;
pub use self::queue::*;
pub use self::states::*;
pub use self::transitions::*;

use crate::lib::*;

pub type FsmResult<T> = Result<T, FsmError>;

/// The lib-level error type.
#[derive(Debug, PartialEq)]
pub enum FsmError {
    NoTransition,
    QueueOverCapacity
}


/// Finite State Machine backend. Handles the dispatching, the types are
/// defined by the code generator.
pub trait FsmBackend where Self: Sized {
    /// The machine's context that is shared between its constructors and actions.
    type Context;
    /// The type that holds the states of the machine.
    type States: FsmStates;
    /// A tagged union type with all the supported events.
    type Events;

    /*
    fn dispatch_event<Q>(backend: &mut FsmBackendImpl<Self>, event: &FsmEvent<Self::Events>, queue: &mut Q) -> FsmResult<()>
        where Q: FsmEventQueue<Self>;
        */

    fn dispatch_event<Q>(frontend: &mut FsmFrontend<Self, Q>, event: &FsmEvent<Self::Events>) -> FsmResult<()>
        where Q: queue::FsmEventQueue<Self>;
}