Struct swim_collections::hash_trie::HashTrieSet

pub struct HashTrieSet<'a, T, H = Murmur3> { /* fields omitted */ }

Hash array mapped trie set.

Methods

impl<T> HashTrieSet<'static, T>

pub fn new() -> HashTrieSet<'static, T>

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

impl<T, H> HashTrieSet<'static, T, H>

pub fn new_hasher(hasher: H) -> HashTrieSet<'static, T, H>

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

impl<'a, T> HashTrieSet<'a, T>

pub fn hold_new(hold: &dyn Hold<'a>) -> HashTrieSet<'a, T>

Constructs a new HashTrieSet 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, T, H> HashTrieSet<'a, T, H>

pub fn hold_new_hasher(hold: &dyn Hold<'a>, hasher: H) -> HashTrieSet<'a, T, H>

Constructs a new HashTrieSet 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 HashTrieSet contains no leafs.

pub fn len(&self) -> usize

Returns the number of leafs in this HashTrieSet.

Important traits for HashTrieSetIter<'a, T>

impl<'a, T: 'a> Iterator for HashTrieSetIter<'a, T> type Item = &'a T;

pub fn iter(&self) -> HashTrieSetIter<'a, T>

Returns an iterator over the leafs of this HashTrieSet.

impl<'a, T: Eq + Hash, H: BuildHasher> HashTrieSet<'a, T, H>

pub fn contains<U: Borrow<T> + ?Sized>(&self, elem: &U) -> bool

Returns true if this HashTrieSet contains the given elem.

pub fn insert(&mut self, elem: T) -> Result<bool, (T, HoldError)>

Includes a new elem in this HashTrieSet; returns true if the set already contained elem. If the trie's Hold fails to allocate any required new memory, returns the elem along with a HoldError, and leaves the trie in its original state.

pub fn remove<U: Borrow<T> + ?Sized>(
    &mut self,
    elem: &U
) -> Result<bool, HoldError>

Excludes the given elem from this HashTrieSet; returns true if the set previously contained elem. 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, T: 'a + Debug> Debug for HashTrieSet<'a, T>

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

Formats the value using the given formatter.

impl<'a, T, H> IntoIterator for &'a HashTrieSet<'a, T, H>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = HashTrieSetIter<'a, T>

Which kind of iterator are we turning this into?

Important traits for HashTrieSetIter<'a, T>

impl<'a, T: 'a> Iterator for HashTrieSetIter<'a, T> type Item = &'a T;

fn into_iter(self) -> HashTrieSetIter<'a, T>

Creates an iterator from a value.

impl<'a, T, H> Holder<'a> for HashTrieSet<'a, T, H>

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

Returns the Hold that allocated this object.

impl<'a, 'b, T, H> Stow<'b, HashTrieSet<'b, T, H>> for HashTrieSet<'a, T, H> where
    T: Stow<'b>,
    H: Stow<'b>, 

unsafe fn stow(
    src: *mut HashTrieSet<'a, T, H>,
    dst: *mut HashTrieSet<'b, T, 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 HashTrieSet<'a, T, H>,
    dst: *mut HashTrieSet<'b, T, 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, T: Clone, H: Clone> TryClone for HashTrieSet<'a, T, H>

fn try_clone(&self) -> Result<HashTrieSet<'a, T, H>, HoldError>

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

impl<'a, T: Clone, H: Clone> CloneIntoHold<'a, HashTrieSet<'a, T, H>> for HashTrieSet<'a, T, H>

fn try_clone_into_hold(
    &self,
    hold: &dyn Hold<'a>
) -> Result<HashTrieSet<'a, T, 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.