RELEASES.md

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