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
use crate::{RingBuffer, RingBufferExt, RingBufferRead, RingBufferWrite};
use core::iter::FromIterator;
use core::mem::MaybeUninit;
use core::ops::{Index, IndexMut};
#[derive(Debug)]
pub struct ConstGenericRingBuffer<T, const CAP: usize> {
buf: [MaybeUninit<T>; CAP],
readptr: usize,
writeptr: usize,
}
impl<T: Clone, const CAP: usize> Clone for ConstGenericRingBuffer<T, CAP> {
fn clone(&self) -> Self {
let mut new = ConstGenericRingBuffer::<T, CAP>::new();
for elem in self.iter() {
new.push(elem.clone())
}
new
}
}
impl<T: PartialEq, const CAP: usize> PartialEq for ConstGenericRingBuffer<T, CAP> {
fn eq(&self, other: &Self) -> bool {
if self.len() == other.len() {
for (a, b) in self.iter().zip(other.iter()) {
if a != b {
return false;
}
}
true
} else {
false
}
}
}
impl<T: PartialEq, const CAP: usize> Eq for ConstGenericRingBuffer<T, CAP> {}
impl<T, const CAP: usize> ConstGenericRingBuffer<T, CAP> {
#[inline]
pub fn new() -> Self {
Self::default()
}
unsafe fn get_unchecked(&self, index: usize) -> &T {
self.buf[index]
.as_ptr()
.as_ref()
.expect("const array ptr shouldn't be null!")
}
unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut T {
self.buf[index]
.as_mut_ptr()
.as_mut()
.expect("const array ptr shouldn't be null!")
}
}
impl<T, const CAP: usize> RingBufferRead<T> for ConstGenericRingBuffer<T, CAP> {
#[inline]
fn dequeue_ref(&mut self) -> Option<&T> {
if self.is_empty() {
None
} else {
let index = crate::mask(CAP, self.readptr);
self.readptr += 1;
let res = unsafe {
self.get_unchecked(index)
};
Some(res)
}
}
impl_ringbuffer_read!(readptr);
}
impl<T, const CAP: usize> RingBufferWrite<T> for ConstGenericRingBuffer<T, CAP> {
#[inline]
fn push(&mut self, value: T) {
if self.is_full() {
let index = crate::mask(CAP, self.readptr);
unsafe {
core::ptr::drop_in_place(self.buf[index].as_mut_ptr());
}
self.readptr += 1;
}
let index = crate::mask(CAP, self.writeptr);
self.buf[index] = MaybeUninit::new(value);
self.writeptr += 1;
}
}
impl<T, const CAP: usize> RingBufferExt<T> for ConstGenericRingBuffer<T, CAP> {
impl_ringbuffer_ext!(
get_unchecked,
get_unchecked_mut,
readptr,
writeptr,
crate::mask
);
}
impl<T, const CAP: usize> RingBuffer<T> for ConstGenericRingBuffer<T, CAP> {
#[inline]
#[cfg(not(tarpaulin_include))]
fn capacity(&self) -> usize {
CAP
}
impl_ringbuffer!(readptr, writeptr);
}
impl<T, const CAP: usize> Default for ConstGenericRingBuffer<T, CAP> {
#[inline]
fn default() -> Self {
assert_ne!(CAP, 0, "Capacity must be greater than 0");
assert!(CAP.is_power_of_two(), "Capacity must be a power of two");
let arr = array_init::array_init(|_| MaybeUninit::uninit());
Self {
buf: arr,
writeptr: 0,
readptr: 0,
}
}
}
impl<RB, const CAP: usize> FromIterator<RB> for ConstGenericRingBuffer<RB, CAP> {
fn from_iter<T: IntoIterator<Item = RB>>(iter: T) -> Self {
let mut res = Self::default();
for i in iter {
res.push(i)
}
res
}
}
impl<T, const CAP: usize> Index<isize> for ConstGenericRingBuffer<T, CAP> {
type Output = T;
fn index(&self, index: isize) -> &Self::Output {
self.get(index).expect("index out of bounds")
}
}
impl<T, const CAP: usize> IndexMut<isize> for ConstGenericRingBuffer<T, CAP> {
fn index_mut(&mut self, index: isize) -> &mut Self::Output {
self.get_mut(index).expect("index out of bounds")
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
#[should_panic]
fn test_no_empty() {
let _ = ConstGenericRingBuffer::<u32, 0>::new();
}
#[test]
#[should_panic]
fn test_with_capacity_no_power_of_two() {
let _ = ConstGenericRingBuffer::<i32, 10>::new();
}
#[test]
#[should_panic]
fn test_index_zero_length() {
let b = ConstGenericRingBuffer::<i32, 2>::new();
let _ = b[2];
}
}