Rename from_u128/to_u128 series slightly.

[enumset.git] / RELEASES.md

diff --git a/RELEASES.md b/RELEASES.md
index df52568ad3e80ee0cfa61c58fe14580bb61fd0ff..25201a87a181621b8a06a83388dca075397018e0 100644 (file)
--- a/RELEASES.md
+++ b/RELEASES.md
@@ -1,3 +1,32 @@
+# 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.
+
+## 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.