Struct Map

pub struct Map<TKey, TValue>(/* private fields */);

A small hashtable-like map with byte sized key indecies.

Implementations

impl<K, V> Map<K, V>

where K: Collapse,

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

Get an Entry for the key that lets you get or insert the value

pub fn clean(&mut self)

Remove all empty pages from this instance.

pub fn len(&self) -> usize

The number of entries currently in this map

This is an iterating count over all slots in all current pages, if possible store it in a temporary instead of re-calling it.

pub fn is_empty(&self) -> bool

Is this map empty

pub fn num_pages(&self) -> usize

The number of pages currently in this map

pub fn into_pages(self) -> Vec<Page<K, V>>

Consume the instance, returning all pages.

pub fn pages(&self) -> Pages<'_, K, V>

An iterator over all pages

pub fn pages_mut(&mut self) -> PagesMut<'_, K, V>

A mutable iterator over all pages

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

An iterator over all elements in the map

pub fn keys(&self) -> impl Iterator<Item = &K>

An iterator over all the keys in the map

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

An iterator over all the values in the map

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

A mutable iterator over all the values in the map

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

A mutable iterator over all elements in the map

pub fn new() -> Self

Create a new empty Map

pub fn with_capacity(pages: usize) -> Self

Create a new empty Map with a specific number of pages pre-allocated

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

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

Get a mutable reference of the value corresponding to this key if it is in the map.

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

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

Search the map for entry corresponding to this key

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

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

Get a reference of the value corresponding to this key if it is in the map.

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

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

Remove the entry corresponding to this key in the map, returning the value if it was present

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

Insert a new key-value entry into this map, returning the pervious value if it was present

pub fn reverse(self) -> Map<V, K>

where V: Collapse,

Consume this Map by swapping its keys and values around.

Trait Implementations

impl<TKey: Clone, TValue: Clone> Clone for Map<TKey, TValue>

fn clone(&self) -> Map<TKey, TValue>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TKey: Debug, TValue: Debug> Debug for Map<TKey, TValue>

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

Formats the value using the given formatter.

impl<K: Collapse, V> Default for Map<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<K: Collapse, V> Extend<(K, V)> for Map<K, V>

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: Collapse, V> FromIterator<(K, V)> for Map<K, V>

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

Creates a value from an iterator.

impl<TKey: Hash, TValue: Hash> Hash for Map<TKey, TValue>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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

type Output = V

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<K, Q, V> IndexMut<&Q> for Map<K, V>

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

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

Performs the mutable indexing (container[index]) operation.

impl<K: Collapse, V> IntoIterator for Map<K, V>

fn into_iter(self) -> Self::IntoIter

Consume this map into an iterator over all currently inserted entries

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?

impl<TKey: PartialEq, TValue: PartialEq> PartialEq for Map<TKey, TValue>

fn eq(&self, other: &Map<TKey, TValue>) -> 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<TKey: Eq, TValue: Eq> Eq for Map<TKey, TValue>

impl<TKey, TValue> StructuralPartialEq for Map<TKey, TValue>