Struct enumset::EnumSet

source ·

pub struct EnumSet<T: EnumSetType> { /* private fields */ }

Expand description

An efficient set type for enums.

Implementations

source

impl<T: EnumSetType> EnumSet<T>

source

pub fn new() -> Self

Returns an empty set.

source

pub fn only(t: T) -> Self

Returns a set containing a single value.

source

pub fn empty() -> Self

Returns an empty set.

source

pub fn all() -> Self

Returns a set with all bits set.

source

pub fn bit_width() -> u8

Total number of bits this enumset uses. Note that the actual amount of space used is rounded up to the next highest integer type (u8, u16, u32, u64, or u128).

This is the same as EnumSet::variant_count except in enums with “sparse” variants. (e.g. enum Foo { A = 10, B = 20 })

source

pub fn variant_count() -> u8

The number of valid variants in this enumset.

This is the same as EnumSet::bit_width except in enums with “sparse” variants. (e.g. enum Foo { A = 10, B = 20 })

source

pub fn to_bits(&self) -> u128

Returns the raw bits of this set

source

pub fn from_bits(bits: u128) -> Self

Constructs a bitset from raw bits.

Panics

If bits not in the enum are set.

source

pub fn len(&self) -> usize

Returns the number of values in this set.

source

pub fn is_empty(&self) -> bool

Checks if the set is empty.

source

pub fn clear(&mut self)

Removes all elements from the set.

source

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

Checks if this set shares no elements with another.

source

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

Checks if all elements in another set are in this set.

source

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

Checks if all elements of this set are in another set.

source

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

Returns a set containing the union of all elements in both sets.

source

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

Returns a set containing all elements in common with another set.

source

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

Returns a set with all elements of the other set removed.

source

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

Returns a set with all elements not contained in both sets.

source

pub fn complement(&self) -> Self

Returns a set containing all elements not in this set.

source

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

Checks whether this set contains a value.

source

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

Adds a value to this set.

source

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

Removes a value from this set.

source

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

Adds all elements in another set to this one.

source

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

Removes all values in another set from this one.

source

pub fn iter(&self) -> EnumSetIter<T> ⓘ

Creates an iterator over the values in this set.

Trait Implementations

source

impl<T: EnumSetType, O: Into<EnumSet<T>>> BitAnd<O> for EnumSet<T>

type Output = EnumSet<T>

The resulting type after applying the & operator.

source

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

Performs the & operation. Read more

source

impl<T: EnumSetType, O: Into<EnumSet<T>>> BitAndAssign<O> for EnumSet<T>

source

fn bitand_assign(&mut self, rhs: O)

Performs the &= operation. Read more

source

impl<T: EnumSetType, O: Into<EnumSet<T>>> BitOr<O> for EnumSet<T>

type Output = EnumSet<T>

The resulting type after applying the | operator.

source

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

Performs the | operation. Read more

source

impl<T: EnumSetType, O: Into<EnumSet<T>>> BitOrAssign<O> for EnumSet<T>

source

fn bitor_assign(&mut self, rhs: O)

Performs the |= operation. Read more

source

impl<T: EnumSetType, O: Into<EnumSet<T>>> BitXor<O> for EnumSet<T>

type Output = EnumSet<T>

The resulting type after applying the ^ operator.

source

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

Performs the ^ operation. Read more

source

impl<T: EnumSetType, O: Into<EnumSet<T>>> BitXorAssign<O> for EnumSet<T>

source

fn bitxor_assign(&mut self, rhs: O)

Performs the ^= operation. Read more

source

impl<T: Clone + EnumSetType> Clone for EnumSet<T>where
T::Repr: Clone,

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<T: EnumSetType + Debug> Debug for EnumSet<T>

source

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

Formats the value using the given formatter. Read more

source

impl<T: EnumSetType> From<T> for EnumSet<T>

source

fn from(t: T) -> Self

Converts to this type from the input type.

source

impl<T: Hash + EnumSetType> Hash for EnumSet<T>where
T::Repr: Hash,

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl<T: EnumSetType> IntoIterator for EnumSet<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = EnumSetIter<T>

Which kind of iterator are we turning this into?

source

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

source

impl<T: EnumSetType> Not for EnumSet<T>

type Output = EnumSet<T>

The resulting type after applying the ! operator.

source

fn not(self) -> Self::Output

Performs the unary ! operation. Read more

source

impl<T: Ord + EnumSetType> Ord for EnumSet<T>where
T::Repr: Ord,

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more

source

impl<T: PartialEq + EnumSetType> PartialEq<EnumSet<T>> for EnumSet<T>where
T::Repr: PartialEq,

source

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

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl<T: EnumSetType> PartialEq<T> for EnumSet<T>

source

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

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl<T: PartialOrd + EnumSetType> PartialOrd<EnumSet<T>> for EnumSet<T>where
T::Repr: PartialOrd,

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl<T: EnumSetType, O: Into<EnumSet<T>>> Sub<O> for EnumSet<T>

type Output = EnumSet<T>

The resulting type after applying the - operator.

source

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

Performs the - operation. Read more

source

