Struct EnumSet 

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

An efficient set type for enums.

It is implemented using a bitset stored using the smallest integer that can fit all bits in the underlying enum. In general, an enum variant with a discriminant of n is stored in the nth least significant bit (corresponding with a mask of, e.g. 1 << enum as u32).

Numeric Representation

EnumSet is internally implemented using integer types, and as such can be easily converted from and to numbers.

Each bit of the underlying integer corresponds to at most one particular enum variant. If the corresponding bit for a variant is set, it is present in the set. Bits that do not correspond to any variant are always unset.

By default, each enum variant is stored in a bit corresponding to its discriminant. An enum variant with a discriminant of n is stored in the n + 1th least significant bit (corresponding to a mask of, e.g. 1 << enum as u32).

The #[enumset(map = "…")] attribute can be used to control this mapping.

Array Representation

Sets with 64 or more variants are instead stored with an underlying array of u64s. This is treated as if it was a single large integer. The nth least significant bit of this integer is stored in the n % 64th least significant bit of the n / 64th element in the array.

Serialization

When the serde feature is enabled, EnumSets can be serialized and deserialized using the serde crate.

By default, EnumSet is serialized by directly writing out a single integer containing the numeric representation of the bitset. The integer type used is the smallest one that can fit the largest variant in the enum. If no integer type is large enough, instead the EnumSet is serialized as an array of u64s containing the array representation. Unknown bits are ignored and silently removed from the bitset when deserializing.

The exact serialization format can be controlled with additional attributes on the enum type. For more information, see the documentation for Serialization Options.

FFI Safety

By default, there are no guarantees about the underlying representation of an EnumSet. To use them safely across FFI boundaries, the #[enumset(repr = "…")] attribute must be used with a primitive integer type. For example:

extern "C" {
    // This function is written in C like:
    // uint32_t some_foreign_function(uint32_t set) { … }
    fn some_foreign_function(set: EnumSet<MyEnum>) -> EnumSet<MyEnum>;
}

#[derive(Debug, EnumSetType)]
#[enumset(repr = "u32")]
enum MyEnum { A, B, C }

let set: EnumSet<MyEnum> = enum_set!(MyEnum::A | MyEnum::C);

let new_set: EnumSet<MyEnum> = unsafe { some_foreign_function(set) };
assert_eq!(new_set, enum_set!(MyEnum::C));

When an EnumSet<T> is received via FFI, all bits that don’t correspond to an enum variant of T must be set to 0. Behavior is undefined if any of these bits are set to 1.

Implementations

impl<T> EnumSet<T>

where T: EnumSetType,

pub const fn new() -> EnumSet<T>

Creates an empty EnumSet.

pub const fn empty() -> EnumSet<T>

Creates an empty EnumSet.

This is an alias for EnumSet::new.

pub const fn all() -> EnumSet<T>

Returns an EnumSet containing all valid variants of the enum.

pub const fn bit_width() -> u32

Total number of bits used by this type. 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 })

pub const fn variant_count() -> u32

The number of valid variants that this type can contain.

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

pub fn only(t: T) -> EnumSet<T>

Returns a set containing a single element.

pub fn bit_index(t: T) -> u32

Returns the bit a given enum variant is stored in.

If this returns n, it means the bit is stored in the nth least significant bit of the underlying integer.

pub fn is_bit_valid(bit: u32) -> bool

Returns whether a given bit is valid for this set.

pub fn len(&self) -> usize

Returns the number of elements in this set.

pub fn is_empty(&self) -> bool

Returns true if the set contains no elements.

pub fn clear(&mut self)

Removes all elements from the set.

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

Checks whether this set contains a value.

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

Adds a value to this set.

If the set did not have this value present, true is returned.

If the set did have this value present, false is returned.

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

Removes a value from this set. Returns whether the value was present in the set.

pub fn is_disjoint(&self, other: impl Into<EnumSet<T>>) -> bool

Returns true if self has no elements in common with other. This is equivalent to checking for an empty intersection.

pub fn is_superset(&self, other: impl Into<EnumSet<T>>) -> bool

Returns true if the set is a superset of another, i.e., self contains at least all the values in other.

pub fn is_subset(&self, other: impl Into<EnumSet<T>>) -> bool

Returns true if the set is a subset of another, i.e., other contains at least all the values in self.

pub fn union(&self, other: impl Into<EnumSet<T>>) -> EnumSet<T>

Returns a set containing any elements present in either set.

