Struct ringui::enum_set::EnumSet

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

A specialized set implementation to use enum types.

It is a logic error for an item to be modified in such a way that the transformation of the item to or from a usize, as determined by the CLike trait, changes while the item is in the set. This is normally only possible through Cell, RefCell, global state, I/O, or unsafe code.

Methods

impl<E: CLike> EnumSet<E>

pub fn new() -> EnumSet<E>

Returns an empty EnumSet.

pub fn len(&self) -> usize

Returns the number of elements in the given EnumSet.

pub fn is_empty(&self) -> bool

Returns true if the EnumSet is empty.

pub fn clear(&mut self)

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

Returns false if the EnumSet contains any enum of the given EnumSet.

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

Returns true if a given EnumSet is included in this EnumSet.

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

Returns true if this EnumSet is included in the given EnumSet.

pub fn union(&self, e: EnumSet<E>) -> EnumSet<E>

Returns the union of both EnumSets.

pub fn intersection(&self, e: EnumSet<E>) -> EnumSet<E>

Returns the intersection of both EnumSets.

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

Adds an enum to the EnumSet, and returns true if it wasn't there before

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

Removes an enum from the EnumSet

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

Returns true if an EnumSet contains a given enum.

Important traits for Iter<E>

impl<E: CLike> Iterator for Iter<E> type Item = E;

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

Returns an iterator over an EnumSet.

Trait Implementations

impl<E> PartialOrd<EnumSet<E>> 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.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl<E> 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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl<E> PartialEq<EnumSet<E>> for EnumSet<E>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

type Item = E

The type of the elements being iterated over.

type IntoIter = Iter<E>

Which kind of iterator are we turning this into?

Important traits for Iter<E>

impl<E: CLike> Iterator for Iter<E> type Item = E;

fn into_iter(self) -> Iter<E>

Creates an iterator from a value.

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.

impl<'a, E: 'a + CLike + Copy> Extend<&'a E> for EnumSet<E>

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

Extends a collection with the contents of an iterator.

impl<E> Copy for EnumSet<E>

impl<E> Eq for EnumSet<E>

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

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

Formats the value using the given formatter.

impl<E> 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,

Feeds a slice of this type into the given [Hasher].

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

type Output = EnumSet<E>

The resulting type after applying the - operator.

fn sub(self, e: EnumSet<E>) -> EnumSet<E>

Performs the - operation.

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

type Output = EnumSet<E>

The resulting type after applying the & operator.

fn bitand(self, e: EnumSet<E>) -> EnumSet<E>

Performs the & operation.

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

type Output = EnumSet<E>

The resulting type after applying the | operator.

fn bitor(self, e: EnumSet<E>) -> EnumSet<E>

Performs the | operation.

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

type Output = EnumSet<E>

The resulting type after applying the ^ operator.

fn bitxor(self, e: EnumSet<E>) -> EnumSet<E>

Performs the ^ operation.

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

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

Creates a value from an iterator.

impl<E> Serialize for EnumSet<E>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where     __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'de, E> Deserialize<'de> for EnumSet<E>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where     __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.