Struct toolshed::map::BloomMap

pub struct BloomMap<'arena, K, V> { /* fields omitted */ }

A variant of the Map that includes a bloom filter using the bloom function for keys that can be represented as byte slices.

This is ideal for small maps for which querying for absent keys is a common behavior. In this case it will very likely outperform a HashMap, even one with a fast hashing algorithm.

Methods

impl<'arena, K, V> BloomMap<'arena, K, V>

pub const fn new() -> Self

Create a new, empty BloomMap.

impl<'arena, K, V: Copy> BloomMap<'arena, K, V>

Important traits for MapIter<'arena, K, V>

impl<'arena, K, V: Copy> Iterator for MapIter<'arena, K, V> type Item = (&'arena K, V);

pub fn iter(&self) -> MapIter<'arena, K, V>

Get an iterator over key value pairs.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

pub fn clear(&self)

Clears the map.

impl<'arena, K, V> BloomMap<'arena, K, V> where
    K: Eq + Hash + Copy + AsRef<[u8]>,
    V: Copy, 

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

Inserts a key-value pair into the map. If the key was previously set, old value is returned.

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

Returns the value corresponding to the key.

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

Returns true if the map contains a value for the specified key.

Trait Implementations

impl<'a, 'b, KA, VA, KB, VB> PartialEq<BloomMap<'b, KB, VB>> for BloomMap<'a, KA, VA> where
    (&'a KA, VA): PartialEq<(&'b KB, VB)>,
    VA: Copy,
    VB: Copy, 

fn eq(&self, other: &BloomMap<'b, KB, VB>) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'arena, K: Clone, V: Clone> Clone for BloomMap<'arena, K, V>

fn clone(&self) -> BloomMap<'arena, K, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'arena, K: Copy, V: Copy> Copy for BloomMap<'arena, K, V>

impl<'arena, K, V> From<Map<'arena, K, V>> for BloomMap<'arena, K, V> where
    K: Eq + Hash + Copy + AsRef<[u8]>,
    V: Copy, 

fn from(map: Map<'arena, K, V>) -> BloomMap<'arena, K, V>

Performs the conversion.

impl<'arena, K, V> From<BloomMap<'arena, K, V>> for Map<'arena, K, V>

fn from(bloom_map: BloomMap<'arena, K, V>) -> Map<'arena, K, V>

Performs the conversion.

impl<'arena, K, V: Copy> IntoIterator for BloomMap<'arena, K, V>

type Item = (&'arena K, V)

The type of the elements being iterated over.

type IntoIter = MapIter<'arena, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'arena, K, V> Debug for BloomMap<'arena, K, V> where
    K: Debug,
    V: Debug + Copy, 

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

Formats the value using the given formatter.