Struct heapless::HistoryBuffer [−][src]
pub struct HistoryBuffer<T, const N: usize> { /* fields omitted */ }
Expand description
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);
Implementations
impl<T, const N: usize> HistoryBuffer<T, N>
[src]
impl<T, const N: usize> HistoryBuffer<T, N>
[src]impl<T, const N: usize> HistoryBuffer<T, N> where
T: Copy + Clone,
[src]
impl<T, const N: usize> HistoryBuffer<T, N> where
T: Copy + Clone,
[src]pub fn new_with(t: T) -> Self
[src]
pub fn new_with(t: T) -> Self
[src]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]);
pub fn clear_with(&mut self, t: T)
[src]
pub fn clear_with(&mut self, t: T)
[src]Clears the buffer, replacing every element with the given value.
impl<T, const N: usize> HistoryBuffer<T, N>
[src]
impl<T, const N: usize> HistoryBuffer<T, N>
[src]pub fn capacity(&self) -> usize
[src]
pub fn capacity(&self) -> usize
[src]Returns the capacity of the buffer, which is the length of the underlying backing array.
pub fn extend_from_slice(&mut self, other: &[T]) where
T: Clone,
[src]
pub fn extend_from_slice(&mut self, other: &[T]) where
T: Clone,
[src]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.
Trait Implementations
impl<T, const N: usize> AsRef<[T]> for HistoryBuffer<T, N>
[src]
impl<T, const N: usize> AsRef<[T]> for HistoryBuffer<T, N>
[src]impl<T, const N: usize> Debug for HistoryBuffer<T, N> where
T: Debug,
[src]
impl<T, const N: usize> Debug for HistoryBuffer<T, N> where
T: Debug,
[src]impl<T, const N: usize> Deref for HistoryBuffer<T, N>
[src]
impl<T, const N: usize> Deref for HistoryBuffer<T, N>
[src]impl<T, const N: usize> Drop for HistoryBuffer<T, N>
[src]
impl<T, const N: usize> Drop for HistoryBuffer<T, N>
[src]impl<'a, T, const N: usize> Extend<&'a T> for HistoryBuffer<T, N> where
T: 'a + Clone,
[src]
impl<'a, T, const N: usize> Extend<&'a T> for HistoryBuffer<T, N> where
T: 'a + Clone,
[src]fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = &'a T>,
[src]
fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = &'a T>,
[src]Extends a collection with the contents of an iterator. Read more
fn extend_one(&mut self, item: A)
[src]
fn extend_one(&mut self, item: A)
[src]extend_one
)Extends a collection with exactly one element.
fn extend_reserve(&mut self, additional: usize)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
impl<T, const N: usize> Extend<T> for HistoryBuffer<T, N>
[src]
impl<T, const N: usize> Extend<T> for HistoryBuffer<T, N>
[src]fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = T>,
[src]
fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = T>,
[src]Extends a collection with the contents of an iterator. Read more
fn extend_one(&mut self, item: A)
[src]
fn extend_one(&mut self, item: A)
[src]extend_one
)Extends a collection with exactly one element.
fn extend_reserve(&mut self, additional: usize)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
Auto Trait Implementations
impl<T, const N: usize> Send for HistoryBuffer<T, N> where
T: Send,
T: Send,
impl<T, const N: usize> Sync for HistoryBuffer<T, N> where
T: Sync,
T: Sync,
impl<T, const N: usize> Unpin for HistoryBuffer<T, N> where
T: Unpin,
T: Unpin,