scattered-collect 0.4.0

Link-time collections for Rust (distributed slices, registries)
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

//! A collection of items gathered into a slice (link order), with each entry
//! wrapped as [`Ref`] so `static` items work on targets such as WASM.
#![doc = concat!("```rust\n", include_str!("../examples/referenced_slice.rs"), "\n```\n")]

use link_section::TypedReferenceSection;

pub use link_section::Ref;

/// A collection of sized items available both as a slice over the gathered
/// section and as `static` handles at each declaration site.
///
/// The slice is in an arbitrary link order which is platform-dependent. For a
/// sorted slice without per-item handles, use [`crate::ScatteredSortedSlice`]. For
/// arbitrary link order without per-item handles, use [`crate::ScatteredSlice`]. For
/// sorted data with stable per-item references, use
/// [`crate::ScatteredSortedReferencedSlice`]. For key lookup, use [`crate::ScatteredMap`].
/// ```rust
#[doc = include_str!("../examples/referenced_slice.rs")]
/// ```
pub struct ScatteredReferencedSlice<T: 'static> {
    section: &'static TypedReferenceSection<T>,
}

impl<T: 'static> ScatteredReferencedSlice<T> {
    #[doc(hidden)]
    #[allow(unsafe_code)]
    pub const unsafe fn new(section: &'static TypedReferenceSection<T>) -> Self {
        Self { section }
    }

    /// The number of items in the slice.
    pub fn len(&self) -> usize {
        self.section.len()
    }

    /// True if the slice is empty.
    pub fn is_empty(&self) -> bool {
        self.section.is_empty()
    }

    /// The offset of the item in the slice, if it is from this slice.
    ///
    /// This is O(1), as it performs direct pointer arithmetic.
    pub fn offset_of(
        this: &Self,
        item: impl link_section::SectionItemLocation<T>,
    ) -> Option<usize> {
        TypedReferenceSection::offset_of(this.section, item)
    }
}

impl<T: 'static> ::core::ops::Deref for ScatteredReferencedSlice<T> {
    type Target = [T];
    fn deref(&self) -> &Self::Target {
        self.section.as_slice()
    }
}

/// Declare a scattered referenced slice.
#[macro_export]
#[doc(hidden)]
macro_rules! __referenced_slice {
    (gather $vis:vis $name:ident: $ty:ty) => {
        $crate::__referenced_slice!(@gather $vis static $name: ScatteredReferencedSlice<$ty>;);
    };
    (@gather $(#[$meta:meta])* $vis:vis static $name:ident: $collection:ident < $ty:ty >;) => {
        $crate::__support::ident_concat!((#[doc(hidden)] #[macro_export] macro_rules!) (__ $name __referenced_slice_private_macro__) ({
            ($passthru:tt) => {
                $crate::__referenced_slice!(@scatter [$name] $passthru);
            };
        }));

        $crate::__support::ident_concat!((#[doc(hidden)] $vis use) (__ $name __referenced_slice_private_macro__) (as $name;));

        $(#[$meta])*
        $vis static $name: $collection<$ty> = {
            $crate::__support::link_section::declarative::section!(
                #[section(reference, no_macro)]
                static $name: $crate::__support::link_section::TypedReferenceSection<$ty>;
            );

            unsafe {
                $crate::referenced_slice::ScatteredReferencedSlice::new(
                    $name.const_deref(),
                )
            }
        };
    };
    (@scatter [$collection_name:ident] ([$($meta:tt)*] => $(#[$imeta:meta])* $vis:vis static $name:ident: $ty:ty = $expr:expr;)) => {
        $crate::__support::link_section::declarative::in_section!(
            #[in_section(unsafe, name = $collection_name, type = reference)]
            $vis static $name: $ty = $expr;
        );
    };
}

#[cfg(all(test, not(miri)))]
mod tests {
    use crate::referenced_slice::ScatteredReferencedSlice;

    __referenced_slice!(gather pub TEST_REF_SLICE: u32);
    __referenced_slice!(@scatter [TEST_REF_SLICE] ([TEST_REF_SLICE] => pub static REF_SLICE_ITEM_A: u32 = 1;));
    __referenced_slice!(@scatter [TEST_REF_SLICE] ([TEST_REF_SLICE] => pub static REF_SLICE_ITEM_B: u32 = 3;));
    __referenced_slice!(@scatter [TEST_REF_SLICE] ([TEST_REF_SLICE] => pub static REF_SLICE_ITEM_C: u32 = 2;));

    #[test]
    fn test_scattered_referenced_slice() {
        assert_eq!(TEST_REF_SLICE.len(), 3);
        assert!(TEST_REF_SLICE.contains(&1));
        assert!(TEST_REF_SLICE.contains(&2));
        assert!(TEST_REF_SLICE.contains(&3));

        assert_eq!(*REF_SLICE_ITEM_A, 1);
        assert_eq!(*REF_SLICE_ITEM_B, 3);
        assert_eq!(*REF_SLICE_ITEM_C, 2);
    }
}