Struct holyhashmap::HolyHashMap

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

Holy hash maps, Batman! – Robin

Implementations

impl<K, V, S> HolyHashMap<K, V, S>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn capacity(&self) -> usize

Maxium size before the map needs to reallocate. This is not the true capacity, but rather the max load of the map.

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

pub fn shrink_to_fit(&mut self)

pub fn iter(&self) -> Iter<'_, K, V>

pub fn iter_mut(&mut self) -> IterMut<'_, K, V>

pub fn keys(&self) -> Keys<'_, K, V>

pub fn values(&self) -> Values<'_, K, V>

pub fn indices(&self) -> Indices<'_, K, V>

pub fn values_mut(&mut self) -> ValuesMut<'_, K, V>

impl<K, V> HolyHashMap<K, V>

pub fn new() -> Self

pub fn with_capacity(capacity: usize) -> HolyHashMap<K, V, RandomState>

impl<K, V, S> HolyHashMap<K, V, S>where
    S: BuildHasher,

pub fn hasher(&self) -> &S

pub fn with_hasher(hash_builder: S) -> Self

pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> Self

impl<K, V, S> HolyHashMap<K, V, S>where
    K: Eq + Hash,
    S: BuildHasher,

pub fn to_index<Q>(&self, key: &Q) -> Option<EntryIndex>where
    K: Borrow<Q>,
    Q: Hash + Eq + ?Sized,

Gets the entry index of the key.

pub fn from_index(&self, index: EntryIndex) -> Option<(&K, &V)>

Gets the entry by index.

Returns None if the index is invalid (i.e., it is out of bounds or points to a deleted entry).

pub fn from_index_mut(&mut self, index: EntryIndex) -> Option<(&K, &mut V)>

Gets the mutable entry by index.

Returns None if the index is invalid (i.e., it is out of bounds or points to a deleted entry).

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

pub fn get<Q>(&self, key: &Q) -> Option<&V>where
    K: Borrow<Q>,
    Q: Hash + Eq + ?Sized,

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

pub fn insert_full(&mut self, key: K, value: V) -> (EntryIndex, Option<V>)

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

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

pub fn remove_index(&mut self, index: EntryIndex) -> Option<(K, V)>

Removes an entry by its index. Returns None if the index is invalid.

Note that this may not be any faster than calling remove or remove_entry. We must still calculate the hash of the key in order to remove the entry.

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

Trait Implementations

impl<K: Clone, V: Clone, S: Clone> Clone for HolyHashMap<K, V, S>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V, S> Debug for HolyHashMap<K, V, S>where
    K: Eq + Hash + Debug,
    V: Debug,
    S: BuildHasher,

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

Formats the value using the given formatter.

impl<K, V, S> Default for HolyHashMap<K, V, S>where
    S: BuildHasher + Default,

fn default() -> Self

Returns the “default value” for a type.

impl<'a, K, V, S> Extend<(&'a K, &'a V)> for HolyHashMap<K, V, S>where
    K: Eq + Hash + Copy,
    V: Copy,
    S: BuildHasher,

fn extend<I>(&mut self, iter: I)where
    I: IntoIterator<Item = (&'a K, &'a V)>,

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 HolyHashMap<K, V, S>where
    K: Eq + Hash,
    S: BuildHasher,

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

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> FromIterator<(K, V)> for HolyHashMap<K, V, S>where
    K: Eq + Hash,
    S: BuildHasher + Default,

fn from_iter<I>(iter: I) -> Selfwhere
    I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator.

impl<'a, K, Q, V, S> Index<&'a Q> for HolyHashMap<K, V, S>where
    K: Eq + Hash + Borrow<Q>,
    Q: Eq + Hash + ?Sized,
    S: BuildHasher,

type Output = V

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a, K, V, S> IntoIterator for &'a HolyHashMap<K, V, S>

type Item = (&'a K, &'a V)

The type of the elements being iterated over.

type IntoIter = Iter<'a, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V, S> IntoIterator for HolyHashMap<K, V, S>

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<K, V>

Creates an iterator from a value.

impl<K, V, S> PartialEq<HolyHashMap<K, V, S>> for HolyHashMap<K, V, S>where
    K: Eq + Hash,
    V: PartialEq,
    S: BuildHasher,

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<K, V, S> Eq for HolyHashMap<K, V, S>where
    K: Eq + Hash,
    V: Eq,
    S: BuildHasher,