pub fn intersection(&self, other: impl Into<EnumSet<T>>) -> EnumSet<T>

Returns a set containing every element present in both sets.

pub fn difference(&self, other: impl Into<EnumSet<T>>) -> EnumSet<T>

Returns a set containing every element present in self but not in other.

pub fn symmetrical_difference(&self, other: impl Into<EnumSet<T>>) -> EnumSet<T>

Returns a set containing every element present in either self or other, but not present in both.

pub fn complement(&self) -> EnumSet<T>

Returns a set containing all enum variants not in this set.

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

Adds all elements in another set to this one.

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

Removes all values in another set from this one.

impl<T> EnumSet<T>

where T: EnumSetType,

This impl contains all outdated or deprecated functions.

pub const EMPTY: EnumSet<T> = Self::EMPTY_REPR

👎Deprecated:

Use EnumSet::empty() instead.

An empty EnumSet.

This is deprecated because EnumSet::empty is now const.

pub const ALL: EnumSet<T> = Self::ALL_REPR

👎Deprecated:

Use EnumSet::all() instead.

An EnumSet containing all valid variants of the enum.

This is deprecated because EnumSet::all is now const.

impl<T> EnumSet<T>

where T: EnumSetType + EnumSetTypeWithRepr,

pub const fn as_repr(&self) -> <T as EnumSetTypeWithRepr>::Repr

Returns a T::Repr representing the elements of this set.

Unlike the other as_* methods, this method is zero-cost and guaranteed not to fail, panic or truncate any bits.

In order to use this method, the definition of T must have an #[enumset(repr = "…")] annotation with a primitive integer type.

pub unsafe fn from_repr_unchecked( bits: <T as EnumSetTypeWithRepr>::Repr, ) -> EnumSet<T>

Constructs a bitset from a T::Repr without checking for invalid bits.

Unlike the other from_* methods, this method is zero-cost and guaranteed not to fail, panic or truncate any bits, provided the conditions under “Safety” are upheld.

In order to use this method, the definition of T must have an #[enumset(repr = "…")] annotation with a primitive integer type.

Safety

All bits in the provided parameter bits that don’t correspond to an enum variant of T must be set to 0. Behavior is undefined if any of these bits are set to 1.

pub fn from_repr(bits: <T as EnumSetTypeWithRepr>::Repr) -> EnumSet<T>

Constructs a bitset from a T::Repr.

If a bit that doesn’t correspond to an enum variant is set, this method will panic.

In order to use this method, the definition of T must have an #[enumset(repr = "…")] annotation with a primitive integer type.

pub fn try_from_repr( bits: <T as EnumSetTypeWithRepr>::Repr, ) -> Option<EnumSet<T>>

Attempts to construct a bitset from a T::Repr.

If a bit that doesn’t correspond to an enum variant is set, this method will return None.

In order to use this method, the definition of T must have an #[enumset(repr = "…")] annotation with a primitive integer type.

pub fn from_repr_truncated(bits: <T as EnumSetTypeWithRepr>::Repr) -> EnumSet<T>

Constructs a bitset from a T::Repr, ignoring invalid variants.

In order to use this method, the definition of T must have an #[enumset(repr = "…")] annotation with a primitive integer type.

impl<T> EnumSet<T>

where T: EnumSetType,

pub fn as_u8(&self) -> u8

Returns a u8 representing the elements of this set.

If the underlying bitset will not fit in a u8, this method will panic.

pub fn try_as_u8(&self) -> Option<u8>

Tries to return a u8 representing the elements of this set.

If the underlying bitset will not fit in a u8, this method will return None.

pub fn as_u8_truncated(&self) -> u8

Returns a truncated u8 representing the elements of this set.

If the underlying bitset will not fit in a u8, this method will truncate any bits that don’t fit.

pub fn from_u8(bits: u8) -> EnumSet<T>

Constructs a bitset from a u8.

If a bit that doesn’t correspond to an enum variant is set, this method will panic.

pub fn try_from_u8(bits: u8) -> Option<EnumSet<T>>

Attempts to construct a bitset from a u8.

If a bit that doesn’t correspond to an enum variant is set, this method will return None.

pub fn from_u8_truncated(bits: u8) -> EnumSet<T>

Constructs a bitset from a u8, ignoring bits that do not correspond to a variant.

pub unsafe fn from_u8_unchecked(bits: u8) -> EnumSet<T>

Constructs a bitset from a u8, without checking for invalid bits.

