Struct UseMapHandle

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

State handle for the use_map hook.

Implementations

impl<K, V> UseMapHandle<K, V>

pub fn current(&self) -> Ref<'_, HashMap<K, V>>

Get immutable ref to the map.

Panics

Panics if the value is currently mutably borrowed

pub fn set(&self, map: HashMap<K, V>)

Set the hash map.

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

where K: Eq + Hash,

Inserts a key-value pair into the map.

pub fn update(&self, k: &K, v: V)

where K: Eq + Hash,

Update key-value pair.

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

where K: Eq + Hash,

Removes a key from the map, returning the value at the key if the key was previously in the map.

pub fn retain<F>(&self, f: F)

where K: Eq + Hash, F: FnMut(&K, &mut V) -> bool,

Retains only the elements specified by the predicate.

pub fn clear(&self)

Clears the map, removing all key-value pairs. Keeps the allocated memory for reuse.

Trait Implementations

impl<K, V> Clone for UseMapHandle<K, V>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K, V> PartialEq for UseMapHandle<K, V>

where K: Eq + Hash, V: PartialEq,

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.