Struct EnumSet

pub struct EnumSet<E: EnumLike> { /* private fields */ }

A BitSet indexed by an EnumLike type.

Implementations

impl<E: EnumLike> EnumSet<E>

pub fn into_bit_set(self) -> BitSet

Returns the inner BitSet.

pub fn get_ref(&self) -> &BitSet

Returns a reference to the inner BitSet.

pub fn from_bit_set(inner: BitSet) -> Self

Constructs an EnumSet from a BitSet.

pub fn new() -> Self

Creates a new EnumSet.

pub fn shrink_to_fit(&mut self)

Attemps to minimalize the memory usage of the inner BitSet.

pub fn iter(&self) -> WrapIter<E, Iter<'_, u32>>

Iterator over each element in the set.

pub fn union<'a>(&'a self, other: &'a Self) -> Union<'a, E>

Iterator over each element in set || other.

pub fn intersection<'a>(&'a self, other: &'a Self) -> Intersection<'a, E>

Iterator over each element in set && other.

pub fn difference<'a>(&'a self, other: &'a Self) -> Difference<'a, E>

Iterator over each element in set - other.

pub fn symmetric_difference<'a>( &'a self, other: &'a Self, ) -> SymmetricDifference<'a, E>

Iterator over each element in set ^ other.

pub fn union_with(&mut self, other: &Self)

Computes the union with the other set, in-place.

pub fn intersect_with(&mut self, other: &Self)

Computes the intersection with the other set, in-place.

pub fn difference_with(&mut self, other: &Self)

Computes the difference with the other set, in-place.

pub fn symmetric_difference_with(&mut self, other: &Self)

Computes the symmetric difference with the other set, in-place.

pub fn len(&self) -> usize

Returns the number of elements in the set.

pub fn is_empty(&self) -> bool

Returns true if there are no elements in the set.

pub fn clear(&mut self)

Clears all elements in the set.

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

Returns true if the set contains this value.

pub fn is_disjoint(&self, other: &Self) -> bool

Returns true if the set has no elements in common with other.

pub fn is_subset(&self, other: &Self) -> bool

Returns true if the set has no elements in common with other.

pub fn is_superset(&self, other: &Self) -> bool

Returns true if the set has no elements in common with other.

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

Returns true if the value was not already present in the set

pub fn remove(&mut self, value: E) -> bool

Returns true if the value was already present in the set

Trait Implementations

impl<E: Clone + EnumLike> Clone for EnumSet<E>

fn clone(&self) -> EnumSet<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: EnumLike + Debug> Debug for EnumSet<E>

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

Formats the value using the given formatter.

impl<E: EnumLike> Default for EnumSet<E>

fn default() -> Self

Returns the “default value” for a type.

impl<E: EnumLike> Extend<E> for EnumSet<E>

fn extend<I: IntoIterator<Item = E>>(&mut self, iter: I)

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<E: EnumLike> FromIterator<E> for EnumSet<E>

fn from_iter<I: IntoIterator<Item = E>>(iter: I) -> Self

Creates a value from an iterator.

impl<E: Hash + EnumLike> Hash for EnumSet<E>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, E: EnumLike> IntoIterator for &'a EnumSet<E>

type Item = E

The type of the elements being iterated over.

type IntoIter = WrapIter<E, Iter<'a, u32>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<E: Ord + EnumLike> Ord for EnumSet<E>

fn cmp(&self, other: &EnumSet<E>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<E: PartialEq + EnumLike> PartialEq for EnumSet<E>

fn eq(&self, other: &EnumSet<E>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

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

impl<E: PartialOrd + EnumLike> PartialOrd for EnumSet<E>

fn partial_cmp(&self, other: &EnumSet<E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<E: Eq + EnumLike> Eq for EnumSet<E>

impl<E: EnumLike> StructuralPartialEq for EnumSet<E>