Skip to content

Commit 5879d7f

Browse files
onestackedy86-dev
authored andcommitted
Update Changelog and Readme
Add Changelog entry for the `Wrapper` trait and document the `unsafe-pinned` feature in the Readme. Signed-off-by: Christian Schrefl <[email protected]>
1 parent 4598d18 commit 5879d7f

File tree

3 files changed

+16
-0
lines changed

3 files changed

+16
-0
lines changed

CHANGELOG.md

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

88
## [Unreleased]
99

10+
### Added
11+
12+
- `Wrapper<T>` trait added for creating wrapper structs with a structurally pinned value.
13+
1014
### Changed
1115

1216
- `InPlaceInit` now only exists when the `alloc` or `std` features are enabled

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ 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 `Wrapper` implementation on the unstable `core::pin::UnsafePinned` type.
46+
This requires the [`unsafe_pinned` unstable feature](https://github.com/rust-lang/rust/issues/125735)
47+
and therefore a nightly compiler. Note that this feature is not enabled by default.
48+
4349
## Overview
4450

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

src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@
3232
//! will require the `std` feature, because stable compilers have neither `Box` nor `Arc` in no-std
3333
//! mode.
3434
//!
35+
//! ## Nightly needed for `unsafe-pinned` feature
36+
//!
37+
//! This feature enables the `Wrapper` implementation on the unstable `core::pin::UnsafePinned` type.
38+
//! This requires the [`unsafe_pinned` unstable feature](https://github.com/rust-lang/rust/issues/125735)
39+
//! and therefore a nightly compiler. Note that this feature is not enabled by default.
40+
//!
3541
//! # Overview
3642
//!
3743
//! To initialize a `struct` with an in-place constructor you will need two things:

0 commit comments

Comments
 (0)