Struct swim_collections::hash_trie::HashTrieMap

pub struct HashTrieMap<'a, K, V, H = Murmur3> { /* fields omitted */ }

Hash array mapped trie map.

Methods

impl<K, V> HashTrieMap<'static, K, V>

pub fn new() -> HashTrieMap<'static, K, V>

Constructs a new HashTrieMap that will allocate its data in the global Hold.

impl<K, V, H> HashTrieMap<'static, K, V, H>

pub fn new_hasher(hasher: H) -> HashTrieMap<'static, K, V, H>

Constructs a new HashTrieMap that will allocate its data in the global Hold, and hash its keys using the supplied hasher.

impl<'a, K, V> HashTrieMap<'a, K, V>

pub fn hold_new(hold: &dyn Hold<'a>) -> HashTrieMap<'a, K, V>

Constructs a new HashTrieMap that will allocate its data in Hold. Allocates a zero-sized root block in hold, which typically returns a shared sentinel pointer to the hold, consuming no additional memory.

impl<'a, K, V, H> HashTrieMap<'a, K, V, H>

pub fn hold_new_hasher(
    hold: &dyn Hold<'a>,
    hasher: H
) -> HashTrieMap<'a, K, V, H>

Constructs a new HashTrieMap that will allocate its data in Hold, and hash its keys using the supplied hasher. Allocates a zero-sized root block in hold, which typically returns a shared sentinel pointer to the hold, consuming no additional memory.

pub fn is_empty(&self) -> bool

Returns true if this HashTrieMap contains no leafs.

pub fn len(&self) -> usize

Returns the number of leafs in this HashTrieMap.

Important traits for HashTrieMapIter<'a, K, V>

impl<'a, K: 'a, V: 'a> Iterator for HashTrieMapIter<'a, K, V> type Item = (&'a K, &'a V);

pub fn iter(&self) -> HashTrieMapIter<'a, K, V>

Returns an iterator over the leafs of this HashTrieMap.

Important traits for HashTrieMapIterMut<'a, K, V>

impl<'a, K: 'a, V: 'a> Iterator for HashTrieMapIterMut<'a, K, V> type Item = (&'a K, &'a mut V);

pub fn iter_mut(&mut self) -> HashTrieMapIterMut<'a, K, V>

Returns a mutable iterator over the leafs of this HashTrieMap.

Important traits for HashTrieMapKeys<'a, K, V>

impl<'a, K: 'a, V: 'a> Iterator for HashTrieMapKeys<'a, K, V> type Item = &'a K;

pub fn keys(&self) -> HashTrieMapKeys<'a, K, V>

Returns an iterator over the keys of this HashTrieMap.

Important traits for HashTrieMapVals<'a, K, V>

impl<'a, K: 'a, V: 'a> Iterator for HashTrieMapVals<'a, K, V> type Item = &'a V;

pub fn values(&self) -> HashTrieMapVals<'a, K, V>

Returns an iterator over the values of this HashTrieMap.

Important traits for HashTrieMapValsMut<'a, K, V>

impl<'a, K: 'a, V: 'a> Iterator for HashTrieMapValsMut<'a, K, V> type Item = &'a mut V;

pub fn values_mut(&mut self) -> HashTrieMapValsMut<'a, K, V>

Returns a mutable iterator over the values of this HashTrieMap.

impl<'a, K: Eq + Hash, V, H: BuildHasher> HashTrieMap<'a, K, V, H>

pub fn contains_key<J: Borrow<K> + ?Sized>(&self, key: &J) -> bool

Returns true if this HashTrieMap contains the given key.

pub fn get<J: Borrow<K> + ?Sized>(&self, key: &J) -> Option<&V>

Returns the value associated with the given key, or None if no association exists.

pub fn insert(
    &mut self,
    key: K,
    value: V
) -> Result<Option<V>, (K, V, HoldError)>

Associates a new value with the given key; returns the previous value associated with the key, if defined. If the trie's Hold fails to allocate any required new memory, returns the key and value, along with a HoldError, and leaves the trie in its original state.

pub fn remove<J: Borrow<K> + ?Sized>(
    &mut self,
    key: &J
) -> Result<Option<V>, HoldError>

Disassociates the given key; returns the previous value associated with the key, if any. Returns a HoldError, and leaves the trie in its original state, if the trie's Hold fails to allocate any required new memory.

Trait Implementations

impl<'a, K: 'a + Debug, V: 'a + Debug> Debug for HashTrieMap<'a, K, V>

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

Formats the value using the given formatter.

impl<'a, K, V, H> IntoIterator for &'a HashTrieMap<'a, K, V, H>

type Item = (&'a K, &'a V)

The type of the elements being iterated over.

type IntoIter = HashTrieMapIter<'a, K, V>

Which kind of iterator are we turning this into?

Important traits for HashTrieMapIter<'a, K, V>

impl<'a, K: 'a, V: 'a> Iterator for HashTrieMapIter<'a, K, V> type Item = (&'a K, &'a V);

fn into_iter(self) -> HashTrieMapIter<'a, K, V>

Creates an iterator from a value.

impl<'a, K, V, H> IntoIterator for &'a mut HashTrieMap<'a, K, V, H>

type Item = (&'a K, &'a mut V)

The type of the elements being iterated over.

type IntoIter = HashTrieMapIterMut<'a, K, V>

Which kind of iterator are we turning this into?

Important traits for HashTrieMapIterMut<'a, K, V>

impl<'a, K: 'a, V: 'a> Iterator for HashTrieMapIterMut<'a, K, V> type Item = (&'a K, &'a mut V);

fn into_iter(self) -> HashTrieMapIterMut<'a, K, V>

Creates an iterator from a value.

impl<'a, K, V, H> Holder<'a> for HashTrieMap<'a, K, V, H>

fn holder(&self) -> &'a dyn Hold<'a>

Returns the Hold that allocated this object.

impl<'a, 'b, K, V, H> Stow<'b, HashTrieMap<'b, K, V, H>> for HashTrieMap<'a, K, V, H> where
    K: Stow<'b>,
    V: Stow<'b>,
    H: Stow<'b>, 

unsafe fn stow(
    src: *mut HashTrieMap<'a, K, V, H>,
    dst: *mut HashTrieMap<'b, K, V, H>,
    hold: &dyn Hold<'b>
) -> Result<(), HoldError>

Moves the value at the src pointer to the dst pointer, recursively moving all child values into the hold. If a child stow operation fails, then any already completed child stow operations get reverted by calling unstow on the child.

unsafe fn unstow(
    src: *mut HashTrieMap<'a, K, V, H>,
    dst: *mut HashTrieMap<'b, K, V, H>
)

Reverts the most recent stow operation by moving the value at the dst pointer back to the src pointer from whence it came. The memory at the src address will be in the same state the stow operation left it in.

impl<'a, K: Clone, V: Clone, H: Clone> TryClone for HashTrieMap<'a, K, V, H>

fn try_clone(&self) -> Result<HashTrieMap<'a, K, V, H>, HoldError>

Returns a clone of self; returns an error if the clone fails.

impl<'a, K: Clone, V: Clone, H: Clone> CloneIntoHold<'a, HashTrieMap<'a, K, V, H>> for HashTrieMap<'a, K, V, H>

fn try_clone_into_hold(
    &self,
    hold: &dyn Hold<'a>
) -> Result<HashTrieMap<'a, K, V, H>, HoldError>

Returns a clone of self allocated in hold; returns an error if the clone fails.

default fn clone_into_hold(&self, hold: &dyn Hold<'a>) -> T

Returns a clone of self allocated in hold.