Skip to content

Commit 3155517

Browse files
committed
Update Changelog and Readme
Add Changelog entry for the `PinInitable` trait and document the `unsafe-pinned` feature in the Readme. Signed-off-by: Christian Schrefl <chrisi.schrefl@gmail.com>
1 parent de17678 commit 3155517

2 files changed

Lines changed: 5 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### Changed
1111

12+
- `PinInitable` trait added for creating wrapper structs with a structurally pinned value.
1213
- `InPlaceInit` now only exists when the `alloc` or `std` features are enabled
1314

1415
## [0.0.9] - 2024-12-02

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ However, using the crate on stable compilers is possible by disabling `alloc`. I
4040
will require the `std` feature, because stable compilers have neither `Box` nor `Arc` in no-std
4141
mode.
4242

43+
### Nightly needed for `unsafe-pinned` feature
44+
45+
This feature enables the `PinInitable` implementation on the unstable `core::pin::UnsafePinned` type. This requires the [`unsafe_pinned` unstable feature](https://github.com/rust-lang/rust/issues/125735) and therefore a nightly compiler. Note that this feature is not enabled by default.
46+
4347
## Overview
4448

4549
To initialize a `struct` with an in-place constructor you will need two things:

0 commit comments

Comments
 (0)