Struct smallmap::Map

source · [−]

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

Expand description

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

Implementations

source

impl<K, V> Map<K, V> where
K: Collapse,

source

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

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

source

pub fn clean(&mut self)

Remove all empty pages from this instance.

source

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.

source

pub fn is_empty(&self) -> bool

Is this map empty

source

pub fn num_pages(&self) -> usize

The number of pages currently in this map

source

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

Consume the instance, returning all pages.

source

pub fn pages(&self) -> Pages<'_, K, V>ⓘNotable traits for Pages<'a, K, V>`impl<'a, K, V> Iterator for Pages<'a, K, V> type Item = &'a Page<K, V>;`

An iterator over all pages

source

pub fn pages_mut(&mut self) -> PagesMut<'_, K, V>ⓘNotable traits for PagesMut<'a, K, V>`impl<'a, K, V> Iterator for PagesMut<'a, K, V> type Item = &'a mut Page<K, V>;`

A mutable iterator over all pages

source

pub fn iter(&self) -> Iter<'_, K, V>ⓘNotable traits for Iter<'a, K, V>`impl<'a, K, V> Iterator for Iter<'a, K, V> where K: Collapse, type Item = &'a (K, V);`

An iterator over all elements in the map

source

pub fn iter_mut(&mut self) -> IterMut<'_, K, V>ⓘNotable traits for IterMut<'a, K, V>`impl<'a, K, V> Iterator for IterMut<'a, K, V> where K: Collapse, type Item = &'a mut (K, V);`

A mutable iterator over all elements in the map

source

pub fn new() -> Self

Create a new empty Map

source

pub fn with_capacity(pages: usize) -> Self

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

source

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.

source

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

source

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.

source

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

source

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

source

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

Consume this Map by swapping its keys and values around.

Trait Implementations

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

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

Returns the “default value” for a type. Read more

source

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

source

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

Extends a collection with the contents of an iterator. Read more

source

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

source

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. Read more

source

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

source

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

Creates a value from an iterator. Read more

source

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

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

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

source

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?

source

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

source

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

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

source

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

This method tests for !=.

source

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

source

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

source

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

Auto Trait Implementations

impl<TKey, TValue> RefUnwindSafe for Map<TKey, TValue> where
TKey: RefUnwindSafe,
TValue: RefUnwindSafe,

impl<TKey, TValue> Send for Map<TKey, TValue> where
TKey: Send,
TValue: Send,

impl<TKey, TValue> Sync for Map<TKey, TValue> where
TKey: Sync,
TValue: Sync,

impl<TKey, TValue> Unpin for Map<TKey, TValue> where
TKey: Unpin,
TValue: Unpin,

impl<TKey, TValue> UnwindSafe for Map<TKey, TValue> where
TKey: UnwindSafe,
TValue: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> Collapse for T where
T: Hash + Eq,

source

fn collapse(&self) -> u8

Create the index key for this instance. This is similar in use to Hash::hash().

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct smallmap::Map

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)

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn num_pages(&self) -> usize

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

pub fn pages(&self) -> Pages<'_, K, V>ⓘNotable traits for Pages<'a, K, V>impl<'a, K, V> Iterator for Pages<'a, K, V> type Item = &'a Page<K, V>;

pub fn pages_mut(&mut self) -> PagesMut<'_, K, V>ⓘNotable traits for PagesMut<'a, K, V>impl<'a, K, V> Iterator for PagesMut<'a, K, V> type Item = &'a mut Page<K, V>;

pub fn iter(&self) -> Iter<'_, K, V>ⓘNotable traits for Iter<'a, K, V>impl<'a, K, V> Iterator for Iter<'a, K, V> where K: Collapse, type Item = &'a (K, V);

pub fn iter_mut(&mut self) -> IterMut<'_, K, V>ⓘNotable traits for IterMut<'a, K, V>impl<'a, K, V> Iterator for IterMut<'a, K, V> where K: Collapse, type Item = &'a mut (K, V);

pub fn new() -> Self

pub fn with_capacity(pages: usize) -> Self

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

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

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

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

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

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

Trait Implementations

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

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

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

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

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

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

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

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

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

fn extend_one(&mut self, item: A)

fn extend_reserve(&mut self, additional: usize)

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

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

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

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

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

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

fn into_iter(self) -> Self::IntoIter

type Item = (K, V)

type IntoIter = IntoIter<K, V>

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

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

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

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

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

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

Auto Trait Implementations

impl<TKey, TValue> RefUnwindSafe for Map<TKey, TValue> where TKey: RefUnwindSafe, TValue: RefUnwindSafe,

impl<TKey, TValue> Send for Map<TKey, TValue> where TKey: Send, TValue: Send,

impl<TKey, TValue> Sync for Map<TKey, TValue> where TKey: Sync, TValue: Sync,

impl<TKey, TValue> Unpin for Map<TKey, TValue> where TKey: Unpin, TValue: Unpin,

impl<TKey, TValue> UnwindSafe for Map<TKey, TValue> where TKey: UnwindSafe, TValue: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Collapse for T where T: Hash + Eq,

fn collapse(&self) -> u8

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<K, V> Map<K, V> where
K: Collapse,

pub fn pages(&self) -> Pages<'_, K, V>ⓘNotable traits for Pages<'a, K, V>`impl<'a, K, V> Iterator for Pages<'a, K, V> type Item = &'a Page<K, V>;`

pub fn pages_mut(&mut self) -> PagesMut<'_, K, V>ⓘNotable traits for PagesMut<'a, K, V>`impl<'a, K, V> Iterator for PagesMut<'a, K, V> type Item = &'a mut Page<K, V>;`

pub fn iter(&self) -> Iter<'_, K, V>ⓘNotable traits for Iter<'a, K, V>`impl<'a, K, V> Iterator for Iter<'a, K, V> where K: Collapse, type Item = &'a (K, V);`

pub fn iter_mut(&mut self) -> IterMut<'_, K, V>ⓘNotable traits for IterMut<'a, K, V>`impl<'a, K, V> Iterator for IterMut<'a, K, V> where K: Collapse, type Item = &'a mut (K, V);`

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

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

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

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

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

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

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

impl<TKey, TValue> RefUnwindSafe for Map<TKey, TValue> where
TKey: RefUnwindSafe,
TValue: RefUnwindSafe,

impl<TKey, TValue> Send for Map<TKey, TValue> where
TKey: Send,
TValue: Send,

impl<TKey, TValue> Sync for Map<TKey, TValue> where
TKey: Sync,
TValue: Sync,

impl<TKey, TValue> Unpin for Map<TKey, TValue> where
TKey: Unpin,
TValue: Unpin,

impl<TKey, TValue> UnwindSafe for Map<TKey, TValue> where
TKey: UnwindSafe,
TValue: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Collapse for T where
T: Hash + Eq,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,