devela 0.28.0

A development substrate of coherence.
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

// devela::yard::_use
//
//! Defines the internal meta helpers: [`_use`], [`_use_or_shim`].
//

#[doc = crate::_tags!(internal)]
/// Imports `from_utf8` and `from_utf8_mut` with a SIMD version, if available.
#[doc = crate::_doc_meta!{location("yard")}]
///
/// # Features
/// Uses the `dep_simdutf8` feature if enabled:
/// - `compat` mode is an exact replacement of core's API.
/// - `basic` mode is faster but has no error information.
/// - `both` mode imports all sets of fns prefixed with `compat_` and `basic_`.
#[cfg_attr(cargo_primary_package, doc(hidden))]
#[cfg_attr(not(feature = "__docs_internal"), doc(hidden))]
#[cfg_attr(nightly_doc, doc(cfg(feature = "__docs_internal")))]
#[macro_export]
macro_rules! _use· {
    /* to be used as imports */
    // (dep_simdutf8::compat::from_utf8) => { // MAYBE alternative syntax
    (compat::from_utf8) => {
        #[allow(unused_imports)]
        #[cfg(not(feature = "dep_simdutf8"))]
        use ::core::str::{from_utf8, from_utf8_mut};
        #[allow(unused_imports)]
        #[cfg(feature = "dep_simdutf8")]
        use ::simdutf8::compat::{from_utf8, from_utf8_mut};
    };
    (basic::from_utf8) => {
        #[allow(unused_imports)]
        #[cfg(not(feature = "dep_simdutf8"))]
        use ::core::str::{from_utf8, from_utf8_mut};
        #[allow(unused_imports)]
        #[cfg(feature = "dep_simdutf8")]
        use ::simdutf8::basic::{from_utf8, from_utf8_mut};
    };
    (both::from_utf8) => {
        #[allow(unused_imports)]
        #[cfg(not(feature = "dep_simdutf8"))]
        use ::core::str::{from_utf8 as basic_from_utf8, from_utf8_mut as basic_from_utf8_mut};
        #[allow(unused_imports)]
        #[cfg(feature = "dep_simdutf8")]
        use ::simdutf8::basic::{
            from_utf8 as basic_from_utf8, from_utf8_mut as basic_from_utf8_mut,
        };

        #[allow(unused_imports)]
        #[cfg(not(feature = "dep_simdutf8"))]
        use ::core::str::{from_utf8 as compat_from_utf8, from_utf8_mut as compat_from_utf8_mut};
        #[allow(unused_imports)]
        #[cfg(feature = "dep_simdutf8")]
        use ::simdutf8::compat::{
            from_utf8 as compat_from_utf8, from_utf8_mut as compat_from_utf8_mut,
        };
    };
}
#[doc(inline)]
pub use _use· as _use;

#[doc = crate::_tags!(internal)]
/// Imports known helpers or provides compatibility shims.
#[doc = crate::_doc_meta!{location("yard")}]
///
/// Used by dual-purpose source files that must compile both inside devela
/// and as standalone examples.
///
/// Inside devela, it imports the requested helpers.
/// Outside devela, it defines inert stand-ins for a fixed whitelist.
///
/// Unsupported names are rejected at compile time.
///
/// Used from:
/// - /src/code/guard.rs
/// - /src/sys/mem/guard.rs
#[cfg_attr(cargo_primary_package, doc(hidden))]
#[cfg_attr(not(feature = "__docs_internal"), doc(hidden))]
#[cfg_attr(nightly_doc, doc(cfg(feature = "__docs_internal")))]
#[macro_export]
// NOTE $_d: the dollar sign passed as a token, as a trick to be able to nest repetitions.
macro_rules! _use_or_shim· {
    ($($name:ident),+ $(,)?) => {
        $( $crate::_use_or_shim![%($) $name]; )+
    };
    (%($_d:tt) _tags) => {
        $crate::_use_or_shim![%shim _tags => { ($_d($tt:tt)*) => {""} } ];
        $crate::_use_or_shim![%import _tags];
    };
    (%($_d:tt) _doc_vendor) => {
        $crate::_use_or_shim![%shim _doc_vendor => { ($_d($tt:tt)*) => {""} } ];
        $crate::_use_or_shim![%import _doc_vendor];
    };
    (%($_d:tt) _doc_location) => {
        $crate::_use_or_shim![%shim _doc_location => { ($_d($tt:tt)*) => {""} } ];
        $crate::_use_or_shim![%import _doc_location];
    };
    // imports the real macro
    (%import $name:ident) => {
        #[$crate::compile(env(__DEVELA_MEMBER))]
        #[allow(unused_imports)]
        use ::devela::$name;
    };
    // creates a shim macro
    (%shim $name:ident => { $($rules:tt)* }) => {
        #[$crate::compile(not(env(__DEVELA_MEMBER)))]
        #[allow(unused_macros)]
        macro_rules! $name { $($rules)* }
    };
    (% $name:ident) => {
        compile_error!(concat!(
            "Unsupported helper for `_use_or_shim!`: `", stringify!($name),
            "`. Supported names: `_doc`, `_doc_location`, `_tags`."
        ));
    };
}
#[doc(inline)]
pub use _use_or_shim· as _use_or_shim;