RELEASES.md

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