Skip to content

Commit bc5f3e0

Browse files
onestackedBennoLossin
authored andcommitted
rust: pin-init: 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 <chrisi.schrefl@gmail.com> Link: Rust-for-Linux/pin-init@986555f [ Fixed commit authorship. - Benno ] Signed-off-by: Benno Lossin <benno.lossin@proton.me>
1 parent b862aac commit bc5f3e0

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

rust/pin-init/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:

rust/pin-init/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)