Struct hydroflow::util::monotonic_map::MonotonicMap

pub struct MonotonicMap<K, V>
where
    K: PartialOrd,
{ /* private fields */ }

A map-like interface which in reality only stores one value at a time.

The keys must be monotonically increasing (i.e. timestamps). For Hydroflow, this allows state to be stored which resets each tick by using the tick counter as the key. In the generic Map case it can be swapped out for a true map to allow processing of multiple ticks of data at once.

Implementations

impl<K, V> MonotonicMap<K, V>

where K: PartialOrd,

pub fn new_init(val: V) -> Self

Creates a new MonotonicMap initialized with the given value. The vaue will be Cleared before it is accessed.

pub fn get_mut_with(&mut self, key: K, init: impl FnOnce() -> V) -> &mut V

Inserts the value using the function if new key is strictly later than the current key.

impl<K, V> MonotonicMap<K, V>

where K: PartialOrd, V: Default,

pub fn get_mut_default(&mut self, key: K) -> &mut V

Gets a mutable reference to the inner value. If key is strictly later than the existing key, the value will be reset to Default::default.

impl<K, V> MonotonicMap<K, V>

where K: PartialOrd, V: Clear,

pub fn get_mut_clear(&mut self, key: K) -> &mut V

Gets a mutable reference to the inner value. If key is strictly later than the existing key, the value will be cleared via the Clear trait.

Trait Implementations

impl<K, V: Clone> Clone for MonotonicMap<K, V>

where K: PartialOrd + Clone,

fn clone(&self) -> MonotonicMap<K, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V: Debug> Debug for MonotonicMap<K, V>

where K: PartialOrd + Debug,

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

Formats the value using the given formatter.

impl<K, V> Default for MonotonicMap<K, V>

where K: PartialOrd, V: Default,

fn default() -> Self

Returns the “default value” for a type.