Safety

All bits in the provided parameter bits that don’t correspond to an enum variant of T must be set to 0. Behavior is undefined if any of these bits are set to 1.

pub fn as_u16(&self) -> u16

Returns a u16 representing the elements of this set.

If the underlying bitset will not fit in a u16, this method will panic.

pub fn try_as_u16(&self) -> Option<u16>

Tries to return a u16 representing the elements of this set.

If the underlying bitset will not fit in a u16, this method will return None.

pub fn as_u16_truncated(&self) -> u16

Returns a truncated u16 representing the elements of this set.

If the underlying bitset will not fit in a u16, this method will truncate any bits that don’t fit.

pub fn from_u16(bits: u16) -> EnumSet<T>

Constructs a bitset from a u16.

If a bit that doesn’t correspond to an enum variant is set, this method will panic.

pub fn try_from_u16(bits: u16) -> Option<EnumSet<T>>

Attempts to construct a bitset from a u16.

If a bit that doesn’t correspond to an enum variant is set, this method will return None.

pub fn from_u16_truncated(bits: u16) -> EnumSet<T>

Constructs a bitset from a u16, ignoring bits that do not correspond to a variant.

pub unsafe fn from_u16_unchecked(bits: u16) -> EnumSet<T>

Constructs a bitset from a u16, without checking for invalid bits.

Safety

All bits in the provided parameter bits that don’t correspond to an enum variant of T must be set to 0. Behavior is undefined if any of these bits are set to 1.

pub fn as_u32(&self) -> u32

Returns a u32 representing the elements of this set.

If the underlying bitset will not fit in a u32, this method will panic.

pub fn try_as_u32(&self) -> Option<u32>

Tries to return a u32 representing the elements of this set.

If the underlying bitset will not fit in a u32, this method will return None.

pub fn as_u32_truncated(&self) -> u32

Returns a truncated u32 representing the elements of this set.

If the underlying bitset will not fit in a u32, this method will truncate any bits that don’t fit.

pub fn from_u32(bits: u32) -> EnumSet<T>

Constructs a bitset from a u32.

If a bit that doesn’t correspond to an enum variant is set, this method will panic.

pub fn try_from_u32(bits: u32) -> Option<EnumSet<T>>

Attempts to construct a bitset from a u32.

If a bit that doesn’t correspond to an enum variant is set, this method will return None.

pub fn from_u32_truncated(bits: u32) -> EnumSet<T>

Constructs a bitset from a u32, ignoring bits that do not correspond to a variant.

pub unsafe fn from_u32_unchecked(bits: u32) -> EnumSet<T>

Constructs a bitset from a u32, without checking for invalid bits.

Safety

All bits in the provided parameter bits that don’t correspond to an enum variant of T must be set to 0. Behavior is undefined if any of these bits are set to 1.

pub fn as_u64(&self) -> u64

Returns a u64 representing the elements of this set.

If the underlying bitset will not fit in a u64, this method will panic.

pub fn try_as_u64(&self) -> Option<u64>

Tries to return a u64 representing the elements of this set.

If the underlying bitset will not fit in a u64, this method will return None.

pub fn as_u64_truncated(&self) -> u64

Returns a truncated u64 representing the elements of this set.

If the underlying bitset will not fit in a u64, this method will truncate any bits that don’t fit.

pub fn from_u64(bits: u64) -> EnumSet<T>

Constructs a bitset from a u64.

If a bit that doesn’t correspond to an enum variant is set, this method will panic.

pub fn try_from_u64(bits: u64) -> Option<EnumSet<T>>

Attempts to construct a bitset from a u64.

If a bit that doesn’t correspond to an enum variant is set, this method will return None.

pub fn from_u64_truncated(bits: u64) -> EnumSet<T>

Constructs a bitset from a u64, ignoring bits that do not correspond to a variant.

pub unsafe fn from_u64_unchecked(bits: u64) -> EnumSet<T>

Constructs a bitset from a u64, without checking for invalid bits.

Safety

All bits in the provided parameter bits that don’t correspond to an enum variant of T must be set to 0. Behavior is undefined if any of these bits are set to 1.

pub fn as_u128(&self) -> u128

Returns a u128 representing the elements of this set.

If the underlying bitset will not fit in a u128, this method will panic.

pub fn try_as_u128(&self) -> Option<u128>

Tries to return a u128 representing the elements of this set.

If the underlying bitset will not fit in a u128, this method will return None.

