Struct IndexSet

pub struct IndexSet<T> { /* private fields */ }

A default set of values.

Provides an API compatible with both IndexSet and a custom implementation based on BTreeMap.

Implementations

impl<T> IndexSet<T>

pub fn clear(&mut self)

Clears the IndexSet, removing all elements.

pub fn len(&self) -> usize

Returns the number of elements in the IndexSet.

pub fn is_empty(&self) -> bool

Returns true if the IndexSet contains no elements.

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator that yields the items in the IndexSet.

impl<T> IndexSet<T>

where T: Eq + Hash + Ord + Clone,

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more elements to be inserted in the IndexSet.

pub fn contains<Q>(&self, value: &Q) -> bool

where T: Borrow<Q>, Q: Hash + Eq + Ord + ?Sized,

Returns true if the IndexSet contains an element equal to the value.

pub fn get<Q>(&self, value: &Q) -> Option<&T>

where T: Borrow<Q>, Q: Hash + Eq + Ord + ?Sized,

Returns a reference to the element in the IndexSet, if any, that is equal to the value.

pub fn get_index_of<Q>(&self, value: &Q) -> Option<usize>

where T: Borrow<Q>, Q: Hash + Eq + Ord + ?Sized,

Return the index of the item provided, if it exists.

pub fn insert(&mut self, value: T) -> bool

Adds value to the IndexSet.

Returns whether the value was newly inserted:

• Returns true if the set did not previously contain an equal value.
• Returns false otherwise and the entry is not updated.

pub fn swap_remove<Q>(&mut self, value: &Q) -> bool

where T: Borrow<Q>, Q: Hash + Eq + Ord + ?Sized,

Remove the value from the IndexSet, and return true if it was present.

Like Vec::swap_remove, the value is removed by swapping it with the last element of the set and popping it off. This perturbs the position of what used to be the last element!

Return false if value was not in the set.

Computes in O(1) time (average).

pub fn replace(&mut self, value: T) -> Option<T>

Adds a value to the IndexSet, replacing the existing value, if any, that is equal to the given one. Returns the replaced value.

pub fn is_disjoint(&self, other: &IndexSet<T>) -> bool

Returns true if self has no elements in common with other. This is equivalent to checking for an empty intersection.

pub fn is_subset(&self, other: &IndexSet<T>) -> bool

Returns true if the IndexSet is a subset of another, i.e., other contains at least all the values in self.

pub fn is_superset(&self, other: &IndexSet<T>) -> bool

Returns true if the IndexSet is a superset of another, i.e., self contains at least all the values in other.

Trait Implementations

impl<T> Clone for IndexSet<T>

where T: Clone,

fn clone(&self) -> IndexSet<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for IndexSet<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for IndexSet<T>

fn default() -> IndexSet<T>

Returns the “default value” for a type.

impl<T> Extend<T> for IndexSet<T>

where T: Hash + Eq + Ord + Clone,

fn extend<Iter>(&mut self, iter: Iter)

where Iter: IntoIterator<Item = T>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T> FromIterator<T> for IndexSet<T>

where T: Hash + Eq + Ord + Clone,

fn from_iter<I>(iter: I) -> IndexSet<T>

where I: IntoIterator<Item = T>,

Creates a value from an iterator.

impl<T> Index<usize> for IndexSet<T>

where T: Hash + Eq + Ord,

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &T

Performs the indexing (container[index]) operation.

impl<'a, T> IntoIterator for &'a IndexSet<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a IndexSet<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for IndexSet<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <IndexSet<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> PartialEq for IndexSet<T>

where T: PartialEq + Hash + Ord,

fn eq(&self, other: &IndexSet<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &IndexSet<T>) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Eq for IndexSet<T>

where T: Eq + Hash + Ord,