Skip to content

RELEASES.md

Latest commit

 

History

History
256 lines (207 loc) · 10.8 KB

RELEASES.md

File metadata and controls

256 lines (207 loc) · 10.8 KB

Unreleased

  • Implement a new MixedEnumSet<T> type that allows unknown bits to be mixed with known enum variants in a single bitset.
  • Added FromIterator implementations for iterators of borrowed items.
  • Added EnumSet::bit_index and EnumSet::is_bit_valid methods to query the bit associated with an enum variant, or if a bit index is valid.

Version 1.1.10 (2025-08-21)

  • Improve the macro code to avoid exposing the internal repr of EnumSet as a public field.
  • Fixes combinations of repr and serialize_repr that previously resulted in errors.
  • Fixed some minor hygiene issues with the procedural macro.
  • Small improvements and clarifications to the documentation.

Version 1.1.9 (2025-08-17)

  • Fixes a bug that causes compilation failures when a crate (such as defmt) exposes a macro called assert!. (thanks @bugadani)

Version 1.1.8 (2025-08-16)

New Features

  • Add From<[T; N]>, Extend<&'a T>, and Extend<&'a EnumSet<T>> implementations to EnumSet<T>.
  • Added a new #[enumset(map = "...")] annotation that allows controlling how enum variants are mapped to bits in the underlying bitset.

Enhancements

  • Optimizations for sparse bitsets and sets larger than 64 variants.
  • Added basic support for specifying enum discriminators via simple expressions like 1 << 30.

Version 1.1.7 (2025-07-08)

  • Fix hygiene issue where the enumset_set! macro with no arguments required EnumSet to be imported into the current context. (Thanks @cbiffle)
  • Fix issue where #[derive(EnumSetType)] used to cause compile errors when cross-compiling with different flags on the host and target sides. (Thanks @dtolnay)

Version 1.1.6 (2025-05-05)

  • EnumSet::as_repr is now const. (Thanks @jasonwhite)
  • Added support for the defmt crate via a new feature. (Thanks @katyo)

Version 1.1.5 (2024-07-22)

  • Add support for using EnumSet<T> values in the enum_set! macro.
  • Added new enum_set_union!, enum_set_intersection!, enum_set_difference!, enum_set_complement! and enum_set_symmetric_difference! macros for doing EnumSet operations at compile time.

Version 1.1.4 (2024-07-22)

  • The empty, all, bit_width, and variant_count functions of EnumSet<T> are now const.
  • The EMPTY and ALL consts of EnumSet<T> are deprecated in favor of the empty and all functions.
  • The std feature flag has been deprecated in favor of the new const-proc-macro feature flag. The feature flag was never used for any std-specific functionality beyond that crate.
  • Minimum required Rust version is now 1.61+, due to updates in dependencies and to allow additional functions to be const.
  • Minimum required Rust version when the std or const-proc-macro feature flags are enabled is now 1.69+.
  • Minor fixes to documentation. (Thanks @xnuk)

Version 1.1.3 (2023-10-11)

  • Fix an issue where EnumSet::iter was not properly inlined without LTO enabled (such as on debug builds). (thanks @Fuuzetsu)
  • Added a Display implementation for EnumSet<T> for types where T implements Display. (suggested by @tsheinen)

Version 1.1.2 (2023-05-09)

  • Fix issue where the code generated by #[derive(EnumSetType)] would cause a clippy warning.

Version 1.1.1 (2023-05-08)

  • Fix issue where enumset did not build correctly for no_std programs that did not use alloc. (Thanks @shamchak808)

Version 1.1.0 (2023-05-08)

  • Removed the previous 128 variant limit, allowing for enumsets that are backed by an array rather than a single integer.
  • Added as_array, from_array, from_slice, and copy_into_slice functions to EnumSet<T>. In addition, *_truncated and try_* versions of all these functions exist.
  • Added a to_vec function that returns the same data as the array/slice based functions. This requires the alloc feature.
  • Added an EnumSet::<T>::EMPTY constant to help with initializing empty sets in constant contexts.
  • Deprecated #[enumset(serialize_as_list)] in favor of #[enumset(serialize_repr = "list")].
  • Deprecated #[enumset(serialize_as_map)] in favor of #[enumset(serialize_repr = "map")].

Version 1.0.13 (2023-05-01)

  • Updated darling to version 0.20 and syn to version 2.0.
  • Added a new #[enumset(serialize_as_map)] attribute to allow serializing EnumSet<T> as a map of enum variants to boolean values. (Thanks @LizzyFleckenstein03)
  • Minimum required Rust version is now 1.56+, due to updates in dependencies.

Version 1.0.12 (2022-10-02)

  • Updated darling version to reduce compile times when combined with other crates. (Thanks @AlexTMjugador)

