Struct EnumSet 

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

A set of enum variants, stored as a bitmask.

Implementations

impl<T: EnumSetType> EnumSet<T>

pub const fn empty() -> Self

The empty set.

pub const fn all() -> Self

The set of every variant of T.

pub fn only(value: T) -> Self

A set holding only value.

pub const fn as_u64(self) -> u64

The raw bitmask.

pub const fn from_u64_truncated(bits: u64) -> Self

Build a set from a raw bitmask, discarding bits that name no variant.

pub const fn len(self) -> usize

Number of variants in the set.

pub const fn is_empty(self) -> bool

Whether the set holds no variants.

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

Whether value is in the set.

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

Add value, returning whether it was newly added.

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

Remove value, returning whether it had been present.

pub fn clear(&mut self)

Remove every variant.

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

Variants in either set.

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

Variants in both sets.

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

Variants in self but not other.

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

Variants in exactly one of the two sets.

pub const fn complement(self) -> Self

Every variant not in the set.

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

Whether every variant of self is in other.

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

Whether every variant of other is in self.

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

Whether the two sets share no variants.

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

Iterate the variants in the set, in declaration order.

Trait Implementations

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

type Output = EnumSet<T>

The resulting type after applying the & operator.

fn bitand(self, other: EnumSet<T>) -> EnumSet<T>

Performs the & operation.

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

type Output = EnumSet<T>

The resulting type after applying the & operator.

fn bitand(self, other: T) -> EnumSet<T>

Performs the & operation.

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

fn bitand_assign(&mut self, other: EnumSet<T>)

Performs the &= operation.

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

fn bitand_assign(&mut self, other: T)

Performs the &= operation.

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

type Output = EnumSet<T>

The resulting type after applying the | operator.

fn bitor(self, other: EnumSet<T>) -> EnumSet<T>

Performs the | operation.

impl BitOr<EnumSet<AtomicUsage>> for AtomicUsage

type Output = EnumSet<AtomicUsage>

The resulting type after applying the | operator.

fn bitor(self, other: EnumSet<AtomicUsage>) -> EnumSet<AtomicUsage>

Performs the | operation.

impl BitOr<EnumSet<ComplexUsage>> for ComplexUsage

type Output = EnumSet<ComplexUsage>

The resulting type after applying the | operator.

fn bitor(self, other: EnumSet<ComplexUsage>) -> EnumSet<ComplexUsage>

Performs the | operation.

impl BitOr<EnumSet<FastMath>> for FastMath

type Output = EnumSet<FastMath>

The resulting type after applying the | operator.

fn bitor(self, other: EnumSet<FastMath>) -> EnumSet<FastMath>

Performs the | operation.

impl BitOr<EnumSet<Fp8Format>> for Fp8Format

type Output = EnumSet<Fp8Format>

The resulting type after applying the | operator.

fn bitor(self, other: EnumSet<Fp8Format>) -> EnumSet<Fp8Format>

Performs the | operation.

impl BitOr<EnumSet<Plane>> for Plane

type Output = EnumSet<Plane>

The resulting type after applying the | operator.

fn bitor(self, other: EnumSet<Plane>) -> EnumSet<Plane>

Performs the | operation.

impl BitOr<EnumSet<Tma>> for Tma

type Output = EnumSet<Tma>

The resulting type after applying the | operator.

fn bitor(self, other: EnumSet<Tma>) -> EnumSet<Tma>

Performs the | operation.

impl BitOr<EnumSet<TypeUsage>> for TypeUsage

type Output = EnumSet<TypeUsage>

The resulting type after applying the | operator.

fn bitor(self, other: EnumSet<TypeUsage>) -> EnumSet<TypeUsage>

Performs the | operation.

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

type Output = EnumSet<T>

The resulting type after applying the | operator.

fn bitor(self, other: T) -> EnumSet<T>

Performs the | operation.

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

fn bitor_assign(&mut self, other: EnumSet<T>)

Performs the |= operation.

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

fn bitor_assign(&mut self, other: T)

Performs the |= operation.

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

type Output = EnumSet<T>

The resulting type after applying the ^ operator.

fn bitxor(self, other: EnumSet<T>) -> EnumSet<T>

Performs the ^ operation.

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

type Output = EnumSet<T>

The resulting type after applying the ^ operator.

fn bitxor(self, other: T) -> EnumSet<T>

Performs the ^ operation.

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

fn bitxor_assign(&mut self, other: EnumSet<T>)

Performs the ^= operation.

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

fn bitxor_assign(&mut self, other: T)

Performs the ^= operation.

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: EnumSetType> Deserialize<'de> for EnumSet<T>

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

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

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

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: T)

🔬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: EnumSetType> From<T> for EnumSet<T>

fn from(value: T) -> Self

Converts to this type from the input type.

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

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

Creates a value from an iterator.

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

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<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?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Output = EnumSet<T>

The resulting type after applying the ! operator.

fn not(self) -> EnumSet<T>

Performs the unary ! operation.

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

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

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

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

Equality operator ==.

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

Inequality operator !=.

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

fn partial_cmp(&self, other: &Self) -> 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<T: EnumSetType> Serialize for EnumSet<T>

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

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

type Output = EnumSet<T>

The resulting type after applying the - operator.

fn sub(self, other: EnumSet<T>) -> EnumSet<T>

Performs the - operation.

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

type Output = EnumSet<T>

The resulting type after applying the - operator.

fn sub(self, other: T) -> EnumSet<T>

Performs the - operation.

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

fn sub_assign(&mut self, other: EnumSet<T>)

Performs the -= operation.

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

fn sub_assign(&mut self, other: T)

Performs the -= operation.

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

fn write_hash(hasher: &mut impl Hasher)

Write the structure of the type to the hasher

fn type_hash() -> u128

Generate a stable hash of the type structure.