Struct Window

pub struct Window<T> { /* private fields */ }

The Window struct is used internally and is of interest primarily to developers creating a new statistics type.

A Window instance maintains a set of items of type T. The set size is limited to a configurable parameter. The oldest item is dropped when a new item is entered and the window is full.

Implementations

impl<T> Window<T>

pub fn new(size_limit: usize, live_limit: usize) -> Window<T>

Constructs a new window instance.

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

Adds a new entry to the window.

pub fn is_empty(&self) -> bool

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

Returns a pointer to the newest item, if there is one.

pub fn newest_mut(&mut self) -> Option<&mut T>

Returns a mutable reference to the current instance.

pub fn all_len(&self) -> usize

Returns the number of elements in the set.

pub fn live_len(&self) -> usize

Returns the number of live elements.

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

Returns a pointer to a given element in the window. The array is indexed with element zero being the oldest.

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

Returns a pointer to a live element. The items are ordered by age wth the oldest at index 0.

pub fn clear(&mut self)

Deletes all data from the window. This puts it back into its initial state.

pub fn iter_all(&self) -> WindowIterator<'_, T>

Iterates over all the items in the window.

pub fn iter_live(&self) -> WindowIterator<'_, T>

Iterates over all the live items in the window.

Trait Implementations

impl<T: Clone> Clone for Window<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.