RELEASES.md

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