qubit-state-machine 0.3.2

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
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

/*******************************************************************************
 *
 *    Copyright (c) 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/

//! Validation errors returned while building a fast state machine.

use thiserror::Error;

/// Error returned when fast state machine configuration is invalid.
#[derive(Debug, Clone, Copy, Eq, PartialEq, Error)]
pub enum FastStateMachineBuildError {
    /// State count was not configured.
    #[error("state count is not configured")]
    StateCountNotConfigured,

    /// Event count was not configured.
    #[error("event count is not configured")]
    EventCountNotConfigured,

    /// State count must be greater than zero.
    #[error("state count must be positive: {count}")]
    InvalidStateCount {
        /// Requested state count.
        count: usize,
    },

    /// Event count must be greater than zero.
    #[error("event count must be positive: {count}")]
    InvalidEventCount {
        /// Requested event count.
        count: usize,
    },

    /// Transition transition-table size overflowed `usize`.
    #[error("transition table overflowed usize: {state_count} * {event_count}")]
    TransitionTableOverflow {
        /// The number of states.
        state_count: usize,

        /// The number of events.
        event_count: usize,
    },

    /// An initial state code exceeds the configured state count.
    #[error("initial state is out of range: {state} >= {state_count}")]
    InitialStateOutOfRange {
        /// The invalid initial state.
        state: usize,
        /// Configured state count.
        state_count: usize,
    },

    /// A final state code exceeds the configured state count.
    #[error("final state is out of range: {state} >= {state_count}")]
    FinalStateOutOfRange {
        /// The invalid final state.
        state: usize,
        /// Configured state count.
        state_count: usize,
    },

    /// A transition source code exceeds the configured state count.
    #[error("transition source is out of range: {source_state} >= {state_count}")]
    TransitionSourceOutOfRange {
        /// The invalid source state.
        source_state: usize,
        /// Configured state count.
        state_count: usize,
    },

    /// A transition event code exceeds the configured event count.
    #[error("transition event is out of range: {event} >= {event_count}")]
    TransitionEventOutOfRange {
        /// The invalid event code.
        event: usize,
        /// Configured event count.
        event_count: usize,
    },

    /// A transition target code exceeds the configured state count.
    #[error("transition target is out of range: {target} >= {state_count}")]
    TransitionTargetOutOfRange {
        /// The invalid target state.
        target: usize,
        /// Configured state count.
        state_count: usize,
    },

    /// Same `(source, event)` maps to two different targets.
    #[error(
        "duplicate transition: {source_state} --{event}--> {existing_target} conflicts with {new_target}"
    )]
    DuplicateTransition {
        /// Source state.
        source_state: usize,
        /// Event code.
        event: usize,
        /// Existing target.
        existing_target: usize,
        /// Conflicting target.
        new_target: usize,
    },
}