eryon-core 0.0.3

The core modules of the eryon framework, providing essential functionality for computational entities.
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

/*
    Appellation: eryon-core <library>
    Contrib: @FL03
*/
//! # eryon-core
//!
//! This crate implements the core musical primitives and utilities for the [`eryon`](https://docs.rs/eryon)
//! framework.
#![allow(
    clippy::missing_saftey_doc,
    clippy::module_inception,
    clippy::needless_doctest_main,
    clippy::should_implement_trait,
    clippy::upper_case_acronyms
)]
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(all(feature = "nightly"), feature(allocator_api))]

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

#[cfg(feature = "rand")]
pub use rand;
#[cfg(feature = "rand")]
pub use rand_distr;
/// re-import the [`rstmt`](https://docs.rs/rstmt) crate for convenience
pub use rstmt;

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

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

/// this module implements the core error type for the crate
pub mod error;
pub mod state;

pub mod ops {
    //! this module implements additional operational traits used throughout the crate
    #[doc(inline)]
    pub use self::prelude::*;

    pub mod difference;
    pub mod execute;
    pub mod increment;
    pub mod transform;

    pub(crate) mod prelude {
        #[doc(inline)]
        pub use super::difference::*;
        #[doc(inline)]
        pub use super::execute::*;
        #[doc(inline)]
        pub use super::increment::*;
        #[doc(inline)]
        pub use super::transform::*;
    }
}

pub mod traits {
    //! this module define various traits common to the crate
    #[doc(inline)]
    pub use self::prelude::*;

    pub(crate) mod scalar;
    #[cfg(feature = "rand")]
    pub(crate) mod shuffle;
    pub(crate) mod symbolic;

    #[allow(unused_imports)]
    pub(crate) mod prelude {
        #[doc(inline)]
        pub use super::scalar::*;
        #[doc(inline)]
        #[cfg(feature = "rand")]
        pub use super::shuffle::*;
        #[doc(inline)]
        pub use super::symbolic::*;
    }
}

pub mod types {
    //! this module defines the core types for the eryon framework
    #[doc(inline)]
    pub use self::prelude::*;

    mod direction;
    mod head;
    mod tail;

    mod power;
    mod rules;

    pub(crate) mod prelude {
        #[doc(inline)]
        pub use super::direction::*;
        #[doc(inline)]
        pub use super::head::*;
        #[doc(inline)]
        pub use super::power::*;
        #[doc(inline)]
        pub use super::rules::*;
        #[doc(inline)]
        pub use super::tail::*;
    }
}

pub mod utils {
    #[doc(inline)]
    pub use self::prelude::*;

    pub mod area;

    pub(crate) mod prelude {
        pub use super::area::*;
    }
}

#[allow(unused_imports)]
pub mod prelude {
    // pub use rstm::prelude::{Direction, Head, State, Tail};
    pub use crate::state::prelude::*;

    pub use crate::ops::prelude::*;
    pub use crate::traits::prelude::*;
    #[doc(no_inline)]
    pub use crate::types::prelude::*;
    pub use crate::utils::prelude::*;
}