qubit-state-machine 0.3.5

A small, thread-safe finite state machine for Rust
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

/*******************************************************************************
 *
 *    Copyright (c) 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
//! Validation errors returned when building a state machine.

use std::fmt::Debug;

use thiserror::Error;

/// Error returned when state machine rules are internally inconsistent.
///
/// `S` is the state type and `E` is the event type.
#[derive(Debug, Clone, Copy, Eq, PartialEq, Error)]
pub enum StateMachineBuildError<S, E>
where
    S: Debug,
    E: Debug,
{
    /// An initial state was configured but not registered as a state.
    #[error("initial state is not registered: {state:?}")]
    InitialStateNotRegistered {
        /// The unregistered initial state.
        state: S,
    },
    /// A final state was configured but not registered as a state.
    #[error("final state is not registered: {state:?}")]
    FinalStateNotRegistered {
        /// The unregistered final state.
        state: S,
    },
    /// A transition source was not registered as a state.
    #[error("transition source is not registered: {source_state:?} --{event:?}--> {target:?}")]
    TransitionSourceNotRegistered {
        /// Source state of the invalid transition.
        source_state: S,
        /// Event of the invalid transition.
        event: E,
        /// Target state of the invalid transition.
        target: S,
    },
    /// A transition target was not registered as a state.
    #[error("transition target is not registered: {source_state:?} --{event:?}--> {target:?}")]
    TransitionTargetNotRegistered {
        /// Source state of the invalid transition.
        source_state: S,
        /// Event of the invalid transition.
        event: E,
        /// Target state of the invalid transition.
        target: S,
    },
    /// Two transitions use the same `(source, event)` with different targets.
    #[error(
        "duplicate transition target: {source_state:?} --{event:?}--> \
         {existing_target:?} conflicts with {new_target:?}"
    )]
    DuplicateTransition {
        /// Source state shared by both transitions.
        source_state: S,
        /// Event shared by both transitions.
        event: E,
        /// Target registered first.
        existing_target: S,
        /// Conflicting target registered later.
        new_target: S,
    },
}