# histbuf.rs - source
Source of the Rust file `C:\Users\zenn\.cargo\registry\src\index.crates.io-6f17d22bba15001f\heapless-0.7.16\src\histbuf.rs`.

    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
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433

    use core::fmt;
    use core::mem::MaybeUninit;
    use core::ops::Deref;
    use core::ptr;
    use core::slice;

    /// A "history buffer", similar to a write-only ring buffer of fixed length.
    ///
    /// This buffer keeps a fixed number of elements.  On write, the oldest element
    /// is overwritten. Thus, the buffer is useful to keep a history of values with
    /// some desired depth, and for example calculate a rolling average.
    ///
    /// # Examples
    /// ```
    /// use heapless::HistoryBuffer;
    ///
    /// // Initialize a new buffer with 8 elements.
    /// let mut buf = HistoryBuffer::<_, 8>::new();
    ///
    /// // Starts with no data
    /// assert_eq!(buf.recent(), None);
    ///
    /// buf.write(3);
    /// buf.write(5);
    /// buf.extend(&[4, 4]);
    ///
    /// // The most recent written element is a four.
    /// assert_eq!(buf.recent(), Some(&4));
    ///
    /// // To access all elements in an unspecified order, use `as_slice()`.
    /// for el in buf.as_slice() { println!("{:?}", el); }
    ///
    /// // Now we can prepare an average of all values, which comes out to 4.
    /// let avg = buf.as_slice().iter().sum::<usize>() / buf.len();
    /// assert_eq!(avg, 4);
    /// ```
    pub struct HistoryBuffer<T, const N: usize> {
        data: [MaybeUninit<T>; N],
        write_at: usize,
        filled: bool,
    }

    impl<T, const N: usize> HistoryBuffer<T, N> {
        const INIT: MaybeUninit<T> = MaybeUninit::uninit();

        /// Constructs a new history buffer.
        ///
        /// The construction of a `HistoryBuffer` works in `const` contexts.
        ///
        /// # Examples
        ///
        /// ```
        /// use heapless::HistoryBuffer;
        ///
        /// // Allocate a 16-element buffer on the stack
        /// let x: HistoryBuffer<u8, 16> = HistoryBuffer::new();
        /// assert_eq!(x.len(), 0);
        /// ```
        #[inline]
        pub const fn new() -> Self {
            // Const assert
            crate::sealed::greater_than_0::<N>();

            Self {
                data: [Self::INIT; N],
                write_at: 0,
                filled: false,
            }
        }

        /// Clears the buffer, replacing every element with the default value of
        /// type `T`.
        pub fn clear(&mut self) {
            *self = Self::new();
        }
    }

    impl<T, const N: usize> HistoryBuffer<T, N>
    where
        T: Copy + Clone,
    {
        /// Constructs a new history buffer, where every element is the given value.
        ///
        /// # Examples
        ///
        /// ```
        /// use heapless::HistoryBuffer;
        ///
        /// // Allocate a 16-element buffer on the stack
        /// let mut x: HistoryBuffer<u8, 16> = HistoryBuffer::new_with(4);
        /// // All elements are four
        /// assert_eq!(x.as_slice(), [4; 16]);
        /// ```
        #[inline]
        pub fn new_with(t: T) -> Self {
            Self {
                data: [MaybeUninit::new(t); N],
                write_at: 0,
                filled: true,
            }
        }

        /// Clears the buffer, replacing every element with the given value.
        pub fn clear_with(&mut self, t: T) {
            *self = Self::new_with(t);
        }
    }

    impl<T, const N: usize> HistoryBuffer<T, N> {
        /// Returns the current fill level of the buffer.
        #[inline]
        pub fn len(&self) -> usize {
            if self.filled {
                N
            } else {
                self.write_at
            }
        }

        /// Returns the capacity of the buffer, which is the length of the
        /// underlying backing array.
        #[inline]
        pub fn capacity(&self) -> usize {
            N
        }

        /// Writes an element to the buffer, overwriting the oldest value.
        pub fn write(&mut self, t: T) {
            if self.filled {
                // Drop the old before we overwrite it.
                unsafe { ptr::drop_in_place(self.data[self.write_at].as_mut_ptr()) }
            }
            self.data[self.write_at] = MaybeUninit::new(t);

            self.write_at += 1;
            if self.write_at == self.capacity() {
                self.write_at = 0;
                self.filled = true;
            }
        }

        /// Clones and writes all elements in a slice to the buffer.
        ///
        /// If the slice is longer than the buffer, only the last `self.len()`
        /// elements will actually be stored.
        pub fn extend_from_slice(&mut self, other: &[T])
        where
            T: Clone,
        {
            for item in other {
                self.write(item.clone());
            }
        }

        /// Returns a reference to the most recently written value.
        ///
        /// # Examples
        ///
        /// ```
        /// use heapless::HistoryBuffer;
        ///
        /// let mut x: HistoryBuffer<u8, 16> = HistoryBuffer::new();
        /// x.write(4);
        /// x.write(10);
        /// assert_eq!(x.recent(), Some(&10));
        /// ```
        pub fn recent(&self) -> Option<&T> {
            if self.write_at == 0 {
                if self.filled {
                    Some(unsafe { &*self.data[self.capacity() - 1].as_ptr() })
                } else {
                    None
                }
            } else {
                Some(unsafe { &*self.data[self.write_at - 1].as_ptr() })
            }
        }

        /// Returns the array slice backing the buffer, without keeping track
        /// of the write position. Therefore, the element order is unspecified.
        pub fn as_slice(&self) -> &[T] {
            unsafe { slice::from_raw_parts(self.data.as_ptr() as *const _, self.len()) }
        }

        /// Returns an iterator for iterating over the buffer from oldest to newest.
        ///
        /// # Examples
        ///
        /// ```
        /// use heapless::HistoryBuffer;
        ///
        /// let mut buffer: HistoryBuffer<u8, 6> = HistoryBuffer::new();
        /// buffer.extend([0, 0, 0, 1, 2, 3, 4, 5, 6]);
        /// let expected = [1, 2, 3, 4, 5, 6];
        /// for (x, y) in buffer.oldest_ordered().zip(expected.iter()) {
        ///     assert_eq!(x, y)
        /// }
        ///
        /// ```
        pub fn oldest_ordered<'a>(&'a self) -> OldestOrdered<'a, T, N> {
            if self.filled {
                OldestOrdered {
                    buf: self,
                    cur: self.write_at,
                    wrapped: false,
                }
            } else {
                // special case: act like we wrapped already to handle empty buffer.
                OldestOrdered {
                    buf: self,
                    cur: 0,
                    wrapped: true,
                }
            }
        }
    }

    impl<T, const N: usize> Extend<T> for HistoryBuffer<T, N> {
        fn extend<I>(&mut self, iter: I)
        where
            I: IntoIterator<Item = T>,
        {
            for item in iter.into_iter() {
                self.write(item);
            }
        }
    }

    impl<'a, T, const N: usize> Extend<&'a T> for HistoryBuffer<T, N>
    where
        T: 'a + Clone,
    {
        fn extend<I>(&mut self, iter: I)
        where
            I: IntoIterator<Item = &'a T>,
        {
            self.extend(iter.into_iter().cloned())
        }
    }

    impl<T, const N: usize> Drop for HistoryBuffer<T, N> {
        fn drop(&mut self) {
            unsafe {
                ptr::drop_in_place(ptr::slice_from_raw_parts_mut(
                    self.data.as_mut_ptr() as *mut T,
                    self.len(),
                ))
            }
        }
    }

    impl<T, const N: usize> Deref for HistoryBuffer<T, N> {
        type Target = [T];

        fn deref(&self) -> &[T] {
            self.as_slice()
        }
    }

    impl<T, const N: usize> AsRef<[T]> for HistoryBuffer<T, N> {
        #[inline]
        fn as_ref(&self) -> &[T] {
            self
        }
    }

    impl<T, const N: usize> fmt::Debug for HistoryBuffer<T, N>
    where
        T: fmt::Debug,
    {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            <[T] as fmt::Debug>::fmt(self, f)
        }
    }

    impl<T, const N: usize> Default for HistoryBuffer<T, N> {
        fn default() -> Self {
            Self::new()
        }
    }

    /// An iterator on the underlying buffer ordered from oldest data to newest
    #[derive(Clone)]
    pub struct OldestOrdered<'a, T, const N: usize> {
        buf: &'a HistoryBuffer<T, N>,
        cur: usize,
        wrapped: bool,
    }

    impl<'a, T, const N: usize> Iterator for OldestOrdered<'a, T, N> {
        type Item = &'a T;

        fn next(&mut self) -> Option<&'a T> {
            if self.cur == self.buf.len() && self.buf.filled {
                // roll-over
                self.cur = 0;
                self.wrapped = true;
            }

            if self.cur == self.buf.write_at && self.wrapped {
                return None;
            }

            let item = &self.buf[self.cur];
            self.cur += 1;
            Some(item)
        }
    }

    #[cfg(test)]
    mod tests {
        use crate::HistoryBuffer;
        use core::fmt::Debug;

        #[test]
        fn new() {
            let x: HistoryBuffer<u8, 4> = HistoryBuffer::new_with(1);
            assert_eq!(x.len(), 4);
            assert_eq!(x.as_slice(), [1; 4]);
            assert_eq!(*x, [1; 4]);

            let x: HistoryBuffer<u8, 4> = HistoryBuffer::new();
            assert_eq!(x.as_slice(), []);
        }

        #[test]
        fn write() {
            let mut x: HistoryBuffer<u8, 4> = HistoryBuffer::new();
            x.write(1);
            x.write(4);
            assert_eq!(x.as_slice(), [1, 4]);

            x.write(5);
            x.write(6);
            x.write(10);
            assert_eq!(x.as_slice(), [10, 4, 5, 6]);

            x.extend([11, 12].iter());
            assert_eq!(x.as_slice(), [10, 11, 12, 6]);
        }

        #[test]
        fn clear() {
            let mut x: HistoryBuffer<u8, 4> = HistoryBuffer::new_with(1);
            x.clear();
            assert_eq!(x.as_slice(), []);

            let mut x: HistoryBuffer<u8, 4> = HistoryBuffer::new();
            x.clear_with(1);
            assert_eq!(x.as_slice(), [1; 4]);
        }

        #[test]
        fn recent() {
            let mut x: HistoryBuffer<u8, 4> = HistoryBuffer::new();
            assert_eq!(x.recent(), None);

            x.write(1);
            x.write(4);
            assert_eq!(x.recent(), Some(&4));

            x.write(5);
            x.write(6);
            x.write(10);
            assert_eq!(x.recent(), Some(&10));
        }

        #[test]
        fn as_slice() {
            let mut x: HistoryBuffer<u8, 4> = HistoryBuffer::new();

            assert_eq!(x.as_slice(), []);

            x.extend([1, 2, 3, 4, 5].iter());

            assert_eq!(x.as_slice(), [5, 2, 3, 4]);
        }

        #[test]
        fn ordered() {
            // test on an empty buffer
            let buffer: HistoryBuffer<u8, 6> = HistoryBuffer::new();
            let mut iter = buffer.oldest_ordered();
            assert_eq!(iter.next(), None);
            assert_eq!(iter.next(), None);

            // test on a un-filled buffer
            let mut buffer: HistoryBuffer<u8, 6> = HistoryBuffer::new();
            buffer.extend([1, 2, 3]);
            assert_eq!(buffer.len(), 3);
            assert_eq_iter(buffer.oldest_ordered(), &[1, 2, 3]);

            // test on a filled buffer
            let mut buffer: HistoryBuffer<u8, 6> = HistoryBuffer::new();
            buffer.extend([0, 0, 0, 1, 2, 3, 4, 5, 6]);
            assert_eq!(buffer.len(), 6);
            assert_eq_iter(buffer.oldest_ordered(), &[1, 2, 3, 4, 5, 6]);

            // comprehensive test all cases
            for n in 0..50 {
                const N: usize = 7;
                let mut buffer: HistoryBuffer<u8, N> = HistoryBuffer::new();
                buffer.extend(0..n);
                assert_eq_iter(
                    buffer.oldest_ordered().copied(),
                    n.saturating_sub(N as u8)..n,
                );
            }
        }

        /// Compares two iterators item by item, making sure they stop at the same time.
        fn assert_eq_iter<I: Eq + Debug>(
            a: impl IntoIterator<Item = I>,
            b: impl IntoIterator<Item = I>,
        ) {
            let mut a = a.into_iter();
            let mut b = b.into_iter();

            let mut i = 0;
            loop {
                let a_item = a.next();
                let b_item = b.next();

                assert_eq!(a_item, b_item, "{}", i);

                i += 1;

                if b_item.is_none() {
                    break;
                }
            }
        }
    }