Struct phreak_engine::datastructs::lifespanlist::LifespanList

pub struct LifespanList<T, U> where
    T: PartialEq + Copy,
    U: PartialOrd + PartialEq + Copy,  { /* fields omitted */ }

A list of items with a lifespan, which supports views at a given time.

A lifespan can be in the form of a start time and optional end time, but it can also be implemented using a monotonic increasing counter, where each moment in time is represented by a simple number, like a u64. Using an u64, you can generate a unique number at 1GHz for 600 years before you exhaust the number space.

Methods

impl<T, U> LifespanList<T, U> where
    T: PartialEq + Copy,
    U: PartialOrd + PartialEq + Copy, 

pub fn new() -> Self

Create an empty list

pub fn with_capacity(capacity: usize) -> Self

Create an empty list and reserve capacity

pub fn push_front(&mut self, begin: U, value: T)

Put an item at the front of the list, which is valid starting from 'begin'

pub fn push_back(&mut self, begin: U, value: T)

Put an item at the back of the list, which is valid starting from 'begin'

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

Take an item at the front of the list

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

Put an item at the back of the list

pub fn len(&self) -> usize

Returns the total count of stored items

pub fn contains(&self, time: U, value: &T) -> bool

pub fn clear(&mut self)

pub fn cleanup(&mut self)

Removes the items with an end time, leaving only the items which remain active at this point

pub fn iter(&self) -> Iter<Bucket<T, U>>

Iterator over all items in the list

pub fn iter_mut(&mut self) -> IterMut<Bucket<T, U>>

Mutable Iterator over all items in the list

pub fn iter_before(&self, time: U) -> IterBefore<T, U>

Returns an iterator over the set at the time just before timestamp

pub fn iter_before_mut(&mut self, time: U) -> IterBeforeMut<T, U>

Returns a mutable iterator over the set at the time just before timestamp

pub fn iter_at(&self, time: U) -> IterAt<T, U>

Returns an iterator over the set at the given timestamp

pub fn iter_at_mut(&mut self, time: U) -> IterAtMut<T, U>

Returns a mutable iterator over the set at the time just before timestamp

pub fn remove(&mut self, time: U, value: &T)

Trait Implementations

impl<T: Debug, U: Debug> Debug for LifespanList<T, U> where
    T: PartialEq + Copy,
    U: PartialOrd + PartialEq + Copy, 

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

Formats the value using the given formatter.

impl<T, U> Default for LifespanList<T, U> where
    T: PartialEq + Copy,
    U: PartialOrd + PartialEq + Copy, 

fn default() -> Self

Returns the "default value" for a type.

impl<'de, T, U> Deserialize<'de> for LifespanList<T, U> where
    T: PartialEq + Copy,
    U: PartialOrd + PartialEq + Copy,
    T: Deserialize<'de>,
    U: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T, U> Index<usize> for LifespanList<T, U> where
    T: PartialEq + Copy,
    U: PartialOrd + PartialEq + Copy, 

type Output = Bucket<T, U>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, U> IndexMut<usize> for LifespanList<T, U> where
    T: PartialEq + Copy,
    U: PartialOrd + PartialEq + Copy, 

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

Performs the mutable indexing (container[index]) operation.

impl<T, U> Serialize for LifespanList<T, U> where
    T: PartialEq + Copy,
    U: PartialOrd + PartialEq + Copy,
    T: Serialize,
    U: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.