Struct indexed_hash_set::IndexedHashSet

pub struct IndexedHashSet<T> where
    T: 'static,  { /* fields omitted */ }

An indexed hash set. Can be accessed either by index of hashing.

Implementations

impl<T> IndexedHashSet<T> where
    T: 'static + Eq + Hash, 

pub fn new() -> Self

A new, empty set.

pub fn len(&self) -> usize

Number of elements in the set, including the unused ones.

pub fn get_cnt<Q: ?Sized>(&self, elem: &Q) -> Option<usize> where
    T: Borrow<Q>,
    Q: Hash + Eq, 

Get the usage count of an element by hash.

pub fn get_ref_by_hash<'a, Q: ?Sized>(&'a self, elem: &Q) -> Option<&'a T> where
    T: Borrow<Q>,
    Q: Hash + Eq, 

Get a reference to the stored element by hash.

pub fn get_index_by_hash<'a, Q: ?Sized>(&'a self, elem: &Q) -> Option<RcIndex> where
    T: Borrow<Q>,
    Q: Hash + Eq, 

Get the index of the stored element by hash.

pub fn get_ref_by_index<'a>(&'a self, idx: &RcIndex) -> Option<&'a T>

Get a reference to the stored element by index.

As the index can be from another IndexedHashSet this operation is fallible.

Alternatively, the [index notation](struct.IndexedHashSet.html#impl-Index<%26'a RcIndex>) can be used, e.g. set[&rc_idx]. However, this may panic with a foreign RcIndex.

#[must_use = "If not stored usage count of the new element goes to zero."]pub fn insert(&mut self, elem: T) -> Option<RcIndex>

Insert a new element into the set.

If the element is already in the set None is returned else the index of the new entry is returned.

Note: The returned RcIndex is the initial usage of the entry. If it is dropped without cloning the usage_cnt goes to zero and the new element is dropped on the next drop_unused()!

pub fn get_or_insert(&mut self, elem: &T) -> RcIndex where
    T: Clone, 

Gets the index of the element in the set if present. If not the element is inserted and the new index is returned.

pub fn drop_unused(&mut self) -> usize

Drop all entries whose usage_cnt is zero.

pub fn iter(&self) -> impl Iterator<Item = &T>

Iterates over all elements in the set with usage_cnt != 0.

Trait Implementations

impl<T: Debug> Debug for IndexedHashSet<T> where
    T: 'static, 

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

Formats the value using the given formatter.

impl<T: 'static> Default for IndexedHashSet<T>

fn default() -> Self

Returns the "default value" for a type.

impl<'a, T> Index<&'a RcIndex> for IndexedHashSet<T> where
    T: 'static + Eq + Hash, 

Allows to access the set like set[&rc_idx].

This panics if the RcIndex used is not from this IndexedHashSet.

type Output = T

The returned type after indexing.

fn index(&self, index: &'a RcIndex) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Send for IndexedHashSet<T>

The !Send internal references are only used internally. Therefore, this type is safe to be Send.