From c0947914b98f93b9ae52011cb1212ff817772b7d Mon Sep 17 00:00:00 2001 From: ltdk Date: Thu, 29 Aug 2024 17:20:09 -0400 Subject: [PATCH] Update changelog for v0.15.0, bump Cargo.toml, fix README --- CHANGELOG.md | 41 +++++++++++++++++++++++++++++++++++++++-- Cargo.toml | 2 +- README.md | 2 +- 3 files changed, 41 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6ffc27bc2..5e82f72bb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,9 +7,45 @@ and this project adheres to [Semantic Versioning](https://semver.org/). ## [Unreleased] +## [v0.15.0] - 2024-09-?? + +This update contains breaking changes that remove the `raw` API with the hope of +centralising on the `HashTable` API in the future. You can follow the discussion +and progress in #545 to discuss features you think should be added to this API +that were previously only possible on the `raw` API. + +### Added + +- Added `borsh` feature with `BorshSerialize` and `BorshDeserialize` impls. (#525) +- Added `Assign` impls for `HashSet` operators. (#529) +- Added `Default` impls for iterator types. (#542) +- Added `HashTable::iter_hash{,_mut}` methods. (#549) +- Added `Hash{Table,Map,Set}::allocation_size` methods. (#553) +- Implemented `Debug` and `FusedIterator` for all `HashTable` iterators. (#561) +- Specialized `Iterator::fold` for all `HashTable` iterators. (#561) + ### Changed -- Changed `hash_set::{Entry, VacantEntry}::insert` to return `OccupiedEntry`. (#495) +- Changed `hash_set::VacantEntry::insert` to return `OccupiedEntry`. (#495) +- Improved`hash_set::Difference::size_hint` lower-bound. (#530) +- Improved `HashSet::is_disjoint` performance. (#531) +- `equivalent` feature is now enabled by default. (#532) +- `HashSet` operators now return a set with the same allocator. (#529) +- `ahash` feature has been renamed to `default-hasher`. (#533) +- Entry API has been reworked and several methods have been renamed. (#535) +- `Hash{Map,Set}::insert_unique_unchecked` is now unsafe. (#556) + +### Fixed + +* Fixed typos, stray backticks in docs. (#558, #560) + +### Removed + +- Raw entry API is now under `raw-entry` feature, to be eventually removed. (#534, #555) +- Raw table API has been made private and the `raw` feature is removed; + in the future, all code should be using the `HashTable` API instead. (#531, #546) +- `rykv` feature was removed; this is now provided by the `rykv` crate instead. (#554) +- `HashSet::get_or_insert_owned` was removed in favor of `get_or_insert_with`. (#555) ## [v0.14.5] - 2024-04-28 @@ -485,7 +521,8 @@ This release was _yanked_ due to a breaking change for users of `no-default-feat - Initial release -[Unreleased]: https://github.com/rust-lang/hashbrown/compare/v0.14.5...HEAD +[Unreleased]: https://github.com/rust-lang/hashbrown/compare/v0.15.0...HEAD +[v0.15.0]: https://github.com/rust-lang/hashbrown/compare/v0.14.5...v0.15.0 [v0.14.5]: https://github.com/rust-lang/hashbrown/compare/v0.14.4...v0.14.5 [v0.14.4]: https://github.com/rust-lang/hashbrown/compare/v0.14.3...v0.14.4 [v0.14.3]: https://github.com/rust-lang/hashbrown/compare/v0.14.2...v0.14.3 diff --git a/Cargo.toml b/Cargo.toml index 8b5ed89ce..171863242 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "hashbrown" -version = "0.14.5" +version = "0.15.0" authors = ["Amanieu d'Antras "] description = "A Rust port of Google's SwissTable hash map" license = "MIT OR Apache-2.0" diff --git a/README.md b/README.md index 578a8ef94..28edb247a 100644 --- a/README.md +++ b/README.md @@ -103,7 +103,7 @@ This crate has the following Cargo features: - `serde`: Enables serde serialization support. - `borsh`: Enables borsh serialization support. - `rayon`: Enables rayon parallel iterator support. -- `equivalent`: Allows comparisons to be customized with the `Equivalent` trait. +- `equivalent`: Allows comparisons to be customized with the `Equivalent` trait. (enabled by default) - `raw-entry`: Enables access to the deprecated `RawEntry` API. - `inline-more`: Adds inline hints to most functions, improving run-time performance at the cost of compilation time. (enabled by default)