enumset/src/lib.rs

   1 #![no_std]
   2 #![forbid(missing_docs)]
   3
   4 // The safety requirement is "use the procedural derive".
   5 #![allow(clippy::missing_safety_doc)]
   6
   7 //! A library for defining enums that can be used in compact bit sets. It supports enums up to 128
   8 //! variants, and has a macro to use these sets in constants.
   9 //!
  10 //! For serde support, enable the `serde` feature.
  11 //!
  12 //! # Defining enums for use with EnumSet
  13 //!
  14 //! Enums to be used with [`EnumSet`] should be defined using `#[derive(EnumSetType)]`:
  15 //!
  16 //! ```rust
  17 //! # use enumset::*;
  18 //! #[derive(EnumSetType, Debug)]
  19 //! pub enum Enum {
  20 //!    A, B, C, D, E, F, G,
  21 //! }
  22 //! ```
  23 //!
  24 //! For more information on more advanced use cases, see the documentation for
  25 //! [`#[derive(EnumSetType)]`](./derive.EnumSetType.html).
  26 //!
  27 //! # Working with EnumSets
  28 //!
  29 //! EnumSets can be constructed via [`EnumSet::new()`] like a normal set. In addition,
  30 //! `#[derive(EnumSetType)]` creates operator overloads that allow you to create EnumSets like so:
  31 //!
  32 //! ```rust
  33 //! # use enumset::*;
  34 //! # #[derive(EnumSetType, Debug)] pub enum Enum { A, B, C, D, E, F, G }
  35 //! let new_set = Enum::A | Enum::C | Enum::G;
  36 //! assert_eq!(new_set.len(), 3);
  37 //! ```
  38 //!
  39 //! All bitwise operations you would expect to work on bitsets also work on both EnumSets and
  40 //! enums with `#[derive(EnumSetType)]`:
  41 //! ```rust
  42 //! # use enumset::*;
  43 //! # #[derive(EnumSetType, Debug)] pub enum Enum { A, B, C, D, E, F, G }
  44 //! // Intersection of sets
  45 //! assert_eq!((Enum::A | Enum::B) & Enum::C, EnumSet::empty());
  46 //! assert_eq!((Enum::A | Enum::B) & Enum::A, Enum::A);
  47 //! assert_eq!(Enum::A & Enum::B, EnumSet::empty());
  48 //!
  49 //! // Symmetric difference of sets
  50 //! assert_eq!((Enum::A | Enum::B) ^ (Enum::B | Enum::C), Enum::A | Enum::C);
  51 //! assert_eq!(Enum::A ^ Enum::C, Enum::A | Enum::C);
  52 //!
  53 //! // Difference of sets
  54 //! assert_eq!((Enum::A | Enum::B | Enum::C) - Enum::B, Enum::A | Enum::C);
  55 //!
  56 //! // Complement of sets
  57 //! assert_eq!(!(Enum::E | Enum::G), Enum::A | Enum::B | Enum::C | Enum::D | Enum::F);
  58 //! ```
  59 //!
  60 //! The [`enum_set!`] macro allows you to create EnumSets in constant contexts:
  61 //!
  62 //! ```rust
  63 //! # use enumset::*;
  64 //! # #[derive(EnumSetType, Debug)] pub enum Enum { A, B, C, D, E, F, G }
  65 //! const CONST_SET: EnumSet<Enum> = enum_set!(Enum::A | Enum::B);
  66 //! assert_eq!(CONST_SET, Enum::A | Enum::B);
  67 //! ```
  68 //!
  69 //! Mutable operations on the [`EnumSet`] otherwise similarly to Rust's builtin sets:
  70 //!
  71 //! ```rust
  72 //! # use enumset::*;
  73 //! # #[derive(EnumSetType, Debug)] pub enum Enum { A, B, C, D, E, F, G }
  74 //! let mut set = EnumSet::new();
  75 //! set.insert(Enum::A);
  76 //! set.insert_all(Enum::E | Enum::G);
  77 //! assert!(set.contains(Enum::A));
  78 //! assert!(!set.contains(Enum::B));
  79 //! assert_eq!(set, Enum::A | Enum::E | Enum::G);
  80 //! ```
  81
  82 use core::cmp::Ordering;
  83 use core::fmt;
  84 use core::fmt::{Debug, Formatter};
  85 use core::hash::{Hash, Hasher};
  86 use core::iter::{FromIterator, Sum};
  87 use core::ops::*;
  88
  89 #[doc(hidden)]
  90 /// Everything in this module is internal API and may change at any time.
  91 pub mod __internal {
  92     use super::*;
  93
  94     /// A reexport of core to allow our macros to be generic to std vs core.
  95     pub use ::core as core_export;
  96
  97     /// A reexport of serde so there is no requirement to depend on serde.
  98     #[cfg(feature = "serde")] pub use serde2 as serde;
  99
 100     /// The actual members of EnumSetType. Put here to avoid polluting global namespaces.
 101     pub unsafe trait EnumSetTypePrivate {
 102         /// The underlying type used to store the bitset.
 103         type Repr: EnumSetTypeRepr;
 104         /// A mask of bits that are valid in the bitset.
 105         const ALL_BITS: Self::Repr;
 106
 107         /// Converts an enum of this type into its bit position.
 108         fn enum_into_u32(self) -> u32;
 109         /// Converts a bit position into an enum value.
 110         unsafe fn enum_from_u32(val: u32) -> Self;
 111
 112         /// Serializes the `EnumSet`.
 113         ///
 114         /// This and `deserialize` are part of the `EnumSetType` trait so the procedural derive
 115         /// can control how `EnumSet` is serialized.
 116         #[cfg(feature = "serde")]
 117         fn serialize<S: serde::Serializer>(set: EnumSet<Self>, ser: S) -> Result<S::Ok, S::Error>
 118             where Self: EnumSetType;
 119         /// Deserializes the `EnumSet`.
 120         #[cfg(feature = "serde")]
 121         fn deserialize<'de, D: serde::Deserializer<'de>>(de: D) -> Result<EnumSet<Self>, D::Error>
 122             where Self: EnumSetType;
 123     }
 124 }
 125 use crate::__internal::EnumSetTypePrivate;
 126 #[cfg(feature = "serde")] use crate::__internal::serde;
 127 #[cfg(feature = "serde")] use crate::serde::{Serialize, Deserialize};
 128
 129 mod repr;
 130 use crate::repr::EnumSetTypeRepr;
 131
 132 /// The procedural macro used to derive [`EnumSetType`], and allow enums to be used with
 133 /// [`EnumSet`].
 134 ///
 135 /// It may be used with any enum with no data fields, at most 127 variants, and no variant
 136 /// discriminators larger than 127.
 137 ///
 138 /// # Additional Impls
 139 ///
 140 /// In addition to the implementation of `EnumSetType`, this procedural macro creates multiple
 141 /// other impls that are either required for the macro to work, or make the procedural macro more
 142 /// ergonomic to use.
 143 ///
 144 /// A full list of traits implemented as is follows:
 145 ///
 146 /// * [`Copy`], [`Clone`], [`Eq`], [`PartialEq`] implementations are created to allow `EnumSet`
 147 ///   to function properly. These automatic implementations may be suppressed using
 148 ///   `#[enumset(no_super_impls)]`, but these traits must still be implemented in another way.
 149 /// * [`PartialEq`], [`Sub`], [`BitAnd`], [`BitOr`], [`BitXor`], and [`Not`] implementations are
 150 ///   created to allow the crate to be used more ergonomically in expressions. These automatic
 151 ///   implementations may be suppressed using `#[enumset(no_ops)]`.
 152 ///
 153 /// # Options
 154 ///
 155 /// Options are given with `#[enumset(foo)]` annotations attached to the same enum as the derive.
 156 /// Multiple options may be given in the same annotation using the `#[enumset(foo, bar)]` syntax.
 157 ///
 158 /// A full list of options is as follows:
 159 ///
 160 /// * `#[enumset(no_super_impls)]` prevents the derive from creating implementations required for
 161 ///   [`EnumSet`] to function. When this attribute is specified, implementations of [`Copy`],
 162 ///   [`Clone`], [`Eq`], and [`PartialEq`]. This can be useful if you are using a code generator
 163 ///   that already derives these traits. These impls should function identically to the
 164 ///   automatically derived versions, or unintentional behavior may be a result.
 165 /// * `#[enumset(no_ops)` prevents the derive from implementing any operator traits.
 166 /// * `#[enumset(crate_name = "enumset2")]` may be used to change the name of the `enumset` crate
 167 ///   used in the generated code, if you have renamed the crate via cargo options.
 168 ///
 169 /// When the `serde` feature is used, the following features may also be specified. These options
 170 /// may be used (with no effect) when building without the feature enabled:
 171 ///
 172 /// * `#[enumset(serialize_repr = "u8")]` may be used to specify the integer type used to serialize
 173 ///   the underlying bitset.
 174 /// * `#[enumset(serialize_as_list)]` may be used to serialize the bitset as a list of enum
 175 ///   variants instead of an integer. This requires [`Deserialize`] and [`Serialize`] be
 176 ///   implemented on the enum.
 177 /// * `#[enumset(serialize_deny_unknown)]` causes the generated deserializer to return an error
 178 ///   for unknown bits instead of silently ignoring them.
 179 ///
 180 /// # Examples
 181 ///
 182 /// Deriving a plain EnumSetType:
 183 ///
 184 /// ```rust
 185 /// # use enumset::*;
 186 /// #[derive(EnumSetType)]
 187 /// pub enum Enum {
 188 ///    A, B, C, D, E, F, G,
 189 /// }
 190 /// ```
 191 ///
 192 /// Deriving a sparse EnumSetType:
 193 ///
 194 /// ```rust
 195 /// # use enumset::*;
 196 /// #[derive(EnumSetType)]
 197 /// pub enum SparseEnum {
 198 ///    A = 10, B = 20, C = 30, D = 127,
 199 /// }
 200 /// ```
 201 ///
 202 /// Deriving an EnumSetType without adding ops:
 203 ///
 204 /// ```rust
 205 /// # use enumset::*;
 206 /// #[derive(EnumSetType)]
 207 /// #[enumset(no_ops)]
 208 /// pub enum NoOpsEnum {
 209 ///    A, B, C, D, E, F, G,
 210 /// }
 211 /// ```
 212 pub use enumset_derive::EnumSetType;
 213
 214 /// The trait used to define enum types that may be used with [`EnumSet`].
 215 ///
 216 /// This trait must be impelmented using `#[derive(EnumSetType)]`, is not public API, and its
 217 /// internal structure may change at any time with no warning.
 218 ///
 219 /// For full documentation on the procedural derive and its options, see
 220 /// [`#[derive(EnumSetType)]`](./derive.EnumSetType.html).
 221 pub unsafe trait EnumSetType: Copy + Eq + EnumSetTypePrivate { }
 222
 223 /// An efficient set type for enums.
 224 ///
 225 /// It is implemented using a bitset stored using the smallest integer that can fit all bits
 226 /// in the underlying enum. In general, an enum variant with a discriminator of `n` is stored in
 227 /// the nth least significant bit (corresponding with a mask of, e.g. `1 << enum as u32`).
 228 ///
 229 /// # Numeric representation
 230 ///
 231 /// `EnumSet` is internally implemented using integer types, and as such can be easily converted
 232 /// from and to numbers.
 233 ///
 234 /// Each bit of the underlying integer corresponds to at most one particular enum variant. If the
 235 /// corresponding bit for a variant is set, it present in the set. Bits that do not correspond to
 236 /// any variant are always unset.
 237 ///
 238 /// By default, each enum variant is stored in a bit corresponding to its discriminator. An enum
 239 /// variant with a discriminator of `n` is stored in the `n + 1`th least significant bit
 240 /// (corresponding to a mask of e.g. `1 << enum as u32`).
 241 ///
 242 /// # Serialization
 243 ///
 244 /// When the `serde` feature is enabled, `EnumSet`s can be serialized and deserialized using
 245 /// the `serde` crate. The exact serialization format can be controlled with additional attributes
 246 /// on the enum type. These attributes are valid regardless of whether the `serde` feature
 247 /// is enabled.
 248 ///
 249 /// By default, `EnumSet`s serialize by directly writing out the underlying bitset as an integer
 250 /// of the smallest type that can fit in the underlying enum. You can add a
 251 /// `#[enumset(serialize_repr = "u8")]` attribute to your enum to control the integer type used
 252 /// for serialization. This can be important for avoiding unintentional breaking changes when
 253 /// `EnumSet`s are serialized with formats like `bincode`.
 254 ///
 255 /// By default, unknown bits are ignored and silently removed from the bitset. To override thris
 256 /// behavior, you can add a `#[enumset(serialize_deny_unknown)]` attribute. This will cause
 257 /// deserialization to fail if an invalid bit is set.
 258 ///
 259 /// In addition, the `#[enumset(serialize_as_list)]` attribute causes the `EnumSet` to be
 260 /// instead serialized as a list of enum variants. This requires your enum type implement
 261 /// [`Serialize`] and [`Deserialize`]. Note that this is a breaking change.
 262 #[derive(Copy, Clone, PartialEq, Eq)]
 263 #[repr(transparent)]
 264 pub struct EnumSet<T: EnumSetType> {
 265     #[doc(hidden)]
 266     /// This is public due to the [`enum_set!`] macro.
 267     /// This is **NOT** public API and may change at any time.
 268     pub __priv_repr: T::Repr
 269 }
 270 impl <T: EnumSetType> EnumSet<T> {
 271     // Returns all bits valid for the enum
 272     #[inline(always)]
 273     fn all_bits() -> T::Repr {
 274         T::ALL_BITS
 275     }
 276
 277     /// Creates an empty `EnumSet`.
 278     #[inline(always)]
 279     pub fn new() -> Self {
 280         EnumSet { __priv_repr: T::Repr::empty() }
 281     }
 282
 283     /// Returns an `EnumSet` containing a single element.
 284     #[inline(always)]
 285     pub fn only(t: T) -> Self {
 286         let mut set = Self::new();
 287         set.insert(t);
 288         set
 289     }
 290
 291     /// Creates an empty `EnumSet`.
 292     ///
 293     /// This is an alias for [`EnumSet::new`].
 294     #[inline(always)]
 295     pub fn empty() -> Self {
 296         Self::new()
 297     }
 298
 299     /// Returns an `EnumSet` containing all valid variants of the enum.
 300     #[inline(always)]
 301     pub fn all() -> Self {
 302         EnumSet { __priv_repr: Self::all_bits() }
 303     }
 304
 305     /// Total number of bits used by this type. Note that the actual amount of space used is
 306     /// rounded up to the next highest integer type (`u8`, `u16`, `u32`, `u64`, or `u128`).
 307     ///
 308     /// This is the same as [`EnumSet::variant_count`] except in enums with "sparse" variants.
 309     /// (e.g. `enum Foo { A = 10, B = 20 }`)
 310     #[inline(always)]
 311     pub fn bit_width() -> u32 {
 312         T::Repr::WIDTH - T::ALL_BITS.leading_zeros()
 313     }
 314
 315     /// The number of valid variants that this type can contain.
 316     ///
 317     /// This is the same as [`EnumSet::bit_width`] except in enums with "sparse" variants.
 318     /// (e.g. `enum Foo { A = 10, B = 20 }`)
 319     #[inline(always)]
 320     pub fn variant_count() -> u32 {
 321         T::ALL_BITS.count_ones()
 322     }
 323
 324     /// Returns the number of elements in this set.
 325     #[inline(always)]
 326     pub fn len(&self) -> usize {
 327         self.__priv_repr.count_ones() as usize
 328     }
 329     /// Returns `true` if the set contains no elements.
 330     #[inline(always)]
 331     pub fn is_empty(&self) -> bool {
 332         self.__priv_repr.is_empty()
 333     }
 334     /// Removes all elements from the set.
 335     #[inline(always)]
 336     pub fn clear(&mut self) {
 337         self.__priv_repr = T::Repr::empty()
 338     }
 339
 340     /// Returns `true` if `self` has no elements in common with `other`. This is equivalent to
 341     /// checking for an empty intersection.
 342     #[inline(always)]
 343     pub fn is_disjoint(&self, other: Self) -> bool {
 344         (*self & other).is_empty()
 345     }
 346     /// Returns `true` if the set is a superset of another, i.e., `self` contains at least all the
 347     /// values in `other`.
 348     #[inline(always)]
 349     pub fn is_superset(&self, other: Self) -> bool {
 350         (*self & other).__priv_repr == other.__priv_repr
 351     }
 352     /// Returns `true` if the set is a subset of another, i.e., `other` contains at least all
 353     /// the values in `self`.
 354     #[inline(always)]
 355     pub fn is_subset(&self, other: Self) -> bool {
 356         other.is_superset(*self)
 357     }
 358
 359     /// Returns a set containing any elements present in either set.
 360     #[inline(always)]
 361     pub fn union(&self, other: Self) -> Self {
 362         EnumSet { __priv_repr: self.__priv_repr | other.__priv_repr }
 363     }
 364     /// Returns a set containing every element present in both sets.
 365     #[inline(always)]
 366     pub fn intersection(&self, other: Self) -> Self {
 367         EnumSet { __priv_repr: self.__priv_repr & other.__priv_repr }
 368     }
 369     /// Returns a set containing element present in `self` but not in `other`.
 370     #[inline(always)]
 371     pub fn difference(&self, other: Self) -> Self {
 372         EnumSet { __priv_repr: self.__priv_repr.and_not(other.__priv_repr) }
 373     }
 374     /// Returns a set containing every element present in either `self` or `other`, but is not
 375     /// present in both.
 376     #[inline(always)]
 377     pub fn symmetrical_difference(&self, other: Self) -> Self {
 378         EnumSet { __priv_repr: self.__priv_repr ^ other.__priv_repr }
 379     }
 380     /// Returns a set containing all enum variants not in this set.
 381     #[inline(always)]
 382     pub fn complement(&self) -> Self {
 383         EnumSet { __priv_repr: !self.__priv_repr & Self::all_bits() }
 384     }
 385
 386     /// Checks whether this set contains a value.
 387     #[inline(always)]
 388     pub fn contains(&self, value: T) -> bool {
 389         self.__priv_repr.has_bit(value.enum_into_u32())
 390     }
 391
 392     /// Adds a value to this set.
 393     ///
 394     /// If the set did not have this value present, `true` is returned.
 395     ///
 396     /// If the set did have this value present, `false` is returned.
 397     #[inline(always)]
 398     pub fn insert(&mut self, value: T) -> bool {
 399         let contains = !self.contains(value);
 400         self.__priv_repr.add_bit(value.enum_into_u32());
 401         contains
 402     }
 403     /// Removes a value from this set. Returns whether the value was present in the set.
 404     #[inline(always)]
 405     pub fn remove(&mut self, value: T) -> bool {
 406         let contains = self.contains(value);
 407         self.__priv_repr.remove_bit(value.enum_into_u32());
 408         contains
 409     }
 410
 411     /// Adds all elements in another set to this one.
 412     #[inline(always)]
 413     pub fn insert_all(&mut self, other: Self) {
 414         self.__priv_repr = self.__priv_repr | other.__priv_repr
 415     }
 416     /// Removes all values in another set from this one.
 417     #[inline(always)]
 418     pub fn remove_all(&mut self, other: Self) {
 419         self.__priv_repr = self.__priv_repr.and_not(other.__priv_repr);
 420     }
 421
 422     /// Iterates the contents of the set in order from the least significant bit to the most
 423     /// significant bit.
 424     ///
 425     /// Note that iterator invalidation is impossible as the iterator contains a copy of this type,
 426     /// rather than holding a reference to it.
 427     pub fn iter(&self) -> EnumSetIter<T> {
 428         EnumSetIter::new(*self)
 429     }
 430 }
 431
 432 /// Helper macro for generating conversion functions.
 433 macro_rules! conversion_impls {
 434     (
 435         $(for_num!(
 436             $underlying:ty, $underlying_str:expr,
 437             $from_fn:ident $to_fn:ident $from_fn_opt:ident $to_fn_opt:ident,
 438             $from:ident $try_from:ident $from_truncated:ident
 439             $to:ident $try_to:ident $to_truncated:ident
 440         );)*
 441     ) => {
 442         impl <T : EnumSetType> EnumSet<T> {$(
 443             #[doc = "Returns a `"]
 444             #[doc = $underlying_str]
 445             #[doc = "` representing the elements of this set.\n\nIf the underlying bitset will \
 446                      not fit in a `"]
 447             #[doc = $underlying_str]
 448             #[doc = "` or contains bits that do not correspond to an enum variant, this method \
 449                      will panic."]
 450             #[inline(always)]
 451             pub fn $to(&self) -> $underlying {
 452                 self.$try_to().expect("Bitset will not fit into this type.")
 453             }
 454
 455             #[doc = "Tries to return a `"]
 456             #[doc = $underlying_str]
 457             #[doc = "` representing the elements of this set.\n\nIf the underlying bitset will \
 458                      not fit in a `"]
 459             #[doc = $underlying_str]
 460             #[doc = "` or contains bits that do not correspond to an enum variant, this method \
 461                      will instead return `None`."]
 462             #[inline(always)]
 463             pub fn $try_to(&self) -> Option<$underlying> {
 464                 EnumSetTypeRepr::$to_fn_opt(&self.__priv_repr)
 465             }
 466
 467             #[doc = "Returns a truncated `"]
 468             #[doc = $underlying_str]
 469             #[doc = "` representing the elements of this set.\n\nIf the underlying bitset will \
 470                      not fit in a `"]
 471             #[doc = $underlying_str]
 472             #[doc = "`, this method will truncate any bits that don't fit or do not correspond \
 473                      to an enum variant."]
 474             #[inline(always)]
 475             pub fn $to_truncated(&self) -> $underlying {
 476                 EnumSetTypeRepr::$to_fn(&self.__priv_repr)
 477             }
 478
 479             #[doc = "Constructs a bitset from a `"]
 480             #[doc = $underlying_str]
 481             #[doc = "`.\n\nIf a bit that doesn't correspond to an enum variant is set, this \
 482                      method will panic."]
 483             #[inline(always)]
 484             pub fn $from(bits: $underlying) -> Self {
 485                 Self::$try_from(bits).expect("Bitset contains invalid variants.")
 486             }
 487
 488             #[doc = "Attempts to constructs a bitset from a `"]
 489             #[doc = $underlying_str]
 490             #[doc = "`.\n\nIf a bit that doesn't correspond to an enum variant is set, this \
 491                      method will return `None`."]
 492             #[inline(always)]
 493             pub fn $try_from(bits: $underlying) -> Option<Self> {
 494                 let bits = T::Repr::$from_fn_opt(bits);
 495                 let mask = Self::all().__priv_repr;
 496                 bits.and_then(|bits| if bits.and_not(mask).is_empty() {
 497                     Some(EnumSet { __priv_repr: bits })
 498                 } else {
 499                     None
 500                 })
 501             }
 502
 503             #[doc = "Constructs a bitset from a `"]
 504             #[doc = $underlying_str]
 505             #[doc = "`, ignoring invalid variants."]
 506             #[inline(always)]
 507             pub fn $from_truncated(bits: $underlying) -> Self {
 508                 let mask = Self::all().$to_truncated();
 509                 let bits = <T::Repr as EnumSetTypeRepr>::$from_fn(bits & mask);
 510                 EnumSet { __priv_repr: bits }
 511             }
 512         )*}
 513     }
 514 }
 515 conversion_impls! {
 516     for_num!(u8, "u8", from_u8 to_u8 from_u8_opt to_u8_opt,
 517              from_u8 try_from_u8 from_u8_truncated as_u8 try_as_u8 as_u8_truncated);
 518     for_num!(u16, "u16", from_u16 to_u16 from_u16_opt to_u16_opt,
 519              from_u16 try_from_u16 from_u16_truncated as_u16 try_as_u16 as_u16_truncated);
 520     for_num!(u32, "u32", from_u32 to_u32 from_u32_opt to_u32_opt,
 521              from_u32 try_from_u32 from_u32_truncated as_u32 try_as_u32 as_u32_truncated);
 522     for_num!(u64, "u64", from_u64 to_u64 from_u64_opt to_u64_opt,
 523              from_u64 try_from_u64 from_u64_truncated as_u64 try_as_u64 as_u64_truncated);
 524     for_num!(u128, "u128", from_u128 to_u128 from_u128_opt to_u128_opt,
 525              from_u128 try_from_u128 from_u128_truncated as_u128 try_as_u128 as_u128_truncated);
 526     for_num!(usize, "usize", from_usize to_usize from_usize_opt to_usize_opt,
 527              from_usize try_from_usize from_usize_truncated
 528              as_usize try_as_usize as_usize_truncated);
 529 }
 530
 531 impl <T: EnumSetType> Default for EnumSet<T> {
 532     /// Returns an empty set.
 533     fn default() -> Self {
 534         Self::new()
 535     }
 536 }
 537
 538 impl <T: EnumSetType> IntoIterator for EnumSet<T> {
 539     type Item = T;
 540     type IntoIter = EnumSetIter<T>;
 541
 542     fn into_iter(self) -> Self::IntoIter {
 543         self.iter()
 544     }
 545 }
 546 impl <T: EnumSetType> Sum for EnumSet<T> {
 547     fn sum<I: Iterator<Item=Self>>(iter: I) -> Self {
 548         iter.fold(EnumSet::empty(), |a, v| a | v)
 549     }
 550 }
 551 impl <'a, T: EnumSetType> Sum<&'a EnumSet<T>> for EnumSet<T> {
 552     fn sum<I: Iterator<Item=&'a Self>>(iter: I) -> Self {
 553         iter.fold(EnumSet::empty(), |a, v| a | *v)
 554     }
 555 }
 556 impl <T: EnumSetType> Sum<T> for EnumSet<T> {
 557     fn sum<I: Iterator<Item=T>>(iter: I) -> Self {
 558         iter.fold(EnumSet::empty(), |a, v| a | v)
 559     }
 560 }
 561 impl <'a, T: EnumSetType> Sum<&'a T> for EnumSet<T> {
 562     fn sum<I: Iterator<Item=&'a T>>(iter: I) -> Self {
 563         iter.fold(EnumSet::empty(), |a, v| a | *v)
 564     }
 565 }
 566
 567 impl <T: EnumSetType, O: Into<EnumSet<T>>> Sub<O> for EnumSet<T> {
 568     type Output = Self;
 569     #[inline(always)]
 570     fn sub(self, other: O) -> Self::Output {
 571         self.difference(other.into())
 572     }
 573 }
 574 impl <T: EnumSetType, O: Into<EnumSet<T>>> BitAnd<O> for EnumSet<T> {
 575     type Output = Self;
 576     #[inline(always)]
 577     fn bitand(self, other: O) -> Self::Output {
 578         self.intersection(other.into())
 579     }
 580 }
 581 impl <T: EnumSetType, O: Into<EnumSet<T>>> BitOr<O> for EnumSet<T> {
 582     type Output = Self;
 583     #[inline(always)]
 584     fn bitor(self, other: O) -> Self::Output {
 585         self.union(other.into())
 586     }
 587 }
 588 impl <T: EnumSetType, O: Into<EnumSet<T>>> BitXor<O> for EnumSet<T> {
 589     type Output = Self;
 590     #[inline(always)]
 591     fn bitxor(self, other: O) -> Self::Output {
 592         self.symmetrical_difference(other.into())
 593     }
 594 }
 595
 596 impl <T: EnumSetType, O: Into<EnumSet<T>>> SubAssign<O> for EnumSet<T> {
 597     #[inline(always)]
 598     fn sub_assign(&mut self, rhs: O) {
 599         *self = *self - rhs;
 600     }
 601 }
 602 impl <T: EnumSetType, O: Into<EnumSet<T>>> BitAndAssign<O> for EnumSet<T> {
 603     #[inline(always)]
 604     fn bitand_assign(&mut self, rhs: O) {
 605         *self = *self & rhs;
 606     }
 607 }
 608 impl <T: EnumSetType, O: Into<EnumSet<T>>> BitOrAssign<O> for EnumSet<T> {
 609     #[inline(always)]
 610     fn bitor_assign(&mut self, rhs: O) {
 611         *self = *self | rhs;
 612     }
 613 }
 614 impl <T: EnumSetType, O: Into<EnumSet<T>>> BitXorAssign<O> for EnumSet<T> {
 615     #[inline(always)]
 616     fn bitxor_assign(&mut self, rhs: O) {
 617         *self = *self ^ rhs;
 618     }
 619 }
 620
 621 impl <T: EnumSetType> Not for EnumSet<T> {
 622     type Output = Self;
 623     #[inline(always)]
 624     fn not(self) -> Self::Output {
 625         self.complement()
 626     }
 627 }
 628
 629 impl <T: EnumSetType> From<T> for EnumSet<T> {
 630     fn from(t: T) -> Self {
 631         EnumSet::only(t)
 632     }
 633 }
 634
 635 impl <T: EnumSetType> PartialEq<T> for EnumSet<T> {
 636     fn eq(&self, other: &T) -> bool {
 637         self.__priv_repr == EnumSet::only(*other).__priv_repr
 638     }
 639 }
 640 impl <T: EnumSetType + Debug> Debug for EnumSet<T> {
 641     fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
 642         let mut is_first = true;
 643         f.write_str("EnumSet(")?;
 644         for v in self.iter() {
 645             if !is_first { f.write_str(" | ")?; }
 646             is_first = false;
 647             v.fmt(f)?;
 648         }
 649         f.write_str(")")?;
 650         Ok(())
 651     }
 652 }
 653
 654 #[allow(clippy::derive_hash_xor_eq)] // This impl exists to change trait bounds only.
 655 impl <T: EnumSetType> Hash for EnumSet<T> {
 656     fn hash<H: Hasher>(&self, state: &mut H) {
 657         self.__priv_repr.hash(state)
 658     }
 659 }
 660 impl <T: EnumSetType> PartialOrd for EnumSet<T> {
 661     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
 662         self.__priv_repr.partial_cmp(&other.__priv_repr)
 663     }
 664 }
 665 impl <T: EnumSetType> Ord for EnumSet<T> {
 666     fn cmp(&self, other: &Self) -> Ordering {
 667         self.__priv_repr.cmp(&other.__priv_repr)
 668     }
 669 }
 670
 671 #[cfg(feature = "serde")]
 672 impl <T: EnumSetType> Serialize for EnumSet<T> {
 673     fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
 674         T::serialize(*self, serializer)
 675     }
 676 }
 677
 678 #[cfg(feature = "serde")]
 679 impl <'de, T: EnumSetType> Deserialize<'de> for EnumSet<T> {
 680     fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
 681         T::deserialize(deserializer)
 682     }
 683 }
 684
 685 /// The iterator used by [`EnumSet`]s.
 686 #[derive(Clone, Debug)]
 687 pub struct EnumSetIter<T: EnumSetType> {
 688     set: EnumSet<T>,
 689 }
 690 impl <T: EnumSetType> EnumSetIter<T> {
 691     fn new(set: EnumSet<T>) -> EnumSetIter<T> {
 692         EnumSetIter { set }
 693     }
 694 }
 695 impl <T: EnumSetType> Iterator for EnumSetIter<T> {
 696     type Item = T;
 697
 698     fn next(&mut self) -> Option<Self::Item> {
 699         if self.set.is_empty() {
 700             None
 701         } else {
 702             let bit = self.set.__priv_repr.trailing_zeros();
 703             self.set.__priv_repr.remove_bit(bit);
 704             unsafe { Some(T::enum_from_u32(bit)) }
 705         }
 706     }
 707     fn size_hint(&self) -> (usize, Option<usize>) {
 708         let left = self.set.len();
 709         (left, Some(left))
 710     }
 711 }
 712
 713 impl<T: EnumSetType> ExactSizeIterator for EnumSetIter<T> {}
 714
 715 impl<T: EnumSetType> Extend<T> for EnumSet<T> {
 716     fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I) {
 717         iter.into_iter().for_each(|v| { self.insert(v); });
 718     }
 719 }
 720
 721 impl<T: EnumSetType> FromIterator<T> for EnumSet<T> {
 722     fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
 723         let mut set = EnumSet::default();
 724         set.extend(iter);
 725         set
 726     }
 727 }
 728
 729 impl<T: EnumSetType> Extend<EnumSet<T>> for EnumSet<T> {
 730     fn extend<I: IntoIterator<Item = EnumSet<T>>>(&mut self, iter: I) {
 731         iter.into_iter().for_each(|v| { self.insert_all(v); });
 732     }
 733 }
 734
 735 impl<T: EnumSetType> FromIterator<EnumSet<T>> for EnumSet<T> {
 736     fn from_iter<I: IntoIterator<Item = EnumSet<T>>>(iter: I) -> Self {
 737         let mut set = EnumSet::default();
 738         set.extend(iter);
 739         set
 740     }
 741 }
 742
 743 /// Creates a EnumSet literal, which can be used in const contexts.
 744 ///
 745 /// The syntax used is `enum_set!(Type::A | Type::B | Type::C)`. Each variant must be of the same
 746 /// type, or a error will occur at compile-time.
 747 ///
 748 /// This macro accepts trailing `|`s to allow easier use in other macros.
 749 ///
 750 /// # Examples
 751 ///
 752 /// ```rust
 753 /// # use enumset::*;
 754 /// # #[derive(EnumSetType, Debug)] enum Enum { A, B, C }
 755 /// const CONST_SET: EnumSet<Enum> = enum_set!(Enum::A | Enum::B);
 756 /// assert_eq!(CONST_SET, Enum::A | Enum::B);
 757 /// ```
 758 ///
 759 /// This macro is strongly typed. For example, the following will not compile:
 760 ///
 761 /// ```compile_fail
 762 /// # use enumset::*;
 763 /// # #[derive(EnumSetType, Debug)] enum Enum { A, B, C }
 764 /// # #[derive(EnumSetType, Debug)] enum Enum2 { A, B, C }
 765 /// let type_error = enum_set!(Enum::A | Enum2::B);
 766 /// ```
 767 #[macro_export]
 768 macro_rules! enum_set {
 769     ($(|)*) => {
 770         $crate::EnumSet { __priv_repr: 0 }
 771     };
 772     ($value:path $(|)*) => {
 773         {
 774             #[allow(deprecated)] let value = $value.__impl_enumset_internal__const_only();
 775             value
 776         }
 777     };
 778     ($value:path | $($rest:path)|* $(|)*) => {
 779         {
 780             #[allow(deprecated)] let value = $value.__impl_enumset_internal__const_only();
 781             $(#[allow(deprecated)] let value = $rest.__impl_enumset_internal__const_merge(value);)*
 782             value
 783         }
 784     };
 785 }