Skip to content

Commit 2ca00b6

Browse files
committed
Make pin_mut! soft-deprecated in favor of std::pin::pin!
1 parent c6eb141 commit 2ca00b6

File tree

4 files changed

+15
-2
lines changed

4 files changed

+15
-2
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ Utilities for pinning
1818

1919
[Documentation][docs-url]
2020

21+
**Note:** Since Rust 1.68, this crate is soft-deprecated in favor of the following alternatives:
22+
23+
- `pin_utils::pin_mut!` is soft-deprecated in favor of [`pin!` macro in the standard library](https://doc.rust-lang.org/std/pin/macro.pin.html) that stabilized in Rust 1.68.
24+
- `pin_utils::{unsafe_pinned,unsafe_unpinned}` are **deprecated** in favor of safe alternatives: [pin-project](https://crates.io/crates/pin-project), [pin-project-lite](https://crates.io/crates/pin-project-lite)
25+
2126
## Usage
2227

2328
First, add this to your `Cargo.toml`:

src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
//! Utilities for pinning
2+
//!
3+
//! **Note:** Since Rust 1.68, this crate is soft-deprecated in favor of the following alternatives:
4+
//!
5+
//! - `pin_utils::pin_mut!` is soft-deprecated in favor of [`pin!` macro in the standard library](https://doc.rust-lang.org/std/pin/macro.pin.html) that stabilized in Rust 1.68.
6+
//! - `pin_utils::{unsafe_pinned,unsafe_unpinned}` are **deprecated** in favor of safe alternatives: [pin-project](https://crates.io/crates/pin-project), [pin-project-lite](https://crates.io/crates/pin-project-lite)
27
38
#![no_std]
49
#![warn(missing_docs, missing_debug_implementations, rust_2018_idioms)]

src/projection.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
/// [`drop`]: Drop::drop
3939
#[deprecated(
4040
since = "0.1.1",
41-
note = "this macro is not safe; use pin-project or pin-project-lite crate instead"
41+
note = "this macro is not safe; use safe pin-project or pin-project-lite crate instead"
4242
)]
4343
#[macro_export]
4444
macro_rules! unsafe_pinned {
@@ -87,7 +87,7 @@ macro_rules! unsafe_pinned {
8787
/// [`Pin`]: core::pin::Pin
8888
#[deprecated(
8989
since = "0.1.1",
90-
note = "this macro is not safe; use pin-project or pin-project-lite crate instead"
90+
note = "this macro is not safe; use safe pin-project or pin-project-lite crate instead"
9191
)]
9292
#[macro_export]
9393
macro_rules! unsafe_unpinned {

src/stack_pin.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
///
33
/// Can safely pin values that are not `Unpin` by taking ownership.
44
///
5+
/// **Note:** Since Rust 1.68, this macro is soft-deprecated in favor of
6+
/// [`pin!`](core::pin::pin) macro in the standard library.
7+
///
58
/// # Example
69
///
710
/// ```rust

0 commit comments

Comments
 (0)