Struct eggtimer::TimedList

pub struct TimedList<T> { /* fields omitted */ }

An iterable list structure where each element has an associated Duration.

When an element's Duration has elapsed, the element is removed from the list upon the next mutable function call. Timed-out elements will never be iterated over.

Implementations

impl<T> TimedList<T>

pub fn new() -> TimedList<T>

Creates a new TimedList

pub fn insert<D: ToDuration>(&mut self, element: T, time: D)

Inserts an element into the list with the given number of floating-point seconds

pub fn clean(&mut self)

Forces the removal of all elements whose Duration has elpased. This method does not need to be called manually unless you want to explicitely free the memory of timed-out elements immediately.

pub fn clear(&mut self)

Removes all elements from the list

pub fn len(&self) -> usize

Gets the number of elements in the list that have not timed out.

pub fn is_empty(&self) -> bool

Check if the list is empty or if all existing elements have timed out.

pub fn retain<F>(&mut self, f: F) where
    F: FnMut(&T) -> bool, 

Retains elements in the list that match the predicate

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

Iterates immutably through all elements.

While this method does not remove timed-out elements, it does filter them out. If iteration takes sufficiently long, elements that may have been valid when iteration began may be skipped when they are actually iterated over.

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

Iterates mutably through all elements.

If iteration takes sufficiently long, elements that may have been valid when iteration began may be skipped when they are actually iterated over.

pub fn timer_iter(&self) -> impl DoubleEndedIterator<Item = (&T, EggTimer)>

Iterates immutably through all elements and their timers.

While this method does not remove timed-out elements, it does filter them out. If iteration takes sufficiently long, elements that may have been valid when iteration began may be skipped when they are actually iterated over.

pub fn timer_iter_mut(
    &mut self
) -> impl DoubleEndedIterator<Item = (&mut T, EggTimer)>

Iterates mutably through all elements.

If iteration takes sufficiently long, elements that may have been valid when iteration began may be skipped when they are actually iterated over.

Trait Implementations

impl<T: Clone> Clone for TimedList<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for TimedList<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for TimedList<T>

fn default() -> TimedList<T>

Returns the "default value" for a type.

impl<T, D> FromIterator<(T, D)> for TimedList<T> where
    D: ToDuration, 

fn from_iter<I: IntoIterator<Item = (T, D)>>(iter: I) -> Self

Creates a value from an iterator.

impl<T> IntoIterator for TimedList<T> where
    T: 'static, 

type Item = T

The type of the elements being iterated over.

type IntoIter = Box<dyn DoubleEndedIterator<Item = T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq<TimedList<T>> for TimedList<T>

fn eq(&self, other: &TimedList<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TimedList<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<TimedList<T>> for TimedList<T>

fn partial_cmp(&self, other: &TimedList<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &TimedList<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &TimedList<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &TimedList<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &TimedList<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> StructuralPartialEq for TimedList<T>