scsys-core 0.3.0

scsys is a collection of primitives and utilities for use throughout the ecosystem.
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

/*
    Appellation: state <module>
    Contrib: FL03 <jo3mccain@icloud.com>
*/
//! this module implements a generic [`State`] wrapper and provides several traits to support
//! state management and other stateful workloads.
//!
#[doc(inline)]
pub use self::{nstate::StateBase, traits::prelude::*, types::prelude::*, wrapper::State};
/// this module implements an alternative stateful representation that enables one to provide
/// a data type as well as specify the state _kind_
pub mod nstate;
pub mod wrapper;

mod impls {
    pub mod impl_wrapper;
    pub mod impl_wrapper_ops;
}

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 crate::state::{Nary, 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>>;
    }
}

pub(crate) mod prelude {
    #[doc(inline)]
    pub use super::nstate::*;
    #[doc(inline)]
    pub use super::wrapper::*;

    #[doc(inline)]
    pub use super::traits::prelude::*;
    #[doc(inline)]
    pub use super::types::prelude::*;
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_state() {
        let mut state = State::<usize>::zero();
        // verify the initial state is zero
        assert_eq!(state, 0);
        // set the state to a new value
        state.set(5);
        // verify the state is now 5
        assert_eq!(state, 5);
        // take the inner value leaving the default in its place
        assert_eq!(state.take(), 5);
        // verify the state is now back to its default value
        assert_eq!(state, 0);
        // map the state to a new value
        let mapped = state.map(|x| x + 1);
        assert_eq!(mapped, 1);
        // ensure the original state is unchanged
        assert_ne!(mapped, state);
    }

    #[test]
    fn test_state_views() {
        let mut state = State::<usize>::zero();

        let view = state.view();
        // verify that the "view" contains a reference to the original value
        assert_eq!(view.get(), &&0);
        assert_eq!(view.copied(), 0);
        // set the state to a new value
        state.set(5);
        // verify that the "view_mut" contains a mutable reference to the original value
        assert_eq!(state.view().value(), &mut 5_usize);
    }

    #[cfg(feature = "rand")]
    #[test]
    fn test_random_state() {
        // generate some random state `a`
        let a = State::<f32>::random();
        // generate another random state `b`
        let b = State::<f32>::random();
        // ensure the two states are not equal
        assert_ne!(a, b);
    }
}