Struct KeyWaitMap

pub struct KeyWaitMap<K, V> { /* private fields */ }

A future-based concurrent event map with wait API.

Implementations

impl<K, V> KeyWaitMap<K, V>

where K: Eq + Hash + Unpin,

pub fn new() -> Self

pub fn insert(&self, k: K, v: V) -> Option<V>

Inserts a event-value pair into the map.

If the map did not have this key present, None is returned.

pub fn batch_insert<I>(&self, kv: I)

where I: IntoIterator<Item = (K, V)>, K: Debug,

Inserts a event-value pair into the map.

If the map did not have this key present, None is returned.

pub async fn wait<L>(&self, k: &K, locker: L) -> Option<V>

where K: Clone, L: Unpin,

Create a key waiting task until a value is put under the key, only one waiting task for a key can exist at a time.

Returns the value at the key if the key was inserted into the map, or returns None if the waiting task is canceled.

pub fn cancel<Q>(&self, k: &Q) -> bool

where K: Borrow<Q>, Q: Hash + Eq,

Cancel other key waiting tasks.

pub fn cancel_all(&self)

Cancel all key waiting tasks.

Trait Implementations

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

fn default() -> Self

Returns the “default value” for a type.