Struct hamst::Hamt

pub struct Hamt<K, V, H> { /* fields omitted */ }

HAMT with shareable nodes

The structure is immutable from root to leaves, where each node of this structure is also independently shareable, including on different thread.

Implementations

impl<H: Hasher + Default, K: PartialEq + Eq + Hash, V> Hamt<K, V, H>

pub fn new() -> Self

Create a new empty HAMT

pub fn is_empty(&self) -> bool

Check if the HAMT is empty

pub fn size(&self) -> usize

Return the number of elements in this HAMT

pub fn thaw(&self) -> HamtMut<K, V, H>

Thaw this HAMT into a HAMT that can be mutated

pub fn mutate_freeze<E, F>(&self, f: F) -> Result<Self, E> where
    F: FnOnce(&mut HamtMut<K, V, H>) -> Result<(), E>, 

Temporary create a mutable HAMT from an immutable one, and apply the callback f to the mutable reference, then thaw into the resulting HAMT

let empty : Hamt<u32, u32, DefaultHasher> = Hamt::new();
let result = reference.freeze(|x| {
    x.insert(10, 20)?;
    x.insert(20, 30)
}).expect("it works");

pub fn mutate_freeze_ret<E, F, R>(&self, f: F) -> Result<(Self, R), E> where
    F: FnOnce(&mut HamtMut<K, V, H>) -> Result<R, E>, 

Similar to 'mutate_freeze' and also returns the result of f too

impl<H: Hasher + Default, K: Hash + Eq, V> Hamt<K, V, H>

pub fn lookup(&self, k: &K) -> Option<&V>

Try to get the element related to key K

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

Check if the key is contained into the HAMT

pub fn iter(&self) -> HamtIter<'_, K, V>

Create a new iterator for this HAMT

Trait Implementations

impl<H, K, V> Clone for Hamt<K, V, H>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: Hasher + Default, K: Eq + Hash, V> Default for Hamt<K, V, H>

fn default() -> Self

Returns the "default value" for a type.

impl<H: Default + Hasher, K: Eq + Hash, V: Eq> Eq for Hamt<K, V, H>

impl<'a, H, K, V> From<&'a Hamt<K, V, H>> for HamtMut<K, V, H>

fn from(t: &'a Hamt<K, V, H>) -> Self

Performs the conversion.

impl<H: Default + Hasher, K: Eq + Hash + Clone, V: Clone> FromIterator<(K, V)> for Hamt<K, V, H>

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

Creates a value from an iterator.

impl<H: Default + Hasher, K: Eq + Hash, V: PartialEq> PartialEq<Hamt<K, V, H>> for Hamt<K, V, H>

fn eq(&self, other: &Self) -> 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 !=.