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
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348

// devela::code::util::_reexport_macro
//
//! private reexport meta helper
//

#[doc = crate::_tags!(internal)]
/// Macro helper for documentation of re-exported items.
#[doc = crate::_doc_meta!{location("yard")}]
//
// WAIT: [missing cross-crate docs](https://github.com/rust-lang/rust/issues/120927)
//       the solution is to re-export from core/alloc/std items on each crate.
#[cfg_attr(not(feature = "__docs_internal"), doc(hidden))]
#[cfg_attr(cargo_primary_package, doc(hidden))]
#[macro_export]
#[allow(clippy::crate_in_macro_def, reason = "_dep relative to macro call")]
macro_rules! _reexport· {
    // -------------------------------------------------------------------------
    /* re-exports from normal modules */

    // the following 4 arms allows reexporting items from:
    // `core`, `alloc`, `std` or `no_std`|`std`.
    //
    // - Supports multiple re-exported items.
    // - Renamed items must be all at the end, and each one prefixed with @.
    //
    // # Examples
    // ```
    // reexport! { rust: core::any, local_module: "any",
    //     "Represents a globally unique identifier for a type.", TypeId }
    // ```
    ( // when the item is available in `core`
      rust : core $( :: $( $core_path:ident )::+)?,
      $( local_module: $module_feature:literal, )?
      $( extra_features: $($extra_feat:literal),+ $(,)? )?
      $( extra_flags:($($extra_flag:ident),+) $(,)? )?
      $( location: $($location:literal)+ ,)?
      $( tag: $($tag:expr)+ ,)?
      doc: $doc_line:literal,
      $( +doc: $($doc_more:literal),+, )?
      $( $item:ident ),*
      $(@ $item_to_rename:ident as $item_renamed:ident),*
      $(,)?
    ) => { $crate::paste! {
        #[doc(inline)]
        $( $(#[doc = $tag])+ )? // tags
        #[doc = "<span class='stab portability' title='re-exported from rust&#39;s "
        "`core`'>`core`</span>"]
        #[doc = $doc_line] // first doc line
        #[doc = $crate::_doc_meta! {
            $( location(re-exported $($location)?), )?
            origin(rust core $(:: $( $core_path )::+)? $(
                ; renamed($item_to_rename as $item_renamed)
            )?),
        }]
        #[doc = $crate::_reexport!(@doc_local_tail $($($doc_more)+)?)]

        #[cfg_attr(nightly_doc, doc(cfg(all(
            $( feature = $module_feature, )?
            $( all($(feature = $extra_feat),+) )?
            $( all($($extra_flag),+) )?
        ))))]
        #[cfg(all(
            $( $(feature = $extra_feat),+ )?
            $( $($extra_flag),+ )?
        ))]
        pub use core :: $($( $core_path :: )+)? {
            $( $item ),*
            $( $item_to_rename as $item_renamed ),*
        };
    }};
    // when the item is available in `alloc`
    ( rust : alloc $( :: $( $alloc_path:ident )::+)?,
      $( local_module: $module_feature:literal, )?
      $( location: $($location:literal)+ ,)?
      $( tag: $($tag:expr)+ ,)?
      doc: $doc_line:literal,
      $( +doc: $($doc_more:literal),+, )?
      $( $item:ident ),*
      $(@ $item_to_rename:ident as $item_renamed:ident),*
      $(,)?
    ) => { $crate::paste! {
        #[doc(inline)]
        $( $(#[doc = $tag])+ )? // tags
        #[doc = "<span class='stab portability' title='re-exported from rust&#39;s "
        "`alloc`'>`alloc`</span>"]
        #[doc = $doc_line] // first doc line
        #[doc = $crate::_doc_meta! {
            $( location(re-exported $($location)?), )?
            origin(rust alloc $(:: $( $alloc_path )::+)? $(
                ; renamed($item_to_rename as $item_renamed)
            )?),
        }]
        #[doc = $crate::_reexport!(@doc_local_tail $($($doc_more)+)?)]

        #[cfg_attr(
            nightly_doc,
            doc(cfg(all(
                $( feature = $module_feature, )?
                feature = "alloc"
            )))
        )]
        #[cfg(feature = "alloc")]
        pub use alloc :: $($( $alloc_path :: )+)? {
            $( $item ),*
            $( $item_to_rename as $item_renamed ),*
        };
    }};
    ( // when the item is available in `std`
      rust : std $( :: $( $std_path:ident )::+)?,
      $( local_module: $module_feature:literal, )?
      $( location: $($location:literal)+ ,)?
      $( tag: $($tag:expr)+ ,)?
      doc: $doc_line:literal,
      $( +doc: $($doc_more:literal),+, )?
      $( $item:ident ),*
      $(@ $item_to_rename:ident as $item_renamed:ident),*
      $(,)?
    ) => { $crate::paste! {
        #[doc(inline)]
        $( $(#[doc = $tag])+ )? // tags
        #[doc = "<span class='stab portability' title='re-exported from rust&#39;s "
        "`std`'>`std`</span>"]
        #[doc = $doc_line] // first doc line
        #[doc = $crate::_doc_meta! {
            $( location(re-exported $($location)?), )?
            origin(rust std $(:: $( $std_path )::+)? $(
                ; renamed($item_to_rename as $item_renamed)
            )?),
        }]
        #[doc = $crate::_reexport!(@doc_local_tail $($($doc_more)+)?)]

        #[cfg_attr(
            nightly_doc,
            doc(cfg(all(
                $( feature = $module_feature, )?
                feature = "std"
            )))
        )]
        #[cfg(feature = "std")]
        pub use std :: $($( $std_path :: )+)? {
            $( $item ),*
            $( $item_to_rename as $item_renamed ),*
        };
    }};
    ( // when the item is available in either `not(std)` or `std` (always, more transparent)
      rust : not(std)|std $( :: $( $std_path:ident )::+)?,
      $( local_module: $module_feature:literal, )?
      $( location: $($location:literal)+ ,)?
      $( tag: $($tag:expr)+ ,)?
      doc: $doc_line:literal,
      $( +doc: $($doc_more:literal),+, )?
      $( $item:ident ),*
      $(@ $item_to_rename:ident as $item_renamed:ident),*
      $(,)?
    ) => { $crate::paste! {
        #[doc(inline)]
        // NOTE: In sync with _doc/_tags.rs::_TAG_MAYBE_STD
        $( $(#[doc = $tag])+ )? // tags
        /// <span class='stab portability' title='re-exported from rust&#39;s `std`
        /// or recreated if `not(std)`'>`?std`</span>
        #[doc = $doc_line] // first doc line
        #[doc = $crate::_doc_meta! {
            $( location(re-exported $($location)?), )?
            origin(rust std $(:: $( $std_path )::+)? $(
                ; renamed($item_to_rename as $item_renamed)
            )?),
        }]
        #[doc = $crate::_reexport!(@doc_local_tail $($($doc_more)+)?)]

        #[cfg_attr(
            nightly_doc,
            doc(cfg(all(
                $( feature = $module_feature, )?
            )))
        )]
        #[cfg(feature = "std")]
        pub use std :: $($( $std_path :: )+)? {
            $( $item ),*
            $( $item_to_rename as $item_renamed ),*
        };
    }};
    // -------------------------------------------------------------------------
    (
      /* external dependencies */

      // Re-exports a non-optional crate
      crate $dep_str:literal | $dep:ident,
      doc: $doc_line:literal
      $(, features: $( $f:literal ),+ )?
    ) => { $crate::paste! {
        #[doc = "<span class='stab portability' title='re-exported `" $dep_str
            "`'>`" $dep_str "`</span>"]
        #[doc = $doc_line "\n\n---" ]
        #[doc(inline)]
        pub use ::$dep;
    }};
    (
      // Re-exports an optional crate (used in */src/yard/dep.rs)
      //
      // $dep_safe:    [safe|unsafe] (affects compilation with "safest" feature)
      // $dep_feat:    the dependency feature that enables it
      // $dep_name:    the dependency real name
      // $dep_mod:     the dependency module name (using _ instead of -)
      // $doc_line:    the dependency description
      // $f:           additional features needed to enable this dependency
      optional_crate ($dep_safe:tt)
      $dep_feat:literal, $dep_name:literal, $dep_mod:ident,
      doc: $doc_line:literal
      $(, features: $( $f:literal ),+ )?
    ) => { $crate::paste! {
        #[cfg(all(feature = $dep_feat $(, $(feature = $f),+ )? ))]
        $crate::items! {
            // safety-guard: panics if `safest` is enabled and dependency is not safe
            #[cfg(feature = "safest")]
            #[$crate::compile(diff($dep_safe, safe))]
            const [<SAFEST_ $dep_name:upper>]: () = { panic![concat!["The `", $dep_name,
            "` dependency is not compatible with the `safest` feature"]] };

            #[doc = "<span class='stab portability' title='re-exported `" $dep_name
                "`'>`" $dep_name "`</span>"]
            #[doc = $doc_line "\n\n---" ]
            #[cfg_attr(
                nightly_doc,
                doc(cfg(all(
                    feature = $dep_feat $(, $(feature = $f)+ )?
                )))
            )]
            #[doc(no_inline)] // MAYBE IMPROVE: allow customization
            pub use ::$dep_mod;
        }
    }};
    (
      // re-exports items from an external optional dependency, from any normal module.
      //
      // - Supports multiple re-exported items.
      // - Renamed items must be all at the end, and each one prefixed with @.
      //
      // $dep_feat:    the dependency feature
      // $dep_name:    the dependency name
      // $dep_mod:     the dependency module
      // $f:           additional features needed
      // $doc_line:    the dependency description
      // $item:
      // $item_to_rename:
      // $item_renamed:
      $dep_feat:literal, $dep_name:literal, $dep_mod:ident $( :: $dep_path:path)?,
      $( features: $( $f:literal ),+ ,)?
      $( location: $($location:literal)+ ,)?
      $( tag: $($tag:expr)+ ,)?
      doc: $doc_line:literal,
      $( +doc: $($doc_more:literal),+, )?
      $( $item:ident ),*
      $(@ $item_to_rename:ident as $item_renamed:ident),*
      $(,)?
    ) => { $crate::paste! {
        #[doc(inline)]
        $( $(#[doc = $tag])+ )? // tags
        #[doc = "<span class='stab portability' title='re-exported from the `"
            $dep_name "` crate'>`" $dep_name "`</span>"]
        #[doc = $doc_line] // first doc line
        #[doc = $crate::_doc_meta! {
            $( location(re-exported $($location)?), )?
            origin(crate $dep_name $(
                ; renamed($item_to_rename as $item_renamed)
            )?),
        }]
        #[doc = $crate::_reexport!(@doc_local_tail $($($doc_more)+)?)]

        // IMPROVE: can't use like this for portable-atomic | core::atomic,
        // should remove depend from here for the portable-atomic part,
        // but leave it in the following cfg attribute.
        // Also, the part of negated features and target_has_atomic
        // would require a different branch
        #[cfg_attr(
            nightly_doc,
            doc(cfg(all(
                feature = $dep_feat $(, $(feature = $f)+ )?
            )))
        )]

        #[cfg(all(feature = $dep_feat $(, $(feature = $f),+ )? ))]
        pub use crate::_dep::$dep_mod $( ::$dep_path )? :: {
            $( $item ),*
            $( $item_to_rename as $item_renamed ),*
        };
    }};
    (
      // re-exports items from an external non-optional dependency, from any normal module.
      //
      // - Supports multiple re-exported items.
      // - Renamed items must be all at the end, and each one prefixed with @.
      //
      // in the past it was used for: result::Either
      non-optional $dep_str:literal | $dep:ident $( :: $dep_path:path)?,
      $( features: $( $f:literal ),+ ,)?
      $( local_module: $module_feature:literal ,)?
      $( location: $($location:literal)+ ,)?
      $( tag: $($tag:expr)+ ,)?
      doc: $doc_line:literal,
      $( +doc: $($doc_more:literal),+, )?
      $( $item:ident ),*
      $(@ $item_to_rename:ident as $item_renamed:ident),*
      $(,)?
    ) => { $crate::paste! {
        #[doc(inline)]
        $( $(#[doc = $tag])+ )? // tags
        #[doc = "<span class='stab portability' title='re-exported from the `"
            $dep_str "` crate'>`" $dep_str "`</span>"]
        #[doc = $crate::_doc_meta! {
            $( location(re-exported $($location)?), )?
            origin(crate $dep_str => $dep_name $(
            // origin(crate $dep_name $( // simpler form
                ; renamed($item_to_rename as $item_renamed)
            )?),
        }]
        #[doc = $crate::_reexport!(@doc_local_tail $($($doc_more)+)?)]

        #[cfg_attr(nightly_doc, doc(cfg(all(
            $( feature = $module_feature ,)?
            $( $( feature = $f ),+ )?
        ))))]
        #[cfg(all( $($( feature = $f )+)? ))]

        pub use ::$dep $( ::$dep_path )? :: {
            $( $item ),*
            $( $item_to_rename as $item_renamed ),*
        };
    }};

    /* local docs tail */

    // Finishes the local documentation emitted by `_reexport!`.
    (@doc_local_tail) => {
        concat!(
            "\n\n---\n\n",
            "<span class='stab portability' title='Upstream/original documentation'>📜</span><br>"
        )
    };
    (@doc_local_tail $($doc_more:expr)+) => {
        concat!(
            "\n\n", $($doc_more, "\n\n",)+
            "\n\n---\n\n---\n\n",
            "<span class='stab portability' title='Upstream/original documentation'>📜</span><br>"
        )
    };
}
#[doc(inline)]
pub use _reexport· as _reexport;