Struct big_enum_set::BigEnumSet

pub struct BigEnumSet<T: BigEnumSetType> { /* fields omitted */ }

An efficient set type for enums.

Serialization

The default representation serializes enumsets as an [u8; N], where N is is the smallest that can contain all bits that are part of the set.

Unknown bits are ignored, and are simply dropped. To override this behavior, you can add a #[big_enum_set(serialize_deny_unknown)] annotation to your enum.

You can add a #[big_enum_set(serialize_bytes = "N")] annotation to your enum to explicitly set the number of bytes the BigEnumSet is serialized as. This can be used to avoid breaking changes in certain serialization formats (such as bincode).

In addition, the #[big_enum_set(serialize_as_list)] annotation causes the BigEnumSet to be instead serialized as a list. This requires your enum type implement [Serialize] and [Deserialize].

Methods

impl<T: BigEnumSetType> BigEnumSet<T>

pub const EMPTY: BigEnumSet<T>

Empty set.

pub fn new() -> Self

Returns an empty set.

pub fn only(t: T) -> Self

Returns a set containing a single value.

pub fn empty() -> Self

Returns an empty set.

pub fn all() -> Self

Returns a set with all bits set.

pub fn bit_width() -> u32

Total number of bits this enum set uses. Note that the actual amount of space used is rounded up to the next highest usize.

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

pub fn variant_count() -> u32

The number of valid variants in this enum set.

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

pub fn to_bits(&self) -> &[usize]

Returns the raw bits of this set

pub fn from_bits(bits: &[usize]) -> Self

Constructs a bitset from raw bits.

Panics

If bits not in the enum are set.

pub fn len(&self) -> usize

Returns the number of values in this 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

Checks if this set shares no elements with another.

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

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

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

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

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

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

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

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

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

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

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

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

pub fn complement(&self) -> Self

Returns a set containing all elements not in this 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.

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

Removes a value from this set.

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

Adds all elements in another set to this one.

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

Removes all values in another set from this one.

Important traits for EnumSetIter<T>

impl<T: BigEnumSetType> Iterator for EnumSetIter<T> type Item = T;

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

Creates an iterator over the values in this set.

Trait Implementations

impl<T: BigEnumSetType> From<T> for BigEnumSet<T>

fn from(t: T) -> Self

Performs the conversion.

impl<T: PartialEq + BigEnumSetType> PartialEq<BigEnumSet<T>> for BigEnumSet<T> where
    T::Repr: PartialEq, 

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

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

fn ne(&self, other: &BigEnumSet<T>) -> bool

This method tests for !=.

impl<T: BigEnumSetType> PartialEq<T> for BigEnumSet<T>

fn eq(&self, other: &T) -> 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<T: Eq + BigEnumSetType> Eq for BigEnumSet<T> where
    T::Repr: Eq, 

impl<T: Ord + BigEnumSetType> Ord for BigEnumSet<T> where
    T::Repr: Ord, 

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

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T: PartialOrd + BigEnumSetType> PartialOrd<BigEnumSet<T>> for BigEnumSet<T> where
    T::Repr: PartialOrd, 

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

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

fn lt(&self, other: &BigEnumSet<T>) -> bool

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

fn le(&self, other: &BigEnumSet<T>) -> bool

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

fn gt(&self, other: &BigEnumSet<T>) -> bool

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

fn ge(&self, other: &BigEnumSet<T>) -> bool

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

impl<T: Hash + BigEnumSetType> Hash for BigEnumSet<T> where
    T::Repr: Hash, 

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<T: BigEnumSetType, O: Into<BigEnumSet<T>>> Sub<O> for BigEnumSet<T>

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: BigEnumSetType, O: Into<BigEnumSet<T>>> SubAssign<O> for BigEnumSet<T>

fn sub_assign(&mut self, rhs: O)

Performs the -= operation.

impl<T: BigEnumSetType> Not for BigEnumSet<T>

type Output = Self

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T: BigEnumSetType, O: Into<BigEnumSet<T>>> BitAnd<O> for BigEnumSet<T>

type Output = Self

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T: BigEnumSetType, O: Into<BigEnumSet<T>>> BitOr<O> for BigEnumSet<T>

type Output = Self

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T: BigEnumSetType, O: Into<BigEnumSet<T>>> BitXor<O> for BigEnumSet<T>

type Output = Self

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<T: BigEnumSetType, O: Into<BigEnumSet<T>>> BitAndAssign<O> for BigEnumSet<T>

fn bitand_assign(&mut self, rhs: O)

Performs the &= operation.

impl<T: BigEnumSetType, O: Into<BigEnumSet<T>>> BitOrAssign<O> for BigEnumSet<T>

fn bitor_assign(&mut self, rhs: O)

Performs the |= operation.

impl<T: BigEnumSetType, O: Into<BigEnumSet<T>>> BitXorAssign<O> for BigEnumSet<T>

fn bitxor_assign(&mut self, rhs: O)

Performs the ^= operation.

impl<T: BigEnumSetType + Debug> Debug for BigEnumSet<T>

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

Formats the value using the given formatter.

impl<T: BigEnumSetType> FromIterator<T> for BigEnumSet<T>

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

Creates a value from an iterator.

impl<T: Copy + BigEnumSetType> Copy for BigEnumSet<T> where
    T::Repr: Copy, 

impl<T: BigEnumSetType> IntoIterator for BigEnumSet<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: BigEnumSetType> Extend<T> for BigEnumSet<T>

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

Extends a collection with the contents of an iterator.

impl<T: Clone + BigEnumSetType> Clone for BigEnumSet<T> where
    T::Repr: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: BigEnumSetType> Default for BigEnumSet<T>

fn default() -> Self

Returns an empty set.