Struct hash_trie::HashTrieSet

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

HashTrieSet implements a hash set using a hash array mapped trie (HAMT).

Example Usage

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

let mut hash_set: HashTrieSet<u64, u32, String, DefaultHasher> = HashTrieSet::new();
let hello_world: String = "Hello, world!".into();

hash_set = hash_set.insert(Cow::Borrowed(&hello_world), false).unwrap().0;
 
// Inserting an already-inserted value returns a reference to the value in the set...
assert_eq!(*hash_set.insert(Cow::Borrowed(&hello_world), false).unwrap_err(), hello_world);
// ... unless you enable replacement.
assert!(hash_set.insert(Cow::Borrowed(&hello_world), true).is_ok());

assert_eq!(*hash_set.find(&hello_world).unwrap(), hello_world);

match hash_set.remove(&hello_world) {
    Ok((mutated, reference)) => {
        // Removing a value returns a reference to the value
        // in the set in addition to the mutated set.
        println!("Value stored in hash_set: {}", reference);
        hash_set = mutated;
    },
    Err(_) => panic!(),
}

Implementations

impl<H: Hashword, F: Flagword<H>, V: Value, M: HasherBv<H, V> + 'static> HashTrieSet<H, F, V, M> where
    <F as TryFrom<<H as BitAnd>::Output>>::Error: Debug, 

pub fn new() -> Self

Get a new, empty HashTrieSet.

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

Search the HashTrieSet for the given value and return a reference if found, or HashTrieError::NotFound if not found.

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

Search the HashTrieSet for the spot to insert the value and return both a mutated set and, if applicable, a reference to the replaced value. If found and replacement is disabled, a reference to the existing value is returned.

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

Search the HashTrieSet for the given value to remove and return a mutated set, or HashTrieError::NotFound if not found.

Trait Implementations

impl<H: Clone + Hashword, F: Clone + Flagword<H>, V: Clone + Value, M: Clone + HasherBv<H, V> + 'static> Clone for HashTrieSet<H, F, V, M> where
    <F as TryFrom<<H as BitAnd>::Output>>::Error: Debug, 

fn clone(&self) -> HashTrieSet<H, F, 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>, V: Debug + Value, M: Debug + HasherBv<H, V> + 'static> Debug for HashTrieSet<H, F, 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>, V: Value, M: HasherBv<H, V> + 'static> Default for HashTrieSet<H, F, V, M> where
    <F as TryFrom<<H as BitAnd>::Output>>::Error: Debug, 

fn default() -> Self

Returns the “default value” for a type.