Struct OnceMap

pub struct OnceMap<K, V, S = RandomState> { /* private fields */ }

Implementations

impl<K, V> OnceMap<K, V>

pub fn new() -> Self

Creates an empty OnceMap.

impl<K, V, S> OnceMap<K, V, S>

pub fn with_hasher(hash_builder: S) -> Self

Creates an empty OnceMap which will use the given hash builder to hash keys.

impl<K, V, S> OnceMap<K, V, S>

pub fn clear(&mut self)

Removes all key-value pairs from the map, but keeps the allocated memory.

pub fn values_mut(&mut self) -> impl Iterator<Item = &mut V>

pub fn iter_mut(&mut self) -> impl Iterator<Item = (&K, &mut V)>

pub fn into_iter(self) -> impl Iterator<Item = (K, V)>

pub fn hasher(&self) -> &S

Returns a reference to the map’s BuildHasher.

pub fn read_only_view(&self) -> ReadOnlyView<'_, K, V, S>

Locks the whole map for reading.

This enables more methods, such as iterating on the maps, but will cause a deadlock if trying to insert values in the map from the same thread.

impl<K, V, S> OnceMap<K, V, S>

where K: Send, V: Send,

pub fn into_par_iter(self) -> impl ParallelIterator<Item = (K, V)>

Available on crate feature rayon only.

impl<K, V, S> OnceMap<K, V, S>

where K: Eq + Hash, S: BuildHasher,

pub fn contains_key<Q>(&self, key: &Q) -> bool

where Q: Hash + Equivalent<K> + ?Sized,

Returns true if the map contains a value for the specified key.

pub fn remove<Q>(&mut self, key: &Q) -> Option<V>

where Q: Hash + Equivalent<K> + ?Sized,

pub fn remove_entry<Q>(&mut self, key: &Q) -> Option<(K, V)>

where Q: Hash + Equivalent<K> + ?Sized,

impl<K, V, S> OnceMap<K, V, S>

where K: Eq + Hash, S: BuildHasher, V: StableDeref,

pub fn get<Q>(&self, key: &Q) -> Option<&V::Target>

where Q: Hash + Equivalent<K> + ?Sized,

Returns a reference to the value corresponding to the key.

pub fn insert(&self, key: K, make_val: impl FnOnce(&K) -> V) -> &V::Target

Returns a reference to the value corresponding to the key or insert one with the given closure.

pub fn try_insert<E>( &self, key: K, make_val: impl FnOnce(&K) -> Result<V, E>, ) -> Result<&V::Target, E>

Same as insert but the closure is allowed to fail.

If the closure is called and an error is returned, no value is stored in the map.

impl<K, V, S> OnceMap<K, V, S>

where K: Eq + Hash, S: BuildHasher, V: Clone,

pub fn get_cloned<Q>(&self, key: &Q) -> Option<V>

where Q: Hash + Equivalent<K> + ?Sized,

pub fn insert_cloned(&self, key: K, make_val: impl FnOnce(&K) -> V) -> V

pub fn try_insert_cloned<E>( &self, key: K, make_val: impl FnOnce(&K) -> Result<V, E>, ) -> Result<V, E>

impl<K, V, S> OnceMap<K, V, S>

where K: Eq + Hash, S: BuildHasher,

pub fn map_get<Q, T>( &self, key: &Q, with_result: impl FnOnce(&K, &V) -> T, ) -> Option<T>

where Q: Hash + Equivalent<K> + ?Sized,

pub fn map_insert<T>( &self, key: K, make_val: impl FnOnce(&K) -> V, with_result: impl FnOnce(&K, &V) -> T, ) -> T

pub fn map_insert_ref<Q, T>( &self, key: &Q, make_key: impl FnOnce(&Q) -> K, make_val: impl FnOnce(&K) -> V, with_result: impl FnOnce(&K, &V) -> T, ) -> T

where Q: Hash + Equivalent<K> + ?Sized,

pub fn map_try_insert<T, E>( &self, key: K, make_val: impl FnOnce(&K) -> Result<V, E>, with_result: impl FnOnce(&K, &V) -> T, ) -> Result<T, E>

pub fn map_try_insert_ref<Q, T, E>( &self, key: &Q, make_key: impl FnOnce(&Q) -> K, make_val: impl FnOnce(&K) -> Result<V, E>, with_result: impl FnOnce(&K, &V) -> T, ) -> Result<T, E>

where Q: Hash + Equivalent<K> + ?Sized,

pub fn get_or_try_insert<T, U, E>( &self, key: K, data: T, on_vacant: impl FnOnce(T, &K) -> Result<(V, U), E>, on_occupied: impl FnOnce(T, &K, &V) -> U, ) -> Result<U, E>

pub fn get_or_try_insert_ref<Q, T, U, E>( &self, key: &Q, data: T, make_key: impl FnOnce(&Q) -> K, on_vacant: impl FnOnce(T, &K) -> Result<(V, U), E>, on_occupied: impl FnOnce(T, &K, &V) -> U, ) -> Result<U, E>

where Q: Hash + Equivalent<K> + ?Sized,

Trait Implementations

impl<K, V, S> Debug for OnceMap<K, V, S>

where K: Debug, V: Debug,

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

Formats the value using the given formatter.

impl<K, V, S: Default> Default for OnceMap<K, V, S>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K, V, S> Deserialize<'de> for OnceMap<K, V, S>

where K: Eq + Hash + Deserialize<'de>, V: Deserialize<'de>, S: BuildHasher + Default,

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K, V, S> Extend<(K, V)> for &OnceMap<K, V, S>

where K: Eq + Hash, S: BuildHasher,

fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<K, V, S> Extend<(K, V)> for OnceMap<K, V, S>

where K: Eq + Hash, S: BuildHasher,

fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<K, V, S, const N: usize> From<[(K, V); N]> for OnceMap<K, V, S>

where K: Eq + Hash, S: BuildHasher + Default,

fn from(array: [(K, V); N]) -> Self

Converts to this type from the input type.

impl<K, V, S> FromIterator<(K, V)> for OnceMap<K, V, S>

where K: Eq + Hash, S: BuildHasher + Default,

fn from_iter<T: IntoIterator<Item = (K, V)>>(iter: T) -> Self

Creates a value from an iterator.

impl<K, V, S> FromParallelIterator<(K, V)> for OnceMap<K, V, S>

where K: Eq + Hash + Send + Sync, V: Send + Sync, S: BuildHasher + Default + Sync,

Available on crate feature rayon only.

fn from_par_iter<I>(par_iter: I) -> Self

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

Creates an instance of the collection from the parallel iterator par_iter.

impl<K, V, S> ParallelExtend<(K, V)> for &OnceMap<K, V, S>

where K: Eq + Hash + Send + Sync, V: Send + Sync, S: BuildHasher + Sync,

Available on crate feature rayon only.

fn par_extend<I>(&mut self, par_iter: I)

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

Extends an instance of the collection with the elements drawn from the parallel iterator par_iter.

impl<K, V, S> ParallelExtend<(K, V)> for OnceMap<K, V, S>

where K: Eq + Hash + Send + Sync, V: Send + Sync, S: BuildHasher + Sync,

Available on crate feature rayon only.

fn par_extend<I>(&mut self, par_iter: I)

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

Extends an instance of the collection with the elements drawn from the parallel iterator par_iter.

impl<K, V, S> Serialize for OnceMap<K, V, S>

where K: Serialize, V: Serialize,

Available on crate feature serde only.

fn serialize<Ser>(&self, serializer: Ser) -> Result<Ser::Ok, Ser::Error>

where Ser: Serializer,

Serialize this value into the given Serde serializer.