scsys-state 0.3.2

generic state implementations and utilities for the scsys ecosystem
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

/*
    Appellation: scsys-core <library>
    Contrib: FL03 <jo3mccain@icloud.com>
*/
//! The [`state`](self) module provides various abstractions and implementations for working
//! with states within Rust.
//!
//! - [`State<Q>`] - A generic wrapper type that encapsulates a state of type `Q`, providing
//!   methods for state manipulation and retrieval.
//! - [`StateBase<Q, K>`] - A dynamic state representation capable of generically associating
//!   some state `Q` with a particular _kind_ `K`.
//!
#![allow(
    non_snake_case,
    clippy::module_inception,
    clippy::missing_safety_doc,
    clippy::needless_doctest_main,
    clippy::upper_case_acronyms
)]
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(all(feature = "alloc", feature = "nightly"), feature(allocator_api))]
#![doc(
    html_logo_url = "https://raw.githubusercontent.com/scattered-systems/.github/main/assets/logo.png",
    html_favicon_url = "https://raw.githubusercontent.com/scattered-systems/.github/main/assets/favicon.ico"
)]

#[cfg(feature = "alloc")]
extern crate alloc;

#[macro_use]
pub(crate) mod macros {
    #[macro_use]
    pub mod seal;
}

#[doc(inline)]
pub use self::{
    error::{Error, Result},
    nstate::StateBase,
    state::State,
    traits::prelude::*,
    types::prelude::*,
};

pub mod error;
pub(crate) mod nstate;
pub(crate) mod state;

mod impls {
    mod impl_state;
    mod impl_state_ops;

    #[allow(deprecated)]
    mod impl_deprecated;
}

pub mod traits {
    //! this module implements various traits supporting the [`State`](super::State) type
    #[doc(inline)]
    pub use self::prelude::*;

    pub mod kind;
    pub mod state;
    pub mod state_repr;
    pub mod stateful;

    pub(crate) mod prelude {
        #[doc(inline)]
        pub use super::kind::*;
        #[doc(inline)]
        pub use super::state::*;
        #[doc(inline)]
        pub use super::state_repr::*;
        #[doc(inline)]
        pub use super::stateful::*;
    }
}

pub mod types {
    //! additional types for the [`state`](crate::state) module
    #[doc(inline)]
    pub use self::prelude::*;

    pub mod kinds;
    pub mod nary;

    pub(crate) mod prelude {
        #[doc(inline)]
        pub use super::aliases::*;
        #[doc(inline)]
        pub use super::kinds::*;
        #[doc(inline)]
        pub use super::nary::*;
    }

    pub(crate) mod aliases {
        use super::Nary;
        use crate::nstate::StateBase;

        /// A type alias for a [`StateBase`] equipped with a [`Nary`] kind of state
        pub type NState<T, const N: usize = 4> = StateBase<T, Nary<N>>;
    }
}

#[doc(hidden)]
pub mod prelude {
    pub use crate::nstate::StateBase;
    pub use crate::state::State;
    pub use crate::traits::prelude::*;
    pub use crate::types::prelude::*;
}