devela/data/list/tuple/
mod.rs

1// devela::data::collections::tuple
2//
3//! Heterogeneous data structures, random-access, sequentially allocated and statically sized.
4//
5// NOTE: re-exports the code-generated [`Tuple`] trait, and defines related items.
6//
7// See also
8// - https://dev-doc.rust-lang.org/stable/unstable-book/library-features/tuple-trait.html
9
10#[cfg(test)]
11mod tests;
12
13#[cfg_attr(feature = "nightly_doc", doc(cfg(feature = "_tuple")))]
14mod codegen {
15    use crate::{Debug, Display, FmtResult, Formatter};
16
17    // - trait `Tuple` and its multi-arity impls.
18    // - enums `TupleEnumRef` and `TupleEnumMut`.
19    include!(concat!(env!("OUT_DIR"), "/build/tuple.rs"));
20
21    /// Marker trait to prevent downstream implementations of the [`Tuple`] trait.
22    trait Sealed {}
23
24    /// A formatting wrapper for [`Tuple`]s, implementing `Display` and `Debug`.
25    #[repr(transparent)]
26    pub struct TupleFmt<'a, T: Tuple>(&'a T);
27
28    /// Private trait for [`Tuple`]s with elements that implement `Debug`.
29    trait TupleDebug: Tuple {
30        fn fmt_debug(&self, f: &mut Formatter) -> FmtResult<()>;
31    }
32    impl<T: TupleDebug> Debug for TupleFmt<'_, T> {
33        fn fmt(&self, f: &mut Formatter) -> FmtResult<()> {
34            self.0.fmt_debug(f)
35        }
36    }
37
38    /// Private trait for [`Tuple`]s with elements that implement `Display`.
39    trait TupleDisplay: Tuple {
40        fn fmt_display(&self, f: &mut Formatter) -> FmtResult<()>;
41    }
42    impl<T: TupleDisplay> Display for TupleFmt<'_, T> {
43        fn fmt(&self, f: &mut Formatter) -> FmtResult<()> {
44            self.0.fmt_display(f)
45        }
46    }
47}
48
49crate::items! { // structural access: _mods, _all
50    #[allow(unused)]
51    pub use _mods::*;
52
53    mod _mods {
54        pub use super::codegen::*;
55    }
56    pub(super) mod _all {
57        #[doc(inline)]
58        pub use super::_mods::*;
59    }
60}