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
#![deny(unsafe_code)]
#![deny(missing_docs)]
#![cfg_attr(not(test), no_std)]
pub struct RingBuffer<T, const SIZE: usize> {
data: [T; SIZE],
oldest: usize,
num_elems: usize,
}
pub enum Error {
BufferFull,
}
impl<T: Default + Copy, const SIZE: usize> Default for RingBuffer<T, SIZE> {
fn default() -> Self {
RingBuffer {
data: [T::default(); SIZE],
oldest: 0,
num_elems: 0,
}
}
}
impl<T: Default + Copy, const SIZE: usize> RingBuffer<T, SIZE> {
pub fn new() -> Self {
Default::default()
}
pub fn push_overwrite(&mut self, elem: T) -> Option<T> {
let index = (self.oldest + self.num_elems) % SIZE;
if self.is_full() {
let oldest = self.data[self.oldest];
self.oldest = (self.oldest + 1) % SIZE;
self.data[index] = elem;
Some(oldest)
} else {
self.data[index] = elem;
self.num_elems += 1;
None
}
}
pub fn push_unless_full(&mut self, elem: T) -> Result<(), Error> {
if self.is_full() {
return Err(Error::BufferFull);
}
let index = (self.oldest + self.num_elems) % SIZE;
self.data[index] = elem;
self.num_elems += 1;
Ok(())
}
pub fn pop(&mut self) -> Option<T> {
if self.is_empty() {
return None;
}
let elem = self.data[self.oldest];
self.oldest = (self.oldest + 1) % SIZE;
self.num_elems -= 1;
Some(elem)
}
pub fn len(&self) -> usize {
self.num_elems
}
pub fn is_empty(&self) -> bool {
self.len() == 0
}
pub fn is_full(&self) -> bool {
self.len() == SIZE
}
}
pub struct ConsumingIntoIteratorRingbuffer<T, const SIZE: usize> {
buffer: RingBuffer<T, SIZE>,
}
impl<T: Default + Copy, const SIZE: usize> IntoIterator for RingBuffer<T, SIZE> {
type Item = T;
type IntoIter = ConsumingIntoIteratorRingbuffer<T, SIZE>;
fn into_iter(self) -> Self::IntoIter {
ConsumingIntoIteratorRingbuffer { buffer: self }
}
}
impl<T: Default + Copy, const SIZE: usize> Iterator for ConsumingIntoIteratorRingbuffer<T, SIZE> {
type Item = T;
fn next(&mut self) -> Option<Self::Item> {
self.buffer.pop()
}
}
pub struct IntoIteratorRingbuffer<'a, T, const SIZE: usize> {
buffer: &'a RingBuffer<T, SIZE>,
current: usize,
}
impl<'a, T: Default + Copy, const SIZE: usize> IntoIterator for &'a RingBuffer<T, SIZE> {
type Item = &'a T;
type IntoIter = IntoIteratorRingbuffer<'a, T, SIZE>;
fn into_iter(self) -> Self::IntoIter {
IntoIteratorRingbuffer {
buffer: self,
current: 0,
}
}
}
impl<'a, T: Default + Copy, const SIZE: usize> Iterator for IntoIteratorRingbuffer<'a, T, SIZE> {
type Item = &'a T;
fn next(&mut self) -> Option<Self::Item> {
if self.current < self.buffer.num_elems {
let index = (self.buffer.oldest + self.current) % SIZE;
let elem = &self.buffer.data[index];
self.current += 1;
Some(elem)
} else {
None
}
}
}
impl<T: Default + Copy, const SIZE: usize> RingBuffer<T, SIZE> {
pub fn iter(&self) -> IntoIteratorRingbuffer<T, SIZE> {
self.into_iter()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn it_works() {
let mut buffer = RingBuffer::<u16, 8>::new();
assert!(buffer.is_empty());
buffer.push_overwrite(1);
assert_eq!(1, buffer.len());
let one = buffer.pop().unwrap();
assert_eq!(1, one);
}
#[test]
fn pop_empty() {
let mut buffer = RingBuffer::<u8, 8>::new();
assert_eq!(buffer.pop(), None);
}
#[test]
fn single_element() {
let mut buffer = RingBuffer::<u8, 1>::new();
assert!(buffer.is_empty());
buffer.push_overwrite(1);
assert!(buffer.is_full());
assert_eq!(1, buffer.pop().unwrap());
buffer.push_overwrite(2);
buffer.push_overwrite(3);
assert_eq!(3, buffer.pop().unwrap());
}
#[test]
fn consuming_iterator() {
let mut buffer = RingBuffer::<u8, 8>::new();
buffer.push_overwrite(5);
buffer.push_overwrite(125);
buffer.push_overwrite(0);
let mut iter = std::iter::IntoIterator::into_iter(buffer);
assert_eq!(5, iter.next().unwrap());
assert_eq!(125, iter.next().unwrap());
assert_eq!(0, iter.next().unwrap());
assert_eq!(None, iter.next());
assert_eq!(None, iter.next());
}
#[test]
fn iterator_immutable() {
let mut buffer = RingBuffer::<u8, 4>::new();
buffer.push_overwrite(1);
buffer.push_overwrite(2);
buffer.push_overwrite(3);
let mut iter = std::iter::IntoIterator::into_iter(&buffer);
assert_eq!(&1, iter.next().unwrap());
assert_eq!(&2, iter.next().unwrap());
assert_eq!(&3, iter.next().unwrap());
assert_eq!(None, iter.next());
assert_eq!(None, iter.next());
buffer.push_overwrite(4);
buffer.push_overwrite(5);
buffer.push_overwrite(6);
assert_eq!(4, buffer.len());
}
#[test]
fn iter_convenience() {
let mut buffer = RingBuffer::<u8, 4>::new();
buffer.push_overwrite(1);
buffer.push_overwrite(2);
buffer.push_overwrite(3);
let iter = std::iter::IntoIterator::into_iter(&buffer);
let iter2 = buffer.iter();
for (x, y) in iter.zip(iter2) {
assert_eq!(x, y);
}
}
#[test]
fn push_overwrite() {
let mut buffer = RingBuffer::<u128, 4>::new();
assert!(buffer.push_overwrite(1).is_none());
assert!(buffer.push_overwrite(2).is_none());
assert!(buffer.push_overwrite(3).is_none());
assert!(buffer.push_overwrite(4).is_none());
assert_eq!(1, buffer.push_overwrite(5).unwrap());
assert_eq!(2, buffer.push_overwrite(6).unwrap());
assert_eq!(3, buffer.push_overwrite(7).unwrap());
assert_eq!(4, buffer.push_overwrite(8).unwrap());
assert_eq!(5, buffer.push_overwrite(9).unwrap());
assert_eq!(4, buffer.len());
assert!(buffer.is_full());
}
#[test]
fn fail_overwrite() {
let mut buffer = RingBuffer::<u128, 4>::new();
assert!(buffer.push_overwrite(1).is_none());
assert!(buffer.push_overwrite(2).is_none());
assert!(buffer.push_overwrite(3).is_none());
assert!(buffer.push_overwrite(4).is_none());
assert!(buffer.push_unless_full(5).is_err());
assert!(buffer.push_unless_full(6).is_err());
match buffer.push_unless_full(192) {
Err(Error::BufferFull) => assert!(true),
_ => unreachable!("Wrong error variant!"),
}
assert_eq!(1, buffer.pop().unwrap());
assert!(buffer.push_unless_full(5).is_ok());
}
}