Struct hash_trie::HashTrieSet

pub struct HashTrieSet<B: Bits, V: Value, H: HasherBv<B, V>> { /* 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, String, DefaultHasher> = HashTrieSet::new();
let hello_world: String = "Hello, world!".into();

hash_set = hash_set.insert(Cow::Borrowed(&hello_world)).unwrap();
 
// Inserting an already-inserted value returns a reference to the value in the set.
assert_eq!(*hash_set.insert(Cow::Borrowed(&hello_world)).unwrap_err(), hello_world);

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<B: Bits, V: Value, H: HasherBv<B, V>> HashTrieSet<B, V, H>

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(&self, value: Cow<'_, V>) -> Result<Self, &V>

Search the HashTrieSet for the spot to insert the value and return a mutated set, or a reference to the existing value if found.

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<B: Clone + Bits, V: Clone + Value, H: Clone + HasherBv<B, V>> Clone for HashTrieSet<B, V, H>

fn clone(&self) -> HashTrieSet<B, V, H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B: Debug + Bits, V: Debug + Value, H: Debug + HasherBv<B, V>> Debug for HashTrieSet<B, V, H>

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

Formats the value using the given formatter.

impl<B: Bits, V: Value, H: HasherBv<B, V>> Default for HashTrieSet<B, V, H>

fn default() -> Self

Returns the “default value” for a type.