Added FromIterator/Extend operations for iterators of EnumSets.

[enumset.git] / RELEASES.md

diff --git a/RELEASES.md b/RELEASES.md
index 386e78f316709f57c8772c9b1232659b08e4b520..ef8d51ce4e9a88e076fc54a046cc484491c6e020 100644 (file)
--- a/RELEASES.md
+++ b/RELEASES.md
@@ -1,3 +1,58 @@
+# Version 1.0.0 (2020-04-01) - Unreleased
+
+## Breaking Changes
+* **[WARNING: Potential silent breaking change]** Changed `EnumSet::insert` to
+  return whether a value was newly  inserted, rather than whether the value
+  already existed in the set. This corresponds better with the behavior of
+  `HashSet::insert` and `BTreeSet::insert`.
+* Renamed `to_bits`/`from_bits` to `as_u128`/`from_u128`.
+* `EnumSet::bit_width` and `EnumSet::variant_count` now return a `u32` instead
+  of a `u8` for future-proofing.
+* Removed `nightly` feature flag, as it is no longer required.
+
+## New features
+* Added a series of functions like `as_u128`/`from_u128` for other unsigned
+  numeric types. (e.g. `as_u8`/`from_u8`, `as_u16`/`from_u16`, etc)
+* Added variants of `as_u128`/`from_u128` that return an `Option` instead of
+  panicking when the conversion cannot be done.
+* Added variants of `as_u128`/`from_u128` that truncate unknown bits instead
+  of panicking.
+* Implemented `Extend<EnumSet<T>>` and `FromIterator<EnumSet<T>>` for
+  `EnumSet<T>`.
+
+## Bugfixes
+* Fixed a bug where the procedural macro would fail on enums with a repr
+  annotation set. While reprs larger than u8 are supported, negative enum
+  variants or enum variants above 127 are still not currently supported.
+
+# Version 0.4.5 (2020-02-19)
+* Fixed a bug where compilation failed when the `serde` flag was enabled, and
+  another trait that defined `serialize` or `deserialize` was in scope.
+
+# Version 0.4.4 (2019-10-12)
+* Fixed a bug where `#[enumset(serialize_as_list)]` did not work when `Result`
+  is shadowed.
+
+# Version 0.4.3 (2019-10-08)
+* Implemented `Extend` and `FromIterator` for `EnumSet<T>`.
+
+# Version 0.4.2 (2019-09-28)
+* Fixed a bug preventing empty enums and enums with one value from compiling.
+
+# Version 0.4.1 (2019-09-27)
+* Fixed bug in `EnumSetIter::size_hint`.
+
+# Version 0.4.0 (2019-05-06)
+* Removed outdated macros and attributes.
+* All attributes for the custom derive are now written as `#[enumset(...)]`
+* Implemented `#[enumset(serialize_deny_unknown)]`
+* Implemented `#[enumset(serialize_repr="...")]`
+* `#[derive(EnumSetType)]` now only implements `Copy`, `Clone`, `PartialEq` and
+  `Eq` automatically.
+
+# Version 0.3.19 (2019-05-02)
+* Fix a bug when deserializing enums containing invalid bits set.
+
 # Version 0.3.18 (2019-03-11)
 * Fix an off-by-one error causing enums with 9, 17, 33, etc variants to behave
   unexpectedly.
@@ -20,8 +75,8 @@
   EnumSetTypes.
 * Fixed a major issue that would have prevented `enumset` from being used in
   `#[no_std]` crates.
-* Minimum required version is now 1.30.0+. There should be no more need to bump
-  the minimum Rust version in the forseeable future.
+* Minimum required version is now 1.30.0+. There should be no more need to
+  bump the minimum Rust version in the forseeable future.
 
 # Prior versions