Struct EnumSet

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

A specialized set implementation to use enum types.

Implementations

impl<E: CLike> EnumSet<E>

pub fn new() -> Self

Returns an empty EnumSet.

pub fn len(&self) -> usize

Returns the number of elements in the set.

pub fn is_empty(&self) -> bool

Checks if the set is empty.

pub fn clear(&mut self)

Removes all elements from the set.

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

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

This is equivalent to checking for an empty intersection.

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

Returns true if the set is a superset of other.

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

Returns true if the set is a subset of other.

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

Returns the union of the set and other.

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

Returns the intersection of the set and other.

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

Returns the difference between the set and other.

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

Returns the symmetric difference between the set and other.

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

Adds the given value to the set.

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

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

Removes a value from the set.

Returns true if the value was present in the set.

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

Returns true if the set contains the given value.

pub fn iter(&self) -> Iter<E>

Returns an iterator over the set’s elements.

Trait Implementations

impl<E: CLike> BitAnd for EnumSet<E>

type Output = EnumSet<E>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<E: CLike> BitAndAssign for EnumSet<E>

fn bitand_assign(&mut self, other: Self)

Performs the &= operation.

impl<E: CLike> BitOr for EnumSet<E>

type Output = EnumSet<E>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<E: CLike> BitOrAssign for EnumSet<E>

fn bitor_assign(&mut self, other: Self)

Performs the |= operation.

impl<E: CLike> BitXor for EnumSet<E>

type Output = EnumSet<E>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<E: CLike> BitXorAssign for EnumSet<E>

fn bitxor_assign(&mut self, other: Self)

Performs the ^= operation.

impl<E: Clone> 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: CLike + Debug> Debug for EnumSet<E>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

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

Creates a value from an iterator.

impl<E: CLike> 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: CLike> IntoIterator for &'a EnumSet<E>

type Item = E

The type of the elements being iterated over.

type IntoIter = Iter<E>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<E>

Creates an iterator from a value.

impl<E: Ord> 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> 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> 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: CLike> Sub for EnumSet<E>

type Output = EnumSet<E>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<E: CLike> SubAssign for EnumSet<E>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<E: Copy> Copy for EnumSet<E>

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

impl<E> StructuralPartialEq for EnumSet<E>