RELEASES.md

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