Struct HashMap

#[repr(transparent)]
pub struct HashMap<K, V>(HashMap<K, V>);

A wrapper around std::collections::HashMap that hides methods that expose unstable iteration order.

See the module documentation for a rationale.

Tuple Fields

0: HashMap<K, V>

Implementations

impl<K, V> HashMap<K, V>

pub fn new() -> Self

See std::collections::HashMap::new.

pub fn with_capacity(capacity: usize) -> Self

See std::collections::HashMap::with_capacity.

pub fn capacity(&self) -> usize

See std::collections::HashMap::capacity.

pub fn len(&self) -> usize

See std::collections::HashMap::len.

pub fn is_empty(&self) -> bool

See std::collections::HashMap::is_empty.

pub fn clear(&mut self)

See std::collections::HashMap::clear.

impl<K, V> HashMap<K, V>

where K: Eq + Hash,

pub fn reserve(&mut self, additional: usize)

See std::collections::HashMap::reserve.

pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>

See std::collections::HashMap::try_reserve.

pub fn shrink_to_fit(&mut self)

See std::collections::HashMap::shrink_to_fit.

pub fn shrink_to(&mut self, min_capacity: usize)

See std::collections::HashMap::shrink_to.

pub fn entry(&mut self, key: K) -> Entry<'_, K, V>

See std::collections::HashMap::entry.

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

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

See std::collections::HashMap::get.

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

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

See std::collections::HashMap::get_key_value.

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

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

See std::collections::HashMap::contains_key.

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

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

See std::collections::HashMap::get_mut.

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

See std::collections::HashMap::insert.

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

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

See std::collections::HashMap::remove.

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

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

See std::collections::HashMap::remove_entry.

Trait Implementations

impl<K, V> AssociativeExt<K, V> for HashMap<K, V>

where K: Eq + Hash + Debug, V: Debug,

fn expect_insert(&mut self, k: K, v: V, msg: &str)

Inserts a key and value, panicking with a given message if a true insert (as opposed to an update) cannot be done because the key already existed in the collection.

fn expect_remove(&mut self, k: &K, msg: &str) -> V

Removes a key, panicking with a given message if a true removal (as opposed to a no-op) cannot be done because the key does not exist in the collection.

fn unwrap_insert(&mut self, k: K, v: V)

Inserts a key and value, panicking if a true insert (as opposed to an update) cannot be done because the key already existed in the collection.

fn unwrap_remove(&mut self, k: &K) -> V

Removes a key, panicking if a true removal (as opposed to a no-op) cannot be done because the key does not exist in the collection.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<K: Default, V: Default> Default for HashMap<K, V>

fn default() -> HashMap<K, V>

Returns the “default value” for a type.

impl<'a, K, V> Extend<(&'a K, &'a V)> for HashMap<K, V>

where K: Eq + Hash + Copy, V: Copy,

fn extend<T: IntoIterator<Item = (&'a K, &'a 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> Extend<(K, V)> for HashMap<K, V>

where K: Eq + Hash,

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, const N: usize> From<[(K, V); N]> for HashMap<K, V>

where K: Eq + Hash,

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

Converts to this type from the input type.

impl<K, V> From<HashMap<K, V>> for HashMap<K, V>

where K: Eq + Hash,

fn from(map: StdMap<K, V>) -> Self

Converts to this type from the input type.

impl<K, V> FromIterator<(K, V)> for HashMap<K, V>

where K: Eq + Hash,

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

Creates a value from an iterator.

impl<K, Q, V> Index<&Q> for HashMap<K, V>

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

type Output = V

The returned type after indexing.

fn index(&self, key: &Q) -> &V

Performs the indexing (container[index]) operation.

impl<K, V> PartialEq for HashMap<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.

impl<K, V> Eq for HashMap<K, V>

where K: Eq + Hash, V: Eq,