Struct hash_trie::HashTrieMap

#[must_use]
pub struct HashTrieMap<H: Hashword, F: Flagword<H>, K: Value, V: Clone + Debug + Eq + PartialEq + Send + Sync + 'static, M: HasherBv<H, K> + 'static> where
    <F as TryFrom<<H as BitAnd>::Output>>::Error: Debug,  { /* fields omitted */ }

HashTrieMap implements a hash map using a hash array mapped trie (HAMT).

Example Usage

use hash_trie::HashTrieMap;
use std::{borrow::Cow, collections::hash_map::DefaultHasher};

let mut hash_map: HashTrieMap<u64, u32, String, String, DefaultHasher> = HashTrieMap::new();
let hello: String = "Hello,".into();
let world: String = "world!,".into();

hash_map = hash_map.insert(Cow::Borrowed(&hello), Cow::Borrowed(&world), false).unwrap().0;
 
// Inserting an already-inserted key returns references to the key and value in the map...
assert_eq!(hash_map.insert(Cow::Borrowed(&hello), Cow::Owned("?".into()), false)
    .unwrap_err(), (&hello, &world));
// ... unless you enable replacement.
assert!(hash_map.insert(Cow::Borrowed(&hello), Cow::Owned("?".into()), true).is_ok());

assert_eq!(hash_map.find(&hello).unwrap(), (&hello, &world));

match hash_map.remove(&hello) {
    Ok((mutated, key_reference, value_reference)) => {
        // Removing a key returns references to the key and
        // value in the set in addition to the mutated map.
        println!("Value stored in hash_map: {}", value_reference);
        hash_map = mutated;
    },
    Err(_) => panic!(),
}

Implementations

impl<H: Hashword, F: Flagword<H>, K: Value, V: Clone + Debug + Eq + PartialEq + Send + Sync + 'static, M: HasherBv<H, K> + 'static> HashTrieMap<H, F, K, V, M> where
    <F as TryFrom<<H as BitAnd>::Output>>::Error: Debug, 

pub fn new() -> Self

Get a new, empty HashTrieMap.

pub fn find(&self, key: &K) -> Result<(&K, &V), HashTrieError>

Search the HashTrieMap for the given key and return references if found, or HashTrieError::NotFound if not found.

pub fn insert<'a>(
    &'a self,
    key: Cow<'a, K>,
    value: Cow<'a, V>,
    replace: bool
) -> Result<(Self, Option<(&'a K, &'a V)>), (&'a K, &'a V)>

Search the HashTrieMap for the spot to insert the key and return both a mutated map and, if applicable, references to the replaced values. If found and replacement is disabled, references to the existing values are returned.

pub fn remove(&self, key: &K) -> Result<(Self, &K, &V), HashTrieError>

Search the HashTrieMap for the given key to remove and return a mutated map, or HashTrieError::NotFound if not found.

Trait Implementations

impl<H: Clone + Hashword, F: Clone + Flagword<H>, K: Clone + Value, V: Clone + Debug + Eq + PartialEq + Send + Sync + 'static, M: Clone + HasherBv<H, K> + 'static> Clone for HashTrieMap<H, F, K, V, M> where
    <F as TryFrom<<H as BitAnd>::Output>>::Error: Debug, 

fn clone(&self) -> HashTrieMap<H, F, K, V, M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: Debug + Hashword, F: Debug + Flagword<H>, K: Debug + Value, V: Debug + Clone + Eq + PartialEq + Send + Sync + 'static, M: Debug + HasherBv<H, K> + 'static> Debug for HashTrieMap<H, F, K, V, M> where
    <F as TryFrom<<H as BitAnd>::Output>>::Error: Debug, 

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

Formats the value using the given formatter.

impl<H: Hashword, F: Flagword<H>, K: Value, V: Clone + Debug + Eq + PartialEq + Send + Sync + 'static, M: HasherBv<H, K> + 'static> Default for HashTrieMap<H, F, K, V, M> where
    <F as TryFrom<<H as BitAnd>::Output>>::Error: Debug, 

fn default() -> Self

Returns the “default value” for a type.