impl<T: EnumSetType, O: Into<EnumSet<T>>> SubAssign<O> for EnumSet<T>

source

fn sub_assign(&mut self, rhs: O)

Performs the -= operation. Read more

source

impl<T: EnumSetType> StructuralPartialEq for EnumSet<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for EnumSet<T>where
<T as EnumSetType>::Repr: RefUnwindSafe,

impl<T> Send for EnumSet<T>where
<T as EnumSetType>::Repr: Send,

impl<T> Sync for EnumSet<T>where
<T as EnumSetType>::Repr: Sync,

impl<T> Unpin for EnumSet<T>where
<T as EnumSetType>::Repr: Unpin,

impl<T> UnwindSafe for EnumSet<T>where
<T as EnumSetType>::Repr: UnwindSafe,

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<!> for T

const: unstable · source

fn from(t: !) -> T

Converts to this type from the input type.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct enumset::EnumSet

Implementations

impl<T: EnumSetType> EnumSet<T>

pub fn new() -> Self

pub fn only(t: T) -> Self

pub fn empty() -> Self

pub fn all() -> Self

pub fn bit_width() -> u8

pub fn variant_count() -> u8

pub fn to_bits(&self) -> u128

pub fn from_bits(bits: u128) -> Self

Panics

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn clear(&mut self)

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

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

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

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

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

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

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

pub fn complement(&self) -> Self

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

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

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

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

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

pub fn iter(&self) -> EnumSetIter<T> ⓘ

Trait Implementations

impl<T: EnumSetType, O: Into<EnumSet<T>>> BitAnd<O> for EnumSet<T>

type Output = EnumSet<T>

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

impl<T: EnumSetType, O: Into<EnumSet<T>>> BitAndAssign<O> for EnumSet<T>

fn bitand_assign(&mut self, rhs: O)

impl<T: EnumSetType, O: Into<EnumSet<T>>> BitOr<O> for EnumSet<T>

type Output = EnumSet<T>

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

impl<T: EnumSetType, O: Into<EnumSet<T>>> BitOrAssign<O> for EnumSet<T>

fn bitor_assign(&mut self, rhs: O)

impl<T: EnumSetType, O: Into<EnumSet<T>>> BitXor<O> for EnumSet<T>

type Output = EnumSet<T>

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

impl<T: EnumSetType, O: Into<EnumSet<T>>> BitXorAssign<O> for EnumSet<T>

fn bitxor_assign(&mut self, rhs: O)

impl<T: Clone + EnumSetType> Clone for EnumSet<T>where T::Repr: Clone,

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

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

impl<T: EnumSetType + Debug> Debug for EnumSet<T>

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

impl<T: EnumSetType> From<T> for EnumSet<T>

fn from(t: T) -> Self

impl<T: Hash + EnumSetType> Hash for EnumSet<T>where T::Repr: Hash,

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

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

impl<T: EnumSetType> IntoIterator for EnumSet<T>

type Item = T

type IntoIter = EnumSetIter<T>

fn into_iter(self) -> Self::IntoIter

impl<T: EnumSetType> Not for EnumSet<T>

type Output = EnumSet<T>

fn not(self) -> Self::Output

impl<T: Ord + EnumSetType> Ord for EnumSet<T>where T::Repr: Ord,

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

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

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

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

impl<T: PartialEq + EnumSetType> PartialEq<EnumSet<T>> for EnumSet<T>where T::Repr: PartialEq,

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

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

impl<T: EnumSetType> PartialEq<T> for EnumSet<T>

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

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

impl<T: PartialOrd + EnumSetType> PartialOrd<EnumSet<T>> for EnumSet<T>where T::Repr: PartialOrd,

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

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

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

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

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

impl<T: EnumSetType, O: Into<EnumSet<T>>> Sub<O> for EnumSet<T>

impl<T: Clone + EnumSetType> Clone for EnumSet<T>where
T::Repr: Clone,

impl<T: Hash + EnumSetType> Hash for EnumSet<T>where
T::Repr: Hash,

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

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

impl<T: Ord + EnumSetType> Ord for EnumSet<T>where
T::Repr: Ord,

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

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

fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,

impl<T: PartialEq + EnumSetType> PartialEq<EnumSet<T>> for EnumSet<T>where
T::Repr: PartialEq,

impl<T: PartialOrd + EnumSetType> PartialOrd<EnumSet<T>> for EnumSet<T>where
T::Repr: PartialOrd,

impl<T: Copy + EnumSetType> Copy for EnumSet<T>where
T::Repr: Copy,

impl<T: Eq + EnumSetType> Eq for EnumSet<T>where
T::Repr: Eq,

impl<T> RefUnwindSafe for EnumSet<T>where
<T as EnumSetType>::Repr: RefUnwindSafe,

impl<T> Send for EnumSet<T>where
<T as EnumSetType>::Repr: Send,

impl<T> Sync for EnumSet<T>where
<T as EnumSetType>::Repr: Sync,

impl<T> Unpin for EnumSet<T>where
<T as EnumSetType>::Repr: Unpin,

impl<T> UnwindSafe for EnumSet<T>where
<T as EnumSetType>::Repr: UnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,