Skip to main content

RingBuffer

Struct RingBuffer 

Source
pub struct RingBuffer<T> { /* private fields */ }
Expand description

Ring buffer for time-series data.

Implements the ttop pattern for efficient sliding window storage. Oldest values are evicted when capacity is reached.

§Example

use probar::brick::tui::RingBuffer;

let mut buf: RingBuffer<f32> = RingBuffer::new(60);
for i in 0..100 {
    buf.push(i as f32);
}
assert_eq!(buf.len(), 60);
assert_eq!(*buf.last().unwrap(), 99.0);

Implementations§

Source§

impl<T> RingBuffer<T>

Source

pub fn new(capacity: usize) -> Self

Create a new ring buffer with given capacity.

Source

pub fn push(&mut self, value: T)

Push a value, evicting oldest if at capacity.

Source

pub fn iter(&self) -> impl Iterator<Item = &T>

Get iterator over values (oldest first).

Source

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T>

Get mutable iterator over values.

Source

pub fn len(&self) -> usize

Get number of elements.

Source

pub fn is_empty(&self) -> bool

Check if buffer is empty.

Source

pub fn capacity(&self) -> usize

Get capacity.

Source

pub fn last(&self) -> Option<&T>

Get most recent value.

Source

pub fn first(&self) -> Option<&T>

Get oldest value.

Source

pub fn get(&self, index: usize) -> Option<&T>

Get value at index (0 = oldest).

Source

pub fn clear(&mut self)

Clear the buffer.

Source

pub fn is_full(&self) -> bool

Check if buffer is at capacity.

Source§

impl<T: Clone> RingBuffer<T>

Source

pub fn to_vec(&self) -> Vec<T>

Make buffer contiguous and return as Vec.

Source§

impl<T: Copy + Default> RingBuffer<T>

Source

pub fn fill_default(&mut self)

Fill with default values to capacity.

Source§

impl<T: Copy + Into<f64>> RingBuffer<T>

Source

pub fn average(&self) -> f64

Calculate average of all values.

Source

pub fn min(&self) -> Option<f64>

Calculate min value.

Source

pub fn max(&self) -> Option<f64>

Calculate max value.

Trait Implementations§

Source§

impl<T: Clone> Clone for RingBuffer<T>

Source§

fn clone(&self) -> RingBuffer<T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for RingBuffer<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for RingBuffer<T>

§

impl<T> RefUnwindSafe for RingBuffer<T>
where T: RefUnwindSafe,

§

impl<T> Send for RingBuffer<T>
where T: Send,

§

impl<T> Sync for RingBuffer<T>
where T: Sync,

§

impl<T> Unpin for RingBuffer<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for RingBuffer<T>

§

impl<T> UnwindSafe for RingBuffer<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.