Version 1.0.11 (2022-04-12)

  • Added support for explicitly specifying the internal representation of EnumSet<T> using the #[enumset(repr = "...")] annotation. (Thanks @ahcodedthat)
  • Added new functions for directly converting an EnumSet to and from its internal representation, when it is explicitly specified. (Thanks @ahcodedthat)
  • Added new from_*_unchecked functions that unsafely convert a value into an EnumSet<T> without checking if only valid bits are set.

Version 1.0.10 (2022-04-05)

  • The proc-macro-crate support has been locked behind the std flag and version 1.0.9 has been yanked due to a regression that causes enumset to fail to compile on #[no_std] platforms in programs that also use serde.
  • Introduced new std and alloc feature flags. These have no current use beyond the previous change, but will be used in the future.

Version 1.0.9 (2022-04-04) [YANKED]

  • Disable unused default features for the darling crate. (Thanks @glandium)
  • Add a new #[enumset(no_super_impls)] feature which prevents #[derive(EnumSetType)] from automatically generating implementations of Copy, Clone, Eq, or PartialEq. (Thanks @ahcodedthat)
  • Suppressed several clippy warnings.
  • Implemented DoubleEndedIterator for EnumSetIter.
  • #[derive(EnumSetType)] now uses proc-macro-crate to find the path of the enumset crate instead of relying on the user to manually specify it, making it easier to use when the crate has been renamed via cargo.
  • Minimum required Rust version is now 1.36+, due to updates in dependencies.

Version 1.0.8 (2021-11-04)

  • Optimized EnumSet iteration. (Thanks @MinusKelvin)

Version 1.0.7 (2021-07-05)

  • Added the #[repr(transparent)] flag to EnumSet<T> to allow for safe usage in FFI code. Note that invalid bits being set in the bitset causes UB, so this should be done with care. (Thanks @Riey)

Version 1.0.6 (2021-02-27)

  • Fix an unneeded warning in the output for enum_set! for a single value.

Version 1.0.5 (2021-02-24)

  • Implemented core::iter::Sum for EnumSet<T>.
  • Properly acknowledge that the minimum required Rust version is actually 1.34+ and not 1.31+. An retroactive changelog entry has been added to 1.0.0.

Version 1.0.4 (2021-02-07)

  • Fixes a bug that caused enumset_derive to require an import of EnumSet in the scope to function.

Version 1.0.3 (2021-01-27)

  • (This version contains no code changes.)
  • Redirected badges in the README to point at travis-ci.com instead of .org
  • Added README.md, and the license files to the crate distribution.

Version 1.0.2 (2021-01-25)

  • Fixed critical error compiling on newer versions of syn caused by a mistaken import from a private module. (Thanks @ocboogie)

Version 1.0.1 (2020-08-09)

  • Implemented ExactSizeIterator for EnumSetIter. (Thanks @dmarcuse)

Version 1.0.0 (2020-04-06)

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.
  • Minimum required Rust version is now 1.34+.

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.
  • Implemented Extend<EnumSet<T>> and FromIterator<EnumSet<T>> for EnumSet<T>. (Thanks @manuthambi)
  • Added an #[enumset(crate_name = "renamed_enumset")] annotation for handling renamed crates.

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.

Version 0.4.3 (2019-10-08)

  • Implemented Extend and FromIterator for EnumSet<T>.

Version 0.4.2 (2019-09-28)

  • Fixed a bug preventing empty enums and enums with one value from compiling.

Version 0.4.1 (2019-09-27)

  • Fixed bug in EnumSetIter::size_hint. (Thanks @manuthambi)

Version 0.4.0 (2019-05-06)

  • Removed outdated macros and attributes.
  • All attributes for the custom derive are now written as #[enumset(...)]
  • Implemented #[enumset(serialize_deny_unknown)]
  • Implemented #[enumset(serialize_repr="...")]
  • #[derive(EnumSetType)] now only implements Copy, Clone, PartialEq and Eq automatically.

Version 0.3.19 (2019-05-02)

  • Fix a bug when deserializing enums containing invalid bits set.

Version 0.3.18 (2019-03-11)

  • Fix an off-by-one error causing enums with 9, 17, 33, etc variants to behave unexpectedly.

Version 0.3.17 (2019-03-11)

  • Add an #[enumset_serialize_as_list] attribute to cause the Deserialize and Serialize implementations for EnumSet<T> to serialize it as a seq of Ts rather than an integer bitmask.

Version 0.3.16 (2019-02-04)

  • Added Default implementation for EnumSet<T> that returns an empty map. (Thanks @boxdot)

Version 0.3.15 (2019-01-08)

  • Added optional serde support.

Version 0.3.14 (2018-11-09)

  • Deprecated the enum_set_type! macro in favor of a custom derive.
  • Added a way to avoid the automatic operator overloads derived from EnumSetTypes.
  • Fixed a major issue that would have prevented enumset from being used in #[no_std] crates.
  • Minimum required version is now 1.30.0+. There should be no more need to bump the minimum Rust version in the forseeable future.

Prior versions

No release notes were kept for prior versions.