X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=enumset%2Fsrc%2Flib.rs;h=98c7977688f6c1b4af9d06b68b0eee7b04503c5a;hb=d7e5400b12109ab17d74df1a2e2ff928d4f1edfd;hp=60da4b3719f29acc72e0bc24c3bf240330fb3ec2;hpb=e2ad1d0346bac47f1fb254121fe345620244b86f;p=enumset.git diff --git a/enumset/src/lib.rs b/enumset/src/lib.rs index 60da4b3..98c7977 100644 --- a/enumset/src/lib.rs +++ b/enumset/src/lib.rs @@ -18,6 +18,8 @@ //! } //! ``` //! +//! For more information on more advanced use cases, see the documentation for [`EnumSetType`]. +//! //! # Working with EnumSets //! //! EnumSets can be constructed via [`EnumSet::new()`] like a normal set. In addition, @@ -32,7 +34,7 @@ //! //! All bitwise operations you would expect to work on bitsets also work on both EnumSets and //! enums with `#[derive(EnumSetType)]`: -//! ``` +//! ```rust //! # use enumset::*; //! # #[derive(EnumSetType, Debug)] pub enum Enum { A, B, C, D, E, F, G } //! // Intersection of sets @@ -60,7 +62,7 @@ //! assert_eq!(CONST_SET, Enum::A | Enum::B); //! ``` //! -//! Mutable operations on the [`EnumSet`] otherwise work basically as expected: +//! Mutable operations on the [`EnumSet`] otherwise similarly to Rust's builtin sets: //! //! ```rust //! # use enumset::*; @@ -73,66 +75,68 @@ //! assert_eq!(set, Enum::A | Enum::E | Enum::G); //! ``` -extern crate enumset_derive; -extern crate num_traits; -#[cfg(feature = "serde")] extern crate serde2 as serde; - -pub use enumset_derive::*; -mod enumset { pub use super::*; } +pub use enumset_derive::EnumSetType; use core::cmp::Ordering; use core::fmt; use core::fmt::{Debug, Formatter}; use core::hash::{Hash, Hasher}; +use core::iter::{FromIterator, Sum}; use core::ops::*; -use num_traits::*; - #[doc(hidden)] /// Everything in this module is internal API and may change at any time. -pub mod internal { +pub mod __internal { use super::*; - /// A struct used to type check [`enum_set!`]. - pub struct EnumSetSameTypeHack<'a, T: EnumSetType + 'static> { - pub unified: &'a [T], - pub enum_set: EnumSet, - } - /// A reexport of core to allow our macros to be generic to std vs core. - pub extern crate core; + pub use ::core as core_export; /// A reexport of serde so there is no requirement to depend on serde. - #[cfg(feature = "serde")] pub extern crate serde2 as serde; -} - -mod private { - use super::*; - pub trait EnumSetTypeRepr : PrimInt + FromPrimitive + WrappingSub + CheckedShl + Debug + Hash { - const WIDTH: u8; + #[cfg(feature = "serde")] pub use serde2 as serde; + + /// The actual members of EnumSetType. Put here to avoid polluting global namespaces. + pub unsafe trait EnumSetTypePrivate { + /// The underlying type used to store the bitset. + type Repr: EnumSetTypeRepr; + /// A mask of bits that are valid in the bitset. + const ALL_BITS: Self::Repr; + + /// Converts an enum of this type into its bit position. + fn enum_into_u32(self) -> u32; + /// Converts a bit position into an enum value. + unsafe fn enum_from_u32(val: u32) -> Self; + + /// Serializes the `EnumSet`. + /// + /// This and `deserialize` are part of the `EnumSetType` trait so the procedural derive + /// can control how `EnumSet` is serialized. + #[cfg(feature = "serde")] + fn serialize(set: EnumSet, ser: S) -> Result + where Self: EnumSetType; + /// Deserializes the `EnumSet`. + #[cfg(feature = "serde")] + fn deserialize<'de, D: serde::Deserializer<'de>>(de: D) -> Result, D::Error> + where Self: EnumSetType; } - macro_rules! prim { - ($name:ty, $width:expr) => { - impl EnumSetTypeRepr for $name { - const WIDTH: u8 = $width; - } - } - } - prim!(u8 , 8 ); - prim!(u16 , 16 ); - prim!(u32 , 32 ); - prim!(u64 , 64 ); - prim!(u128, 128); } -use private::EnumSetTypeRepr; +use crate::__internal::EnumSetTypePrivate; +#[cfg(feature = "serde")] use crate::__internal::serde; +#[cfg(feature = "serde")] use crate::serde::{Serialize, Deserialize}; + +mod repr; +use crate::repr::EnumSetTypeRepr; /// The trait used to define enum types that may be used with [`EnumSet`]. /// /// This trait should be implemented using `#[derive(EnumSetType)]`. Its internal structure is -/// not currently stable, and may change at any time. +/// not stable, and may change at any time. /// /// # Custom Derive /// +/// Any C-like enum is supported, as long as there are no more than 128 variants in the enum, +/// and no variant discriminator is larger than 127. +/// /// The custom derive for [`EnumSetType`] automatically creates implementations of [`PartialEq`], /// [`Sub`], [`BitAnd`], [`BitOr`], [`BitXor`], and [`Not`] allowing the enum to be used as /// if it were an [`EnumSet`] in expressions. This can be disabled by adding an `#[enumset(no_ops)]` @@ -141,8 +145,12 @@ use private::EnumSetTypeRepr; /// The custom derive for `EnumSetType` automatically implements [`Copy`], [`Clone`], [`Eq`], and /// [`PartialEq`] on the enum. These are required for the [`EnumSet`] to function. /// -/// Any C-like enum is supported, as long as there are no more than 128 variants in the enum, -/// and no variant discriminator is larger than 127. +/// In addition, if you have renamed the `enumset` crate in your crate, you can use the +/// `#[enumset(crate_name = "enumset2")]` attribute to tell the custom derive to use that name +/// instead. +/// +/// Attributes controlling the serialization of an `EnumSet` are documented in +/// [its documentation](./struct.EnumSet.html#serialization). /// /// # Examples /// @@ -176,195 +184,270 @@ use private::EnumSetTypeRepr; /// A, B, C, D, E, F, G, /// } /// ``` -pub unsafe trait EnumSetType: Copy + Eq { - #[doc(hidden)] type Repr: EnumSetTypeRepr; - #[doc(hidden)] const ALL_BITS: Self::Repr; - #[doc(hidden)] fn enum_into_u8(self) -> u8; - #[doc(hidden)] unsafe fn enum_from_u8(val: u8) -> Self; - - #[cfg(feature = "serde")] #[doc(hidden)] - fn serialize(set: EnumSet, ser: S) -> Result; - #[cfg(feature = "serde")] #[doc(hidden)] - fn deserialize<'de, D: serde::Deserializer<'de>>(de: D) -> Result, D::Error>; -} +pub unsafe trait EnumSetType: Copy + Eq + EnumSetTypePrivate { } /// 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 /// -/// The default representation serializes enumsets as an `u8`, `u16`, `u32`, `u64`, or `u128`, -/// whichever is the smallest that can contain all bits that are part of the set. +/// 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. /// -/// Unknown bits are ignored, and are simply dropped. To override this behavior, you can add a -/// `#[enumset(serialize_deny_unknown)]` annotation to your enum. +/// 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`. /// -/// You can add a `#[enumset(serialize_repr = "u8")]` annotation to your enum to explicitly set -/// the bit width the `EnumSet` is serialized as. This can be used to avoid breaking changes in -/// certain serialization formats (such as `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)]` annotation causes the `EnumSet` to be -/// instead serialized as a list. This requires your enum type implement [`Serialize`] and -/// [`Deserialize`]. +/// 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 #[derive(Copy, Clone, PartialEq, Eq)] -pub struct EnumSet { +#[repr(transparent)] +pub struct EnumSet { #[doc(hidden)] /// This is public due to the [`enum_set!`] macro. /// This is **NOT** public API and may change at any time. - pub __enumset_underlying: T::Repr + pub __priv_repr: T::Repr } -impl EnumSet { - fn mask(bit: u8) -> T::Repr { - Shl::::shl(T::Repr::one(), bit as usize) - } - fn has_bit(&self, bit: u8) -> bool { - let mask = Self::mask(bit); - self.__enumset_underlying & mask == mask - } - fn partial_bits(bits: u8) -> T::Repr { - T::Repr::one().checked_shl(bits.into()) - .unwrap_or(T::Repr::zero()) - .wrapping_sub(&T::Repr::one()) - } - +impl EnumSet { // Returns all bits valid for the enum fn all_bits() -> T::Repr { T::ALL_BITS } - /// Returns an empty set. + /// Creates an empty `EnumSet`. pub fn new() -> Self { - EnumSet { __enumset_underlying: T::Repr::zero() } + EnumSet { __priv_repr: T::Repr::empty() } } - /// Returns a set containing a single value. + /// Returns an `EnumSet` containing a single element. pub fn only(t: T) -> Self { - EnumSet { __enumset_underlying: Self::mask(t.enum_into_u8()) } + let mut set = Self::new(); + set.insert(t); + set } - /// Returns an empty set. + /// Creates an empty `EnumSet`. + /// + /// This is an alias for [`EnumSet::new`]. pub fn empty() -> Self { Self::new() } - /// Returns a set with all bits set. + + /// Returns an `EnumSet` containing all valid variants of the enum. pub fn all() -> Self { - EnumSet { __enumset_underlying: Self::all_bits() } + EnumSet { __priv_repr: Self::all_bits() } } - /// Total number of bits this enumset uses. Note that the actual amount of space used is + /// 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 bit_width() -> u8 { - T::Repr::WIDTH - T::ALL_BITS.leading_zeros() as u8 + pub fn bit_width() -> u32 { + T::Repr::WIDTH - T::ALL_BITS.leading_zeros() } - /// The number of valid variants in this enumset. + /// 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 variant_count() -> u8 { - T::ALL_BITS.count_ones() as u8 + pub fn variant_count() -> u32 { + T::ALL_BITS.count_ones() } - /// Returns the raw bits of this set - pub fn to_bits(&self) -> u128 { - self.__enumset_underlying.to_u128() - .expect("Impossible: Bits cannot be to converted into i128?") - } - - /// Constructs a bitset from raw bits. - /// - /// # Panics - /// If bits not in the enum are set. - pub fn from_bits(bits: u128) -> Self { - assert!((bits & !Self::all().to_bits()) == 0, "Bits not valid for the enum were set."); - EnumSet { - __enumset_underlying: T::Repr::from_u128(bits) - .expect("Impossible: Valid bits too large to fit in repr?") - } - } - - /// Returns the number of values in this set. + /// Returns the number of elements in this set. pub fn len(&self) -> usize { - self.__enumset_underlying.count_ones() as usize + self.__priv_repr.count_ones() as usize } - /// Checks if the set is empty. + /// Returns `true` if the set contains no elements. pub fn is_empty(&self) -> bool { - self.__enumset_underlying.is_zero() + self.__priv_repr.is_empty() } /// Removes all elements from the set. pub fn clear(&mut self) { - self.__enumset_underlying = T::Repr::zero() + self.__priv_repr = T::Repr::empty() } - /// Checks if this set shares no elements with another. + /// Returns `true` if `self` has no elements in common with `other`. This is equivalent to + /// checking for an empty intersection. pub fn is_disjoint(&self, other: Self) -> bool { (*self & other).is_empty() } - /// Checks if all elements in another set are in this set. + /// Returns `true` if the set is a superset of another, i.e., `self` contains at least all the + /// values in `other`. pub fn is_superset(&self, other: Self) -> bool { - (*self & other).__enumset_underlying == other.__enumset_underlying + (*self & other).__priv_repr == other.__priv_repr } - /// Checks if all elements of this set are in another set. + /// Returns `true` if the set is a subset of another, i.e., `other` contains at least all + /// the values in `self`. pub fn is_subset(&self, other: Self) -> bool { other.is_superset(*self) } - /// Returns a set containing the union of all elements in both sets. + /// Returns a set containing any elements present in either set. pub fn union(&self, other: Self) -> Self { - EnumSet { __enumset_underlying: self.__enumset_underlying | other.__enumset_underlying } + EnumSet { __priv_repr: self.__priv_repr | other.__priv_repr } } - /// Returns a set containing all elements in common with another set. + /// Returns a set containing every element present in both sets. pub fn intersection(&self, other: Self) -> Self { - EnumSet { __enumset_underlying: self.__enumset_underlying & other.__enumset_underlying } + EnumSet { __priv_repr: self.__priv_repr & other.__priv_repr } } - /// Returns a set with all elements of the other set removed. + /// Returns a set containing element present in `self` but not in `other`. pub fn difference(&self, other: Self) -> Self { - EnumSet { __enumset_underlying: self.__enumset_underlying & !other.__enumset_underlying } + EnumSet { __priv_repr: self.__priv_repr.and_not(other.__priv_repr) } } - /// Returns a set with all elements not contained in both sets. + /// Returns a set containing every element present in either `self` or `other`, but is not + /// present in both. pub fn symmetrical_difference(&self, other: Self) -> Self { - EnumSet { __enumset_underlying: self.__enumset_underlying ^ other.__enumset_underlying } + EnumSet { __priv_repr: self.__priv_repr ^ other.__priv_repr } } - /// Returns a set containing all elements not in this set. + /// Returns a set containing all enum variants not in this set. pub fn complement(&self) -> Self { - EnumSet { __enumset_underlying: !self.__enumset_underlying & Self::all_bits() } + EnumSet { __priv_repr: !self.__priv_repr & Self::all_bits() } } /// Checks whether this set contains a value. pub fn contains(&self, value: T) -> bool { - self.has_bit(value.enum_into_u8()) + self.__priv_repr.has_bit(value.enum_into_u32()) } /// 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 insert(&mut self, value: T) -> bool { - let contains = self.contains(value); - self.__enumset_underlying = self.__enumset_underlying | Self::mask(value.enum_into_u8()); + let contains = !self.contains(value); + self.__priv_repr.add_bit(value.enum_into_u32()); contains } - /// Removes a value from this set. + /// Removes a value from this set. Returns whether the value was present in the set. pub fn remove(&mut self, value: T) -> bool { let contains = self.contains(value); - self.__enumset_underlying = self.__enumset_underlying & !Self::mask(value.enum_into_u8()); + self.__priv_repr.remove_bit(value.enum_into_u32()); contains } /// Adds all elements in another set to this one. pub fn insert_all(&mut self, other: Self) { - self.__enumset_underlying = self.__enumset_underlying | other.__enumset_underlying + self.__priv_repr = self.__priv_repr | other.__priv_repr } /// Removes all values in another set from this one. pub fn remove_all(&mut self, other: Self) { - self.__enumset_underlying = self.__enumset_underlying & !other.__enumset_underlying + self.__priv_repr = self.__priv_repr.and_not(other.__priv_repr); } /// 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. pub fn iter(&self) -> EnumSetIter { - EnumSetIter(*self, 0) + EnumSetIter(*self) } } +/// Helper macro for generating conversion functions. +macro_rules! conversion_impls { + ( + $(for_num!( + $underlying:ty, $underlying_str:expr, + $from_fn:ident $to_fn:ident $from_fn_opt:ident $to_fn_opt:ident, + $from:ident $try_from:ident $from_truncated:ident + $to:ident $try_to:ident $to_truncated:ident + );)* + ) => { + impl EnumSet {$( + #[doc = "Returns a `"] + #[doc = $underlying_str] + #[doc = "` representing the elements of this set.\n\nIf the underlying bitset will \ + not fit in a `"] + #[doc = $underlying_str] + #[doc = "`, this method will panic."] + pub fn $to(&self) -> $underlying { + self.$try_to().expect("Bitset will not fit into this type.") + } + + #[doc = "Tries to return a `"] + #[doc = $underlying_str] + #[doc = "` representing the elements of this set.\n\nIf the underlying bitset will \ + not fit in a `"] + #[doc = $underlying_str] + #[doc = "`, this method will instead return `None`."] + pub fn $try_to(&self) -> Option<$underlying> { + EnumSetTypeRepr::$to_fn_opt(&self.__priv_repr) + } + + #[doc = "Returns a truncated `"] + #[doc = $underlying_str] + #[doc = "` representing the elements of this set.\n\nIf the underlying bitset will \ + not fit in a `"] + #[doc = $underlying_str] + #[doc = "`, this method will truncate any bits that don't fit."] + pub fn $to_truncated(&self) -> $underlying { + EnumSetTypeRepr::$to_fn(&self.__priv_repr) + } + + #[doc = "Constructs a bitset from a `"] + #[doc = $underlying_str] + #[doc = "`.\n\nIf a bit that doesn't correspond to an enum variant is set, this \ + method will panic."] + pub fn $from(bits: $underlying) -> Self { + Self::$try_from(bits).expect("Bitset contains invalid variants.") + } + + #[doc = "Attempts to constructs a bitset from a `"] + #[doc = $underlying_str] + #[doc = "`.\n\nIf a bit that doesn't correspond to an enum variant is set, this \ + method will return `None`."] + pub fn $try_from(bits: $underlying) -> Option { + let bits = T::Repr::$from_fn_opt(bits); + let mask = Self::all().__priv_repr; + bits.and_then(|bits| if bits.and_not(mask).is_empty() { + Some(EnumSet { __priv_repr: bits }) + } else { + None + }) + } + + #[doc = "Constructs a bitset from a `"] + #[doc = $underlying_str] + #[doc = "`, ignoring invalid variants."] + pub fn $from_truncated(bits: $underlying) -> Self { + let mask = Self::all().$to_truncated(); + let bits = ::$from_fn(bits & mask); + EnumSet { __priv_repr: bits } + } + )*} + } +} +conversion_impls! { + for_num!(u8, "u8", from_u8 to_u8 from_u8_opt to_u8_opt, + from_u8 try_from_u8 from_u8_truncated as_u8 try_as_u8 as_u8_truncated); + for_num!(u16, "u16", from_u16 to_u16 from_u16_opt to_u16_opt, + from_u16 try_from_u16 from_u16_truncated as_u16 try_as_u16 as_u16_truncated); + for_num!(u32, "u32", from_u32 to_u32 from_u32_opt to_u32_opt, + from_u32 try_from_u32 from_u32_truncated as_u32 try_as_u32 as_u32_truncated); + for_num!(u64, "u64", from_u64 to_u64 from_u64_opt to_u64_opt, + from_u64 try_from_u64 from_u64_truncated as_u64 try_as_u64 as_u64_truncated); + for_num!(u128, "u128", from_u128 to_u128 from_u128_opt to_u128_opt, + from_u128 try_from_u128 from_u128_truncated as_u128 try_as_u128 as_u128_truncated); + for_num!(usize, "usize", from_usize to_usize from_usize_opt to_usize_opt, + from_usize try_from_usize from_usize_truncated + as_usize try_as_usize as_usize_truncated); +} + impl Default for EnumSet { /// Returns an empty set. fn default() -> Self { @@ -372,7 +455,7 @@ impl Default for EnumSet { } } -impl IntoIterator for EnumSet { +impl IntoIterator for EnumSet { type Item = T; type IntoIter = EnumSetIter; @@ -380,73 +463,93 @@ impl IntoIterator for EnumSet { self.iter() } } +impl Sum for EnumSet { + fn sum>(iter: I) -> Self { + iter.fold(EnumSet::empty(), |a, v| a | v) + } +} +impl <'a, T: EnumSetType> Sum<&'a EnumSet> for EnumSet { + fn sum>(iter: I) -> Self { + iter.fold(EnumSet::empty(), |a, v| a | *v) + } +} +impl Sum for EnumSet { + fn sum>(iter: I) -> Self { + iter.fold(EnumSet::empty(), |a, v| a | v) + } +} +impl <'a, T: EnumSetType> Sum<&'a T> for EnumSet { + fn sum>(iter: I) -> Self { + iter.fold(EnumSet::empty(), |a, v| a | *v) + } +} -impl >> Sub for EnumSet { +impl >> Sub for EnumSet { type Output = Self; fn sub(self, other: O) -> Self::Output { self.difference(other.into()) } } -impl >> BitAnd for EnumSet { +impl >> BitAnd for EnumSet { type Output = Self; fn bitand(self, other: O) -> Self::Output { self.intersection(other.into()) } } -impl >> BitOr for EnumSet { +impl >> BitOr for EnumSet { type Output = Self; fn bitor(self, other: O) -> Self::Output { self.union(other.into()) } } -impl >> BitXor for EnumSet { +impl >> BitXor for EnumSet { type Output = Self; fn bitxor(self, other: O) -> Self::Output { self.symmetrical_difference(other.into()) } } -impl >> SubAssign for EnumSet { +impl >> SubAssign for EnumSet { fn sub_assign(&mut self, rhs: O) { *self = *self - rhs; } } -impl >> BitAndAssign for EnumSet { +impl >> BitAndAssign for EnumSet { fn bitand_assign(&mut self, rhs: O) { *self = *self & rhs; } } -impl >> BitOrAssign for EnumSet { +impl >> BitOrAssign for EnumSet { fn bitor_assign(&mut self, rhs: O) { *self = *self | rhs; } } -impl >> BitXorAssign for EnumSet { +impl >> BitXorAssign for EnumSet { fn bitxor_assign(&mut self, rhs: O) { *self = *self ^ rhs; } } -impl Not for EnumSet { +impl Not for EnumSet { type Output = Self; fn not(self) -> Self::Output { self.complement() } } -impl From for EnumSet { +impl From for EnumSet { fn from(t: T) -> Self { EnumSet::only(t) } } -impl PartialEq for EnumSet { +impl PartialEq for EnumSet { fn eq(&self, other: &T) -> bool { - self.__enumset_underlying == EnumSet::::mask(other.enum_into_u8()) + self.__priv_repr == EnumSet::only(*other).__priv_repr } } -impl Debug for EnumSet { - fn fmt(&self, f: &mut Formatter) -> fmt::Result { +impl Debug for EnumSet { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { let mut is_first = true; f.write_str("EnumSet(")?; for v in self.iter() { @@ -459,66 +562,94 @@ impl Debug for EnumSet { } } +#[allow(clippy::derive_hash_xor_eq)] // This impl exists to change trait bounds only. impl Hash for EnumSet { fn hash(&self, state: &mut H) { - self.__enumset_underlying.hash(state) + self.__priv_repr.hash(state) } } impl PartialOrd for EnumSet { fn partial_cmp(&self, other: &Self) -> Option { - self.__enumset_underlying.partial_cmp(&other.__enumset_underlying) + self.__priv_repr.partial_cmp(&other.__priv_repr) } } impl Ord for EnumSet { fn cmp(&self, other: &Self) -> Ordering { - self.__enumset_underlying.cmp(&other.__enumset_underlying) + self.__priv_repr.cmp(&other.__priv_repr) } } #[cfg(feature = "serde")] -impl serde::Serialize for EnumSet { +impl Serialize for EnumSet { fn serialize(&self, serializer: S) -> Result { T::serialize(*self, serializer) } } #[cfg(feature = "serde")] -impl <'de, T : EnumSetType> serde::Deserialize<'de> for EnumSet { +impl <'de, T: EnumSetType> Deserialize<'de> for EnumSet { fn deserialize>(deserializer: D) -> Result { T::deserialize(deserializer) } } -/// The iterator used by [`EnumSet`](./struct.EnumSet.html). -#[derive(Copy, Clone, PartialOrd, Ord, PartialEq, Eq, Hash, Debug)] -pub struct EnumSetIter(EnumSet, u8); -impl Iterator for EnumSetIter { +/// The iterator used by [`EnumSet`]s. +#[derive(Clone, Debug)] +pub struct EnumSetIter(EnumSet); +impl Iterator for EnumSetIter { type Item = T; fn next(&mut self) -> Option { - while self.1 < EnumSet::::bit_width() { - let bit = self.1; - self.1 += 1; - if self.0.has_bit(bit) { - return unsafe { Some(T::enum_from_u8(bit)) } - } + if self.0.is_empty() { + None + } else { + let bit = self.0.__priv_repr.trailing_zeros(); + self.0.__priv_repr.remove_bit(bit); + unsafe { Some(T::enum_from_u32(bit)) } } - None } fn size_hint(&self) -> (usize, Option) { - let left_mask = EnumSet::::partial_bits(self.1); - let left = (self.0.__enumset_underlying & left_mask).count_ones() as usize; + let left = self.0.len(); (left, Some(left)) } } +impl ExactSizeIterator for EnumSetIter {} + +impl Extend for EnumSet { + fn extend>(&mut self, iter: I) { + iter.into_iter().for_each(|v| { self.insert(v); }); + } +} + +impl FromIterator for EnumSet { + fn from_iter>(iter: I) -> Self { + let mut set = EnumSet::default(); + set.extend(iter); + set + } +} + +impl Extend> for EnumSet { + fn extend>>(&mut self, iter: I) { + iter.into_iter().for_each(|v| { self.insert_all(v); }); + } +} + +impl FromIterator> for EnumSet { + fn from_iter>>(iter: I) -> Self { + let mut set = EnumSet::default(); + set.extend(iter); + set + } +} + /// Creates a EnumSet literal, which can be used in const contexts. /// /// The syntax used is `enum_set!(Type::A | Type::B | Type::C)`. Each variant must be of the same /// type, or a error will occur at compile-time. /// -/// You may also explicitly state the type of the variants that follow, as in -/// `enum_set!(Type, Type::A | Type::B | Type::C)`. +/// This macro accepts trailing `|`s to allow easier use in other macros. /// /// # Examples /// @@ -527,9 +658,6 @@ impl Iterator for EnumSetIter { /// # #[derive(EnumSetType, Debug)] enum Enum { A, B, C } /// const CONST_SET: EnumSet = enum_set!(Enum::A | Enum::B); /// assert_eq!(CONST_SET, Enum::A | Enum::B); -/// -/// const EXPLICIT_CONST_SET: EnumSet = enum_set!(Enum, Enum::A | Enum::B); -/// assert_eq!(EXPLICIT_CONST_SET, Enum::A | Enum::B); /// ``` /// /// This macro is strongly typed. For example, the following will not compile: @@ -542,20 +670,20 @@ impl Iterator for EnumSetIter { /// ``` #[macro_export] macro_rules! enum_set { - () => { - $crate::EnumSet { __enumset_underlying: 0 } + ($(|)*) => { + $crate::EnumSet { __priv_repr: 0 } }; - ($($value:path)|* $(|)*) => { - $crate::internal::EnumSetSameTypeHack { - unified: &[$($value,)*], - enum_set: $crate::EnumSet { - __enumset_underlying: 0 $(| (1 << ($value as u8)))* - }, - }.enum_set + ($value:path $(|)*) => { + { + #[allow(deprecated)] let value = $value.__impl_enumset_internal__const_only(); + value + } }; - ($enum_name:ty, $($value:path)|* $(|)*) => { - $crate::EnumSet::<$enum_name> { - __enumset_underlying: 0 $(| (1 << ($value as $enum_name as u8)))* + ($value:path | $($rest:path)|* $(|)*) => { + { + #[allow(deprecated)] let value = $value.__impl_enumset_internal__const_only(); + $(#[allow(deprecated)] let value = $rest.__impl_enumset_internal__const_merge(value);)* + value } - } + }; }