Struct smallmap::Map

pub struct Map<TKey, TValue>(_);

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>

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 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 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: ?Sized>(&mut self, key: &Q) -> Option<&mut V> where
    K: Borrow<Q>,
    Q: Collapse + Eq, 

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

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

Search the map for entry corresponding to this key

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

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

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

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

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<TKey: Default, TValue: Default> Default for Map<TKey, TValue>

fn default() -> Map<TKey, TValue>

Returns the "default value" for a type.

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

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, 

Feeds a slice of this type into the given Hasher.

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

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) -> Self::IntoIter

Consume this map into an iterator over all currently inserted entries

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

fn eq(&self, other: &Map<TKey, TValue>) -> bool

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

fn ne(&self, other: &Map<TKey, TValue>) -> bool

This method tests for !=.

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

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