diff --git a/CHANGELOG.md b/CHANGELOG.md index eb1da40..969d69c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,17 +4,11 @@ Released YYYY-MM-DD. ### Added -* New `"allocator-api2"` feature enables use of allocator API on stable. - This feature uses a crate that mirrors the API of - unstable `allocator_api` feature. - If feature is enabled, references to `Bump` implement - `allocator_api2::Allocator`. - This allows `Bump` to be used as allocator for collection types from - `allocator-api2` and any other crates that support `allocator-api2`. +* TODO (or remove section if none) ### Changed -* The minimum supported Rust version (MSRV) is now 1.63.0. +* TODO (or remove section if none) ### Deprecated @@ -34,6 +28,25 @@ Released YYYY-MM-DD. -------------------------------------------------------------------------------- +## 3.13.0 + +Released 2023-05-22. + +### Added + +* New `"allocator-api2"` feature enables the use of the allocator API on + stable. This feature uses a crate that mirrors the API of the unstable Rust + `allocator_api` feature. If the feature is enabled, references to `Bump` will + implement `allocator_api2::Allocator`. This allows `Bump` to be used as an + allocator for collection types from `allocator-api2` and any other crates that + support `allocator-api2`. + +### Changed + +* The minimum supported Rust version (MSRV) is now 1.63.0. + +-------------------------------------------------------------------------------- + ## 3.12.2 Released 2023-05-09. diff --git a/Cargo.toml b/Cargo.toml index 6df1fac..32e2a53 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,7 +8,7 @@ license = "MIT/Apache-2.0" name = "bumpalo" readme = "README.md" repository = "https://github.com/fitzgen/bumpalo" -version = "3.12.2" +version = "3.13.0" exclude = ["/.github/*", "/benches", "/tests", "valgrind.supp", "bumpalo.png"] rust-version = "1.60.0" @@ -31,7 +31,10 @@ path = "tests/try_alloc.rs" harness = false [dependencies] -allocator-api2 = { version = "0.2.8", default-features = false, optional = true, features = ["alloc"] } +# This dependency provides a version of the unstable nightly Rust `Allocator` +# trait on stable Rust. Enabling this feature means that `bumpalo` will +# implement its `Allocator` trait. +allocator-api2 = { version = "0.2.8", default-features = false, optional = true } [dev-dependencies] quickcheck = "1.0.3" diff --git a/README.md b/README.md index 1b58219..6a83b8c 100644 --- a/README.md +++ b/README.md @@ -207,7 +207,15 @@ v.push(2); [`Allocator`]: https://doc.rust-lang.org/std/alloc/trait.Allocator.html -#### Minimum Supported Rust Version (MSRV) +### Using the `Allocator` API on Stable Rust + +You can enable the `allocator_api2` Cargo feature and `bumpalo` will use [the +`allocator_api2` crate](https://crates.io/crates/allocator-api2) to implement +the unstable nightly`Allocator` API on stable Rust. This means that +`bumpalo::Bump` will be usable with any collection that is generic over +`allocator_api2::Allocator`. + +### Minimum Supported Rust Version (MSRV) This crate is guaranteed to compile on stable Rust **1.63** and up. It might compile with older versions but that may change in any new patch release.