Struct cursive::reexports::enumset::EnumSet [−]
#[repr(transparent)]pub struct EnumSet<T> where
T: EnumSetType, { /* fields omitted */ }
Expand description
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 numeric value of n
is stored in
the nth least significant bit (corresponding with a mask of, e.g. 1 << enum as u32
).
Serialization
When the serde
feature is enabled, EnumSet
s can be serialized and deserialized using
the serde
crate. The exact serialization format can be controlled with additional attributes
on the enum type. These attributes are valid regardless of whether the serde
feature
is enabled.
By default, EnumSet
s serialize by directly writing out the underlying bitset as an integer
of the smallest type that can fit in the underlying enum. You can add a
#[enumset(serialize_repr = "u8")]
attribute to your enum to control the integer type used
for serialization. This can be important for avoiding unintentional breaking changes when
EnumSet
s are serialized with formats like bincode
.
By default, unknown bits are ignored and silently removed from the bitset. To override this
behavior, you can add a #[enumset(serialize_deny_unknown)]
attribute. This will cause
deserialization to fail if an invalid bit is set.
In addition, the #[enumset(serialize_as_list)]
attribute causes the EnumSet
to be
instead serialized as a list of enum variants. This requires your enum type implement
[Serialize
] and [Deserialize
]. Note that this is a breaking change
Implementations
impl<T> EnumSet<T> where
T: EnumSetType,
impl<T> EnumSet<T> where
T: EnumSetType,
Creates an empty EnumSet
.
This is an alias for EnumSet::new
.
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 fn variant_count() -> u32
pub 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 clear(&mut self)
pub fn clear(&mut self)
Removes all elements from the set.
pub fn is_disjoint(&self, other: EnumSet<T>) -> bool
pub fn is_disjoint(&self, other: 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: EnumSet<T>) -> bool
pub fn is_superset(&self, other: EnumSet<T>) -> bool
Returns true
if the set is a superset of another, i.e., self
contains at least all the
values in other
.
Returns true
if the set is a subset of another, i.e., other
contains at least all
the values in self
.
Returns a set containing any elements present in either set.
pub fn intersection(&self, other: EnumSet<T>) -> EnumSet<T>
pub fn intersection(&self, other: EnumSet<T>) -> EnumSet<T>
Returns a set containing every element present in both sets.
pub fn difference(&self, other: EnumSet<T>) -> EnumSet<T>
pub fn difference(&self, other: EnumSet<T>) -> EnumSet<T>
Returns a set containing element present in self
but not in other
.
pub fn symmetrical_difference(&self, other: EnumSet<T>) -> EnumSet<T>
pub fn symmetrical_difference(&self, other: EnumSet<T>) -> EnumSet<T>
Returns a set containing every element present in either self
or other
, but is not
present in both.
pub fn complement(&self) -> EnumSet<T>
pub fn complement(&self) -> EnumSet<T>
Returns a set containing all enum variants not in this set.
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.
Removes a value from this set. Returns whether the value was present in the set.
pub fn insert_all(&mut self, other: EnumSet<T>)
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>)
pub fn remove_all(&mut self, other: EnumSet<T>)
Removes all values in another set from this one.
pub fn iter(&self) -> EnumSetIter<T>ⓘNotable traits for EnumSetIter<T>impl<T> Iterator for EnumSetIter<T> where
T: EnumSetType, type Item = T;
pub fn iter(&self) -> EnumSetIter<T>ⓘNotable traits for EnumSetIter<T>impl<T> Iterator for EnumSetIter<T> where
T: EnumSetType, type Item = T;
impl<T> Iterator for EnumSetIter<T> where
T: EnumSetType, type Item = T;
Creates an iterator over the values in this set.
Note that iterator invalidation is impossible as the iterator contains a copy of this type, rather than holding a reference to it.
impl<T> EnumSet<T> where
T: EnumSetType,
impl<T> EnumSet<T> where
T: EnumSetType,
Returns a u8
representing the elements of this set.
If the underlying bitset will not fit in a u8
, this method will panic.
Tries to return a u8
representing the elements of this set.
If the underlying bitset will not fit in a u8
, this method will instead return None
.
pub fn as_u8_truncated(&self) -> u8
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.
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>>
pub fn try_from_u8(bits: u8) -> Option<EnumSet<T>>
Attempts to constructs 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>
pub fn from_u8_truncated(bits: u8) -> EnumSet<T>
Constructs a bitset from a u8
, ignoring invalid variants.
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>
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 instead return None
.
pub fn as_u16_truncated(&self) -> u16
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.
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>>
pub fn try_from_u16(bits: u16) -> Option<EnumSet<T>>
Attempts to constructs 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>
pub fn from_u16_truncated(bits: u16) -> EnumSet<T>
Constructs a bitset from a u16
, ignoring invalid variants.
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>
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 instead return None
.
pub fn as_u32_truncated(&self) -> u32
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.
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>>
pub fn try_from_u32(bits: u32) -> Option<EnumSet<T>>
Attempts to constructs 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>
pub fn from_u32_truncated(bits: u32) -> EnumSet<T>
Constructs a bitset from a u32
, ignoring invalid variants.
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>
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 instead return None
.
pub fn as_u64_truncated(&self) -> u64
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.
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>>
pub fn try_from_u64(bits: u64) -> Option<EnumSet<T>>
Attempts to constructs 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>
pub fn from_u64_truncated(bits: u64) -> EnumSet<T>
Constructs a bitset from a u64
, ignoring invalid variants.
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>
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 instead return None
.
pub fn as_u128_truncated(&self) -> u128
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.
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>>
pub fn try_from_u128(bits: u128) -> Option<EnumSet<T>>
Attempts to constructs 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>
pub fn from_u128_truncated(bits: u128) -> EnumSet<T>
Constructs a bitset from a u128
, ignoring invalid variants.
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>
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 instead return None
.
pub fn as_usize_truncated(&self) -> usize
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>
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>>
pub fn try_from_usize(bits: usize) -> Option<EnumSet<T>>
Attempts to constructs 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>
pub fn from_usize_truncated(bits: usize) -> EnumSet<T>
Constructs a bitset from a usize
, ignoring invalid variants.
Trait Implementations
impl<T, O> BitAnd<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
impl<T, O> BitAnd<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
impl<T, O> BitAndAssign<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
impl<T, O> BitAndAssign<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
pub fn bitand_assign(&mut self, rhs: O)
pub fn bitand_assign(&mut self, rhs: O)
Performs the &=
operation. Read more
impl<T, O> BitOr<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
impl<T, O> BitOr<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
impl<T, O> BitOrAssign<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
impl<T, O> BitOrAssign<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
pub fn bitor_assign(&mut self, rhs: O)
pub fn bitor_assign(&mut self, rhs: O)
Performs the |=
operation. Read more
impl<T, O> BitXor<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
impl<T, O> BitXor<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
impl<T, O> BitXorAssign<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
impl<T, O> BitXorAssign<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
pub fn bitxor_assign(&mut self, rhs: O)
pub fn bitxor_assign(&mut self, rhs: O)
Performs the ^=
operation. Read more
impl<T> Clone for EnumSet<T> where
T: Clone + EnumSetType,
<T as EnumSetTypePrivate>::Repr: Clone,
impl<T> Clone for EnumSet<T> where
T: Clone + EnumSetType,
<T as EnumSetTypePrivate>::Repr: Clone,
impl<T> Debug for EnumSet<T> where
T: EnumSetType + Debug,
impl<T> Debug for EnumSet<T> where
T: EnumSetType + Debug,
impl<T> Default for EnumSet<T> where
T: EnumSetType,
impl<T> Default for EnumSet<T> where
T: EnumSetType,
impl<T> Extend<EnumSet<T>> for EnumSet<T> where
T: EnumSetType,
impl<T> Extend<EnumSet<T>> for EnumSet<T> where
T: EnumSetType,
pub fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = EnumSet<T>>,
pub fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = EnumSet<T>>,
Extends a collection with the contents of an iterator. Read more
extend_one
)Extends a collection with exactly one element.
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
impl<T> Extend<T> for EnumSet<T> where
T: EnumSetType,
impl<T> Extend<T> for EnumSet<T> where
T: EnumSetType,
pub fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = T>,
pub fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = T>,
Extends a collection with the contents of an iterator. Read more
extend_one
)Extends a collection with exactly one element.
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
impl<T> From<T> for EnumSet<T> where
T: EnumSetType,
impl<T> From<T> for EnumSet<T> where
T: EnumSetType,
impl<T> FromIterator<EnumSet<T>> for EnumSet<T> where
T: EnumSetType,
impl<T> FromIterator<EnumSet<T>> for EnumSet<T> where
T: EnumSetType,
pub fn from_iter<I>(iter: I) -> EnumSet<T> where
I: IntoIterator<Item = EnumSet<T>>,
pub fn from_iter<I>(iter: I) -> EnumSet<T> where
I: IntoIterator<Item = EnumSet<T>>,
Creates a value from an iterator. Read more
impl<T> FromIterator<T> for EnumSet<T> where
T: EnumSetType,
impl<T> FromIterator<T> for EnumSet<T> where
T: EnumSetType,
pub fn from_iter<I>(iter: I) -> EnumSet<T> where
I: IntoIterator<Item = T>,
pub fn from_iter<I>(iter: I) -> EnumSet<T> where
I: IntoIterator<Item = T>,
Creates a value from an iterator. Read more
impl<T> Hash for EnumSet<T> where
T: EnumSetType,
impl<T> Hash for EnumSet<T> where
T: EnumSetType,
impl<T> IntoIterator for EnumSet<T> where
T: EnumSetType,
impl<T> IntoIterator for EnumSet<T> where
T: EnumSetType,
type Item = T
type Item = T
The type of the elements being iterated over.
type IntoIter = EnumSetIter<T>
type IntoIter = EnumSetIter<T>
Which kind of iterator are we turning this into?
pub fn into_iter(self) -> <EnumSet<T> as IntoIterator>::IntoIter
pub fn into_iter(self) -> <EnumSet<T> as IntoIterator>::IntoIter
Creates an iterator from a value. Read more
impl<T> Not for EnumSet<T> where
T: EnumSetType,
impl<T> Not for EnumSet<T> where
T: EnumSetType,
impl<T> Ord for EnumSet<T> where
T: EnumSetType,
impl<T> Ord for EnumSet<T> where
T: EnumSetType,
impl<T> PartialEq<T> for EnumSet<T> where
T: EnumSetType,
impl<T> PartialEq<T> for EnumSet<T> where
T: EnumSetType,
impl<T> PartialOrd<EnumSet<T>> for EnumSet<T> where
T: EnumSetType,
impl<T> PartialOrd<EnumSet<T>> for EnumSet<T> where
T: EnumSetType,
pub fn partial_cmp(&self, other: &EnumSet<T>) -> Option<Ordering>
pub fn partial_cmp(&self, other: &EnumSet<T>) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
impl<T, O> Sub<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
impl<T, O> Sub<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
impl<T, O> SubAssign<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
impl<T, O> SubAssign<O> for EnumSet<T> where
T: EnumSetType,
O: Into<EnumSet<T>>,
pub fn sub_assign(&mut self, rhs: O)
pub fn sub_assign(&mut self, rhs: O)
Performs the -=
operation. Read more
impl<'a, T> Sum<&'a EnumSet<T>> for EnumSet<T> where
T: EnumSetType,
impl<'a, T> Sum<&'a EnumSet<T>> for EnumSet<T> where
T: EnumSetType,
impl<'a, T> Sum<&'a T> for EnumSet<T> where
T: EnumSetType,
impl<'a, T> Sum<&'a T> for EnumSet<T> where
T: EnumSetType,
impl<T> Sum<EnumSet<T>> for EnumSet<T> where
T: EnumSetType,
impl<T> Sum<EnumSet<T>> for EnumSet<T> where
T: EnumSetType,
impl<T> Sum<T> for EnumSet<T> where
T: EnumSetType,
impl<T> Sum<T> for EnumSet<T> where
T: EnumSetType,
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> StructuralEq for EnumSet<T> where
T: EnumSetType,
impl<T> StructuralPartialEq for EnumSet<T> where
T: EnumSetType,
Auto Trait Implementations
impl<T> RefUnwindSafe for EnumSet<T> where
<T as EnumSetTypePrivate>::Repr: RefUnwindSafe,
impl<T> UnwindSafe for EnumSet<T> where
<T as EnumSetTypePrivate>::Repr: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Calls the given closure and return the result. Read more
Calls the given closure on self
.