Struct miri::MonoHashMap

pub struct MonoHashMap<K: Hash + Eq, V>(RefCell<FxHashMap<K, Box<V>>>);

Tuple Fields

0: RefCell<FxHashMap<K, Box<V>>>

Implementations

impl<K: Hash + Eq, V> MonoHashMap<K, V>

pub fn iter<T>(
    &self,
    f: impl FnOnce(&mut dyn Iterator<Item = (&K, &V)>) -> T
) -> T

This function exists for priroda to be able to iterate over all evaluator memory.

The function is somewhat roundabout with the closure argument because internally the MonoHashMap uses a RefCell. When iterating over the FxHashMap inside the RefCell, we need to keep a borrow to the FxHashMap inside the iterator. The borrow is only alive as long as the Ref returned by RefCell::borrow() is alive. So we can’t return the iterator, as that would drop the Ref. We can’t return both, as it’s not possible in Rust to have a struct/tuple with a field that refers to another field.

Trait Implementations

impl<K: Hash + Eq, V> AllocMap<K, V> for MonoHashMap<K, V>

fn get_or<E>(&self, k: K, vacant: impl FnOnce() -> Result<V, E>) -> Result<&V, E>

The most interesting method: Providing a shared reference without holding the RefCell open, and inserting new data if the key is not used yet. vacant is called if the key is not found in the map; if it returns a reference, that is used directly, if it returns owned data, that is put into the map and returned.

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

Read-only lookup (avoid read-acquiring the RefCell).

fn contains_key<Q: ?Sized + Hash + Eq>(&mut self, k: &Q) -> boolwhere
    K: Borrow<Q>,

Tests if the map contains the given key. Deliberately takes &mut because that is sufficient, and some implementations can be more efficient then (using RefCell::get_mut).

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

Inserts a new entry into the map.

fn remove<Q: ?Sized + Hash + Eq>(&mut self, k: &Q) -> Option<V>where
    K: Borrow<Q>,

Removes an entry from the map.

fn filter_map_collect<T>(&self, f: impl FnMut(&K, &V) -> Option<T>) -> Vec<T>

Returns data based on the keys and values in the map.

fn get_mut_or<E>(
    &mut self,
    k: K,
    vacant: impl FnOnce() -> Result<V, E>
) -> Result<&mut V, E>

Returns a mutable reference to entry k. If no such entry exists, call vacant and either forward its error, or add its result to the map and return a reference to that.

fn get_mut(&mut self, k: K) -> Option<&mut V>

Mutable lookup.

impl<K: Clone + Hash + Eq, V: Clone> Clone for MonoHashMap<K, V>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Hash + Eq, V: Debug> Debug for MonoHashMap<K, V>

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

Formats the value using the given formatter.

impl<K: Hash + Eq, V> Default for MonoHashMap<K, V>

fn default() -> Self

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size: 40 bytes