qubit-state-machine 0.4.0

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

/*******************************************************************************
 *
 *    Copyright (c) 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 *
 ******************************************************************************/
//! # Qubit State Machine
//!
//! A small, thread-safe finite state machine for Rust.
//!
//! This crate provides a generic state machine (`StateMachine`) and a compact
//! fast state machine (`FastStateMachine`) built on compact `usize` codes and
//! `FastCas`.
//!
//! # Examples
//!
//! ```
//! use qubit_state_machine::{AtomicRef, StateMachine};
//!
//! #[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
//! enum State {
//!     New,
//!     Running,
//!     Done,
//! }
//!
//! #[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
//! enum Event {
//!     Start,
//!     Finish,
//! }
//!
//! let machine = StateMachine::builder()
//!     .add_states(&[State::New, State::Running, State::Done])
//!     .initial_state(State::New)
//!     .final_state(State::Done)
//!     .transition(State::New, Event::Start, State::Running)
//!     .transition(State::Running, Event::Finish, State::Done)
//!     .build()
//!     .expect("job state machine should be valid");
//!
//! let state = AtomicRef::from_value(State::New);
//! assert_eq!(machine.trigger(&state, Event::Start).unwrap(), State::Running);
//! assert_eq!(*state.load(), State::Running);
//! ```

#![deny(missing_docs)]

mod fast;
mod standard;

pub use qubit_atomic::AtomicRef;
pub use qubit_cas::FastCasPolicy;

#[doc(hidden)]
pub use fast::fast_state_machine_error_from_fast_cas_error;
pub use fast::{
    FAST_STATE_MACHINE_DEFAULT_CAS_POLICY,
    FastStateMachine,
    FastStateMachineBuildError,
    FastStateMachineBuilder,
    FastStateMachineError,
    FastStateMachineResult,
};

pub use standard::{
    StateMachine,
    StateMachineBuildError,
    StateMachineBuilder,
    StateMachineError,
    StateMachineResult,
    Transition,
};