Struct sliding_window::SlidingWindow

pub struct SlidingWindow<IT, N> where
    N: Size<IT>,  { /* fields omitted */ }

A sliding window.

Sliding windows are queues that overwrite their oldest data when full.

Implementations

impl<IT, N> SlidingWindow<IT, N> where
    N: Size<IT>, 

pub fn new() -> Self

Returns an empty sliding window object.

pub fn insert(&mut self, t: IT) -> Option<IT>

Insert an element into the window.

If the window is full, this method will remove and return the oldest element.

pub fn clear(&mut self)

Removes all elements from the window.

pub fn is_full(&self) -> bool

Returns true if the window is full.

pub fn count(&self) -> usize

Returns the number of elements stored in the window.

pub fn iter(&self) -> Iter<IT, N>

Returns an iterator to read from the window.

The iterator starts at the oldest element and ends with the newest.

pub fn iter_unordered(&self) -> UnorderedIter<IT, N>

Returns an iterator to read from the window.

This iterator starts at the beginning of the internal array instead of the oldest element so it does not return the elements in the order of insertion.

Trait Implementations

impl<IT, N> Default for SlidingWindow<IT, N> where
    N: Size<IT>, 

fn default() -> Self

Returns the "default value" for a type.

impl<IT, N> Index<usize> for SlidingWindow<IT, N> where
    N: Size<IT>, 

type Output = IT

The returned type after indexing.

fn index(&self, idx: usize) -> &Self::Output

Performs the indexing (container[index]) operation.