diff options
| author | Christian Schrefl <chrisi.schrefl@gmail.com> | 2025-04-21 22:18:13 +0000 |
|---|---|---|
| committer | Benno Lossin <benno.lossin@proton.me> | 2025-05-01 18:14:29 +0200 |
| commit | bc5f3e0e01a5f2d067ff4292d5a10093ae680f53 (patch) | |
| tree | 25638b199f14aa2b5c2744ff5aab54179cc185fc /rust | |
| parent | b862aac8fd46601fa20226c9f5d6c6d308678b4d (diff) | |
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: https://github.com/Rust-for-Linux/pin-init/pull/37/commits/986555f564645efb238e8092c6314388c859efe5
[ Fixed commit authorship. - Benno ]
Signed-off-by: Benno Lossin <benno.lossin@proton.me>
Diffstat (limited to 'rust')
| -rw-r--r-- | rust/pin-init/README.md | 6 | ||||
| -rw-r--r-- | rust/pin-init/src/lib.rs | 6 |
2 files changed, 12 insertions, 0 deletions
diff --git a/rust/pin-init/README.md b/rust/pin-init/README.md index 24d0f0a3f8fb..1a03b200d4ce 100644 --- a/rust/pin-init/README.md +++ b/rust/pin-init/README.md @@ -40,6 +40,12 @@ However, using the crate on stable compilers is possible by disabling `alloc`. I will require the `std` feature, because stable compilers have neither `Box` nor `Arc` in no-std mode. +### Nightly needed for `unsafe-pinned` feature + +This feature enables the `Wrapper` 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. + ## Overview To initialize a `struct` with an in-place constructor you will need two things: diff --git a/rust/pin-init/src/lib.rs b/rust/pin-init/src/lib.rs index 745cf534d239..1521500a46b1 100644 --- a/rust/pin-init/src/lib.rs +++ b/rust/pin-init/src/lib.rs @@ -32,6 +32,12 @@ //! will require the `std` feature, because stable compilers have neither `Box` nor `Arc` in no-std //! mode. //! +//! ## Nightly needed for `unsafe-pinned` feature +//! +//! This feature enables the `Wrapper` 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. +//! //! # Overview //! //! To initialize a `struct` with an in-place constructor you will need two things: |