RELEASES.md

   1 # Version 1.0.0 (2020-04-01) - Unreleased
   2 * **[WARNING: Potential silent breaking change]** Changed `EnumSet::insert` to
   3   return whether a value was newly  inserted, rather than whether the value
   4   already existed in the set. This corresponds better with the behavior of
   5   `HashSet::insert` and `BTreeSet::insert`.
   6 * Renamed `to_bits`/`from_bits` to `to_u128`/`from_u128` and added additional
   7   methods for other built-in numeric types.
   8 * `EnumSet::bit_width` and `EnumSet::variant_count` now return a `u32` instead
   9   of a `u8` for future-proofing.
  10 * Removed `nightly` feature flag, as it is no longer required.
  11 * Fixed a bug where the procedural macro would fail on enums with a repr
  12   annotation set. While reprs larger than u8 are supported, negative enum
  13   variants or enum variants above 127 are still not currently supported.
  14
  15 # Version 0.4.5 (2020-02-19)
  16 * Fixed a bug where compilation failed when the `serde` flag was enabled, and
  17   another trait that defined `serialize` or `deserialize` was in scope.
  18
  19 # Version 0.4.4 (2019-10-12)
  20 * Fixed a bug where `#[enumset(serialize_as_list)]` did not work when `Result`
  21   is shadowed.
  22
  23 # Version 0.4.3 (2019-10-08)
  24 * Implemented `Extend` and `FromIterator` for `EnumSet<T>`.
  25
  26 # Version 0.4.2 (2019-09-28)
  27 * Fixed a bug preventing empty enums and enums with one value from compiling.
  28
  29 # Version 0.4.1 (2019-09-27)
  30 * Fixed bug in `EnumSetIter::size_hint`.
  31
  32 # Version 0.4.0 (2019-05-06)
  33 * Removed outdated macros and attributes.
  34 * All attributes for the custom derive are now written as `#[enumset(...)]`
  35 * Implemented `#[enumset(serialize_deny_unknown)]`
  36 * Implemented `#[enumset(serialize_repr="...")]`
  37 * `#[derive(EnumSetType)]` now only implements `Copy`, `Clone`, `PartialEq` and
  38   `Eq` automatically.
  39
  40 # Version 0.3.19 (2019-05-02)
  41 * Fix a bug when deserializing enums containing invalid bits set.
  42
  43 # Version 0.3.18 (2019-03-11)
  44 * Fix an off-by-one error causing enums with 9, 17, 33, etc variants to behave
  45   unexpectedly.
  46
  47 # Version 0.3.17 (2019-03-11)
  48 * Add an `#[enumset_serialize_as_list]` attribute to cause the `Deserialize`
  49   and `Serialize` implementations for `EnumSet<T>` to serialize it as a seq
  50   of `T`s rather than an integer bitmask.
  51
  52 # Version 0.3.16 (2019-02-04)
  53 * Added `Default` implementation for `EnumSet<T>` that returns an empty map.
  54
  55 # Version 0.3.15 (2019-01-08)
  56 * Added optional `serde` support.
  57
  58 # Version 0.3.14 (2018-11-09)
  59
  60 * Deprecated the `enum_set_type!` macro in favor of a custom derive.
  61 * Added a way to avoid the automatic operator overloads derived from
  62   EnumSetTypes.
  63 * Fixed a major issue that would have prevented `enumset` from being used in
  64   `#[no_std]` crates.
  65 * Minimum required version is now 1.30.0+. There should be no more need to
  66   bump the minimum Rust version in the forseeable future.
  67
  68 # Prior versions
  69
  70 No release notes were kept for prior versions.