pub fn as_u128_truncated(&self) -> u128

Returns a truncated u128 representing the elements of this set.

If the underlying bitset will not fit in a u128, this method will truncate any bits that don’t fit.

pub fn from_u128(bits: u128) -> EnumSet<T>

Constructs a bitset from a u128.

If a bit that doesn’t correspond to an enum variant is set, this method will panic.

pub fn try_from_u128(bits: u128) -> Option<EnumSet<T>>

Attempts to construct a bitset from a u128.

If a bit that doesn’t correspond to an enum variant is set, this method will return None.

pub fn from_u128_truncated(bits: u128) -> EnumSet<T>

Constructs a bitset from a u128, ignoring bits that do not correspond to a variant.

pub unsafe fn from_u128_unchecked(bits: u128) -> EnumSet<T>

Constructs a bitset from a u128, without checking for invalid bits.

Safety

All bits in the provided parameter bits that don’t correspond to an enum variant of T must be set to 0. Behavior is undefined if any of these bits are set to 1.

pub fn as_usize(&self) -> usize

Returns a usize representing the elements of this set.

If the underlying bitset will not fit in a usize, this method will panic.

pub fn try_as_usize(&self) -> Option<usize>

Tries to return a usize representing the elements of this set.

If the underlying bitset will not fit in a usize, this method will return None.

pub fn as_usize_truncated(&self) -> usize

Returns a truncated usize representing the elements of this set.

If the underlying bitset will not fit in a usize, this method will truncate any bits that don’t fit.

pub fn from_usize(bits: usize) -> EnumSet<T>

Constructs a bitset from a usize.

If a bit that doesn’t correspond to an enum variant is set, this method will panic.

pub fn try_from_usize(bits: usize) -> Option<EnumSet<T>>

Attempts to construct a bitset from a usize.

If a bit that doesn’t correspond to an enum variant is set, this method will return None.

pub fn from_usize_truncated(bits: usize) -> EnumSet<T>

Constructs a bitset from a usize, ignoring bits that do not correspond to a variant.

pub unsafe fn from_usize_unchecked(bits: usize) -> EnumSet<T>

Constructs a bitset from a usize, without checking for invalid bits.

Safety

All bits in the provided parameter bits that don’t correspond to an enum variant of T must be set to 0. Behavior is undefined if any of these bits are set to 1.

impl<T> EnumSet<T>

where T: EnumSetType,

pub fn as_array<const O: usize>(&self) -> [u64; O]

Returns a [u64; O] representing the elements of this set.

If the underlying bitset will not fit in a [u64; O], this method will panic.

pub fn try_as_array<const O: usize>(&self) -> Option<[u64; O]>

Returns a [u64; O] representing the elements of this set.

If the underlying bitset will not fit in a [u64; O], this method will instead return None.

pub fn as_array_truncated<const O: usize>(&self) -> [u64; O]

Returns a [u64; O] representing the elements of this set.

If the underlying bitset will not fit in a [u64; O], this method will truncate any bits that don’t fit.

pub fn from_array<const O: usize>(v: [u64; O]) -> EnumSet<T>

Constructs a bitset from a [u64; O].

If a bit that doesn’t correspond to an enum variant is set, this method will panic.

pub fn try_from_array<const O: usize>(bits: [u64; O]) -> Option<EnumSet<T>>

Attempts to construct a bitset from a [u64; O].

If a bit that doesn’t correspond to an enum variant is set, this method will return None.

pub fn from_array_truncated<const O: usize>(bits: [u64; O]) -> EnumSet<T>

Constructs a bitset from a [u64; O], ignoring bits that do not correspond to a variant.

pub unsafe fn from_array_unchecked<const O: usize>(bits: [u64; O]) -> EnumSet<T>

Constructs a bitset from a [u64; O], without checking for invalid bits.

Safety

All bits in the provided parameter bits that don’t correspond to an enum variant of T must be set to 0. Behavior is undefined if any of these bits are set to 1.

pub fn copy_into_slice(&self, data: &mut [u64])

Copies the elements of this set into a &mut [u64].

If the underlying bitset will not fit in the provided slice, this method will panic.

pub fn try_copy_into_slice(&self, data: &mut [u64]) -> Option<()>

Copies the elements of this set into a &mut [u64].

If the underlying bitset will not fit in the provided slice, this method will return None. Otherwise, it will return Some(()).

pub fn copy_into_slice_truncated(&self, data: &mut [u64])

