Struct cranelift_bforest::Set

pub struct Set<K> where
    K: Copy,  { /* fields omitted */ }

B-tree representing an ordered set of Ks using C for comparing elements.

This is not a general-purpose replacement for BTreeSet. See the module documentation for more information about design tradeoffs.

Sets can be cloned, but that operation should only be used as part of cloning the whole forest they belong to. Cloning a set does not allocate new memory for the clone. It creates an alias of the same memory.

Methods

impl<K> Set<K> where
    K: Copy, 

pub fn new() -> Self

Make an empty set.

pub fn is_empty(&self) -> bool

Is this an empty set?

pub fn contains<C: Comparator<K>>(
    &self,
    key: K,
    forest: &SetForest<K>,
    comp: &C
) -> bool

Does the set contain key?.

pub fn insert<C: Comparator<K>>(
    &mut self,
    key: K,
    forest: &mut SetForest<K>,
    comp: &C
) -> bool

Try to insert key into the set.

If the set did not contain key, insert it and return true.

If key is already present, don't change the set and return false.

pub fn remove<C: Comparator<K>>(
    &mut self,
    key: K,
    forest: &mut SetForest<K>,
    comp: &C
) -> bool

Remove key from the set and return true.

If key was not present in the set, return false.

pub fn clear(&mut self, forest: &mut SetForest<K>)

Remove all entries.

pub fn retain<F>(&mut self, forest: &mut SetForest<K>, predicate: F) where
    F: FnMut(K) -> bool, 

Retains only the elements specified by the predicate.

Remove all elements where the predicate returns false.

pub fn cursor<'a, C: Comparator<K>>(
    &'a mut self,
    forest: &'a mut SetForest<K>,
    comp: &'a C
) -> SetCursor<'a, K, C>

Create a cursor for navigating this set. The cursor is initially positioned off the end of the set.

Important traits for SetIter<'a, K>

impl<'a, K> Iterator for SetIter<'a, K> where
    K: 'a + Copy,  type Item = K;

pub fn iter<'a>(&'a self, forest: &'a SetForest<K>) -> SetIter<'a, K>

Create an iterator traversing this set. The iterator type is K.

Trait Implementations

impl<K: Clone> Clone for Set<K> where
    K: Copy, 

fn clone(&self) -> Set<K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K> Default for Set<K> where
    K: Copy, 

fn default() -> Self

Returns the "default value" for a type.