heapless 0.4.1

`static` friendly data structures that don't require dynamic memory allocation
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

use core::sync::atomic::{self, AtomicUsize, Ordering};
#[cfg(feature = "smaller-atomics")]
use core::sync::atomic::{AtomicU16, AtomicU8};

use spsc::{MultiCore, SingleCore};

pub unsafe trait XCore {
    fn is_multi_core() -> bool;
}

unsafe impl XCore for SingleCore {
    fn is_multi_core() -> bool {
        false
    }
}

unsafe impl XCore for MultiCore {
    fn is_multi_core() -> bool {
        true
    }
}

pub unsafe trait Uxx: Into<usize> + Send {
    #[doc(hidden)]
    fn truncate(x: usize) -> Self;

    #[doc(hidden)]
    unsafe fn load_acquire<C>(x: *const Self) -> Self
    where
        C: XCore;

    #[doc(hidden)]
    fn load_relaxed(x: *const Self) -> Self;

    #[doc(hidden)]
    unsafe fn store_release<C>(x: *const Self, val: Self)
    where
        C: XCore;
}

#[cfg(feature = "smaller-atomics")]
unsafe impl Uxx for u8 {
    fn truncate(x: usize) -> Self {
        let max = ::core::u8::MAX;
        if x >= usize::from(max) {
            max
        } else {
            x as u8
        }
    }

    unsafe fn load_acquire<C>(x: *const Self) -> Self
    where
        C: XCore,
    {
        if C::is_multi_core() {
            (*(x as *const AtomicU8)).load(Ordering::Acquire)
        } else {
            let y = (*(x as *const AtomicU8)).load(Ordering::Relaxed);
            atomic::compiler_fence(Ordering::Acquire);
            y
        }
    }

    fn load_relaxed(x: *const Self) -> Self {
        unsafe { (*(x as *const AtomicU8)).load(Ordering::Relaxed) }
    }

    unsafe fn store_release<C>(x: *const Self, val: Self)
    where
        C: XCore,
    {
        if C::is_multi_core() {
            (*(x as *const AtomicU8)).store(val, Ordering::Release)
        } else {
            atomic::compiler_fence(Ordering::Release);
            (*(x as *const AtomicU8)).store(val, Ordering::Relaxed)
        }
    }
}

#[cfg(feature = "smaller-atomics")]
unsafe impl Uxx for u16 {
    fn truncate(x: usize) -> Self {
        let max = ::core::u16::MAX;
        if x >= usize::from(max) {
            max
        } else {
            x as u16
        }
    }

    unsafe fn load_acquire<C>(x: *const Self) -> Self
    where
        C: XCore,
    {
        if C::is_multi_core() {
            (*(x as *const AtomicU16)).load(Ordering::Acquire)
        } else {
            let y = (*(x as *const AtomicU16)).load(Ordering::Relaxed);
            atomic::compiler_fence(Ordering::Acquire);
            y
        }
    }

    fn load_relaxed(x: *const Self) -> Self {
        unsafe { (*(x as *const AtomicU16)).load(Ordering::Relaxed) }
    }

    unsafe fn store_release<C>(x: *const Self, val: Self)
    where
        C: XCore,
    {
        if C::is_multi_core() {
            (*(x as *const AtomicU16)).store(val, Ordering::Release)
        } else {
            atomic::compiler_fence(Ordering::Release);
            (*(x as *const AtomicU16)).store(val, Ordering::Relaxed)
        }
    }
}

unsafe impl Uxx for usize {
    fn truncate(x: usize) -> Self {
        x
    }

    unsafe fn load_acquire<C>(x: *const Self) -> Self
    where
        C: XCore,
    {
        if C::is_multi_core() {
            (*(x as *const AtomicUsize)).load(Ordering::Acquire)
        } else {
            let y = (*(x as *const AtomicUsize)).load(Ordering::Relaxed);
            atomic::compiler_fence(Ordering::Acquire);
            y
        }
    }

    fn load_relaxed(x: *const Self) -> Self {
        unsafe { (*(x as *const AtomicUsize)).load(Ordering::Relaxed) }
    }

    unsafe fn store_release<C>(x: *const Self, val: Self)
    where
        C: XCore,
    {
        if C::is_multi_core() {
            (*(x as *const AtomicUsize)).store(val, Ordering::Release)
        } else {
            atomic::compiler_fence(Ordering::Release);
            (*(x as *const AtomicUsize)).store(val, Ordering::Relaxed);
        }
    }
}