Copies the elements of this set into a &mut [u64].

If the underlying bitset will not fit in the provided slice, this method will truncate any bits that don’t fit.

pub fn from_slice(v: &[u64]) -> EnumSet<T>

Constructs a bitset from a &[u64].

If a bit that doesn’t correspond to an enum variant is set, this method will panic.

pub fn try_from_slice(bits: &[u64]) -> Option<EnumSet<T>>

Attempts to construct a bitset from a &[u64].

If a bit that doesn’t correspond to an enum variant is set, this method will return None.

pub fn from_slice_truncated(bits: &[u64]) -> EnumSet<T>

Constructs a bitset from a &[u64], ignoring bits that do not correspond to a variant.

pub unsafe fn from_slice_unchecked(bits: &[u64]) -> EnumSet<T>

Constructs a bitset from a &[u64], without checking for invalid bits.

Safety

All bits in the provided parameter bits that don’t correspond to an enum variant of T must be set to 0. Behavior is undefined if any of these bits are set to 1.

impl<T> EnumSet<T>

where T: EnumSetType,

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

Iterates the contents of the set in order from the least significant bit to the most significant bit.

Note that iterator invalidation is impossible as the iterator contains a copy of this type, rather than holding a reference to it.

Trait Implementations

impl<T, O> BitAnd<O> for EnumSet<T>

where T: EnumSetType, O: Into<EnumSet<T>>,

type Output = EnumSet<T>

The resulting type after applying the & operator.

fn bitand(self, other: O) -> <EnumSet<T> as BitAnd<O>>::Output

Performs the & operation.

impl<T, O> BitAndAssign<O> for EnumSet<T>

where T: EnumSetType, O: Into<EnumSet<T>>,

fn bitand_assign(&mut self, rhs: O)

Performs the &= operation.

impl<T, O> BitOr<O> for EnumSet<T>

where T: EnumSetType, O: Into<EnumSet<T>>,

type Output = EnumSet<T>

The resulting type after applying the | operator.

fn bitor(self, other: O) -> <EnumSet<T> as BitOr<O>>::Output

Performs the | operation.

impl<T, O> BitOrAssign<O> for EnumSet<T>

where T: EnumSetType, O: Into<EnumSet<T>>,

fn bitor_assign(&mut self, rhs: O)

Performs the |= operation.

impl<T, O> BitXor<O> for EnumSet<T>

where T: EnumSetType, O: Into<EnumSet<T>>,

type Output = EnumSet<T>

The resulting type after applying the ^ operator.

fn bitxor(self, other: O) -> <EnumSet<T> as BitXor<O>>::Output

Performs the ^ operation.

impl<T, O> BitXorAssign<O> for EnumSet<T>

where T: EnumSetType, O: Into<EnumSet<T>>,

fn bitxor_assign(&mut self, rhs: O)

Performs the ^= operation.

impl<T> Clone for EnumSet<T>

where T: Clone + EnumSetType, <T as EnumSetTypePrivate>::Repr: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for EnumSet<T>

where T: EnumSetType + Debug,

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

Formats the value using the given formatter.

impl<T> Default for EnumSet<T>

where T: EnumSetType,

fn default() -> EnumSet<T>

Returns an empty set.

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

where T: EnumSetType,

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for EnumSet<T>

where T: EnumSetType + Display,

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

Formats the value using the given formatter.

impl<'a, T> Extend<&'a EnumSet<T>> for EnumSet<T>

where T: EnumSetType,

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = &'a EnumSet<T>>,

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<'a, T> Extend<&'a T> for EnumSet<T>

where T: EnumSetType,

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = &'a T>,

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<T> Extend<EnumSet<T>> for EnumSet<T>

where T: EnumSetType,

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = EnumSet<T>>,

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<T> Extend<T> for EnumSet<T>

where T: EnumSetType,

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = T>,

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<T, const N: usize> From<[T; N]> for EnumSet<T>

where T: EnumSetType,

fn from(value: [T; N]) -> EnumSet<T>

Converts to this type from the input type.

impl<T> From<T> for EnumSet<T>

where T: EnumSetType,

fn from(t: T) -> EnumSet<T>

Converts to this type from the input type.

impl<'a, T> FromIterator<&'a EnumSet<T>> for EnumSet<T>

where T: 'a + EnumSetType,

fn from_iter<I>(iter: I) -> EnumSet<T>

where I: IntoIterator<Item = &'a EnumSet<T>>,

Creates a value from an iterator.

impl<'a, T> FromIterator<&'a T> for EnumSet<T>

where T: 'a + EnumSetType,

fn from_iter<I>(iter: I) -> EnumSet<T>

where I: IntoIterator<Item = &'a T>,

Creates a value from an iterator.

impl<T> FromIterator<EnumSet<T>> for EnumSet<T>

where T: EnumSetType,

fn from_iter<I>(iter: I) -> EnumSet<T>

where I: IntoIterator<Item = EnumSet<T>>,

Creates a value from an iterator.

impl<T> FromIterator<T> for EnumSet<T>

where T: EnumSetType,

fn from_iter<I>(iter: I) -> EnumSet<T>

where I: IntoIterator<Item = T>,

Creates a value from an iterator.

impl<T> Hash for EnumSet<T>

where T: EnumSetType,

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

where H: Hasher,

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> IntoIterator for EnumSet<T>

where T: EnumSetType,

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) -> <EnumSet<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> Not for EnumSet<T>

where T: EnumSetType,

type Output = EnumSet<T>

The resulting type after applying the ! operator.

fn not(self) -> <EnumSet<T> as Not>::Output

Performs the unary ! operation.

impl<T> Ord for EnumSet<T>

where T: EnumSetType,

fn cmp(&self, other: &EnumSet<T>) -> 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 PartialEq<EnumSet<AtomicUsage>> for AtomicUsage

fn eq(&self, other: &EnumSet<AtomicUsage>) -> 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 PartialEq<EnumSet<FastMath>> for FastMath

fn eq(&self, other: &EnumSet<FastMath>) -> 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 PartialEq<EnumSet<Plane>> for Plane

fn eq(&self, other: &EnumSet<Plane>) -> 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 PartialEq<EnumSet<Tma>> for Tma

fn eq(&self, other: &EnumSet<Tma>) -> 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 PartialEq<EnumSet<TypeUsage>> for TypeUsage

fn eq(&self, other: &EnumSet<TypeUsage>) -> 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<T> PartialEq<MixedEnumSet<T>> for EnumSet<T>

where T: EnumSetTypeWithRepr,

fn eq(&self, other: &MixedEnumSet<T>) -> 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<T> PartialEq<T> for EnumSet<T>

where T: EnumSetType,

fn eq(&self, other: &T) -> 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<T> PartialEq for EnumSet<T>

where T: PartialEq + EnumSetType, <T as EnumSetTypePrivate>::Repr: PartialEq,

fn eq(&self, other: &EnumSet<T>) -> 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<T> PartialOrd for EnumSet<T>

where T: EnumSetType,

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

where T: EnumSetType,

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, O> Sub<O> for EnumSet<T>

where T: EnumSetType, O: Into<EnumSet<T>>,

type Output = EnumSet<T>

The resulting type after applying the - operator.

fn sub(self, other: O) -> <EnumSet<T> as Sub<O>>::Output

Performs the - operation.

impl<T, O> SubAssign<O> for EnumSet<T>

where T: EnumSetType, O: Into<EnumSet<T>>,

fn sub_assign(&mut self, rhs: O)

Performs the -= operation.

impl<'a, T> Sum<&'a EnumSet<T>> for EnumSet<T>

where T: EnumSetType,

fn sum<I>(iter: I) -> EnumSet<T>

where I: Iterator<Item = &'a EnumSet<T>>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<'a, T> Sum<&'a T> for EnumSet<T>

where T: EnumSetType,

fn sum<I>(iter: I) -> EnumSet<T>

where I: Iterator<Item = &'a T>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<T> Sum<T> for EnumSet<T>

where T: EnumSetType,

fn sum<I>(iter: I) -> EnumSet<T>

where I: Iterator<Item = T>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<T> Sum for EnumSet<T>

where T: EnumSetType,

fn sum<I>(iter: I) -> EnumSet<T>

where I: Iterator<Item = EnumSet<T>>,

Takes an iterator and generates Self from the elements by “summing up” the items.

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() -> u64

Generate a stable hash of the type structure.

impl<T> Copy for EnumSet<T>

where T: Copy + EnumSetType, <T as EnumSetTypePrivate>::Repr: Copy,

impl<T> Eq for EnumSet<T>

where T: Eq + EnumSetType, <T as EnumSetTypePrivate>::Repr: Eq,

impl<T> StructuralPartialEq for EnumSet<T>

where T: EnumSetType,