RELEASES.md

   1 # Version 1.0.5 (2021-02-24)
   2 * Implemented `core::iter::Sum` for `EnumSet<T>`.
   3 * Properly acknowledge that the minimum required Rust version is actually 1.34+
   4   and not 1.31+. An retroactive changelog entry has been added to 1.0.0.
   5
   6 # Version 1.0.4 (2021-02-07)
   7 * Fixes a bug that caused `enumset_derive` to require an import of `EnumSet`
   8   in the scope to function.
   9
  10 # Version 1.0.3 (2021-01-27)
  11 * (This version contains no code changes.)
  12 * Redirected badges in the README to point at travis-ci.com instead of .org
  13 * Added `README.md`, and the license files to the crate distribution.
  14
  15 # Version 1.0.2 (2021-01-25)
  16 * Fixed critical error compiling on newer versions of `syn` caused by a
  17   mistaken import from a private module.
  18
  19 # Version 1.0.1 (2020-08-09)
  20 * Implemented `ExactSizeIterator` for `EnumSetIter`.
  21
  22 # Version 1.0.0 (2020-04-06)
  23
  24 ## Breaking Changes
  25 * **[WARNING: Potential silent breaking change]** Changed `EnumSet::insert` to
  26   return whether a value was newly  inserted, rather than whether the value
  27   already existed in the set. This corresponds better with the behavior of
  28   `HashSet::insert` and `BTreeSet::insert`.
  29 * Renamed `to_bits`/`from_bits` to `as_u128`/`from_u128`.
  30 * `EnumSet::bit_width` and `EnumSet::variant_count` now return a `u32` instead
  31   of a `u8` for future-proofing.
  32 * Removed `nightly` feature flag, as it is no longer required.
  33 * Minimum required Rust version is now 1.34+.
  34
  35 ## New features
  36 * Added a series of functions like `as_u128`/`from_u128` for other unsigned
  37   numeric types. (e.g. `as_u8`/`from_u8`, `as_u16`/`from_u16`, etc)
  38 * Added variants of `as_u128`/`from_u128` that return an `Option` instead of
  39   panicking when the conversion cannot be done.
  40 * Added variants of `as_u128`/`from_u128` that truncate unknown bits instead
  41   of panicking.
  42 * Implemented `Extend<EnumSet<T>>` and `FromIterator<EnumSet<T>>` for
  43   `EnumSet<T>`.
  44 * Added an `#[enumset(crate_name = "renamed_enumset")]` annotation for
  45   handling renamed crates.
  46
  47 ## Bugfixes
  48 * Fixed a bug where the procedural macro would fail on enums with a repr
  49   annotation set. While reprs larger than u8 are supported, negative enum
  50   variants or enum variants above 127 are still not currently supported.
  51
  52 # Version 0.4.5 (2020-02-19)
  53 * Fixed a bug where compilation failed when the `serde` flag was enabled, and
  54   another trait that defined `serialize` or `deserialize` was in scope.
  55
  56 # Version 0.4.4 (2019-10-12)
  57 * Fixed a bug where `#[enumset(serialize_as_list)]` did not work when `Result`
  58   is shadowed.
  59
  60 # Version 0.4.3 (2019-10-08)
  61 * Implemented `Extend` and `FromIterator` for `EnumSet<T>`.
  62
  63 # Version 0.4.2 (2019-09-28)
  64 * Fixed a bug preventing empty enums and enums with one value from compiling.
  65
  66 # Version 0.4.1 (2019-09-27)
  67 * Fixed bug in `EnumSetIter::size_hint`.
  68
  69 # Version 0.4.0 (2019-05-06)
  70 * Removed outdated macros and attributes.
  71 * All attributes for the custom derive are now written as `#[enumset(...)]`
  72 * Implemented `#[enumset(serialize_deny_unknown)]`
  73 * Implemented `#[enumset(serialize_repr="...")]`
  74 * `#[derive(EnumSetType)]` now only implements `Copy`, `Clone`, `PartialEq` and
  75   `Eq` automatically.
  76
  77 # Version 0.3.19 (2019-05-02)
  78 * Fix a bug when deserializing enums containing invalid bits set.
  79
  80 # Version 0.3.18 (2019-03-11)
  81 * Fix an off-by-one error causing enums with 9, 17, 33, etc variants to behave
  82   unexpectedly.
  83
  84 # Version 0.3.17 (2019-03-11)
  85 * Add an `#[enumset_serialize_as_list]` attribute to cause the `Deserialize`
  86   and `Serialize` implementations for `EnumSet<T>` to serialize it as a seq
  87   of `T`s rather than an integer bitmask.
  88
  89 # Version 0.3.16 (2019-02-04)
  90 * Added `Default` implementation for `EnumSet<T>` that returns an empty map.
  91
  92 # Version 0.3.15 (2019-01-08)
  93 * Added optional `serde` support.
  94
  95 # Version 0.3.14 (2018-11-09)
  96
  97 * Deprecated the `enum_set_type!` macro in favor of a custom derive.
  98 * Added a way to avoid the automatic operator overloads derived from
  99   EnumSetTypes.
 100 * Fixed a major issue that would have prevented `enumset` from being used in
 101   `#[no_std]` crates.
 102 * Minimum required version is now 1.30.0+. There should be no more need to
 103   bump the minimum Rust version in the forseeable future.
 104
 105 # Prior versions
 106
 107 No release notes were kept for prior versions.