Skip to content

Commit 8c04c06

Browse files
committed
Auto merge of #116074 - fzs111:clarify-pin-docs, r=Mark-Simulacrum
Clarify example in `Pin::new_unchecked` docs This example in the docs of `Pin::new_unchecked` puzzled me for a relatively long time. Now I understand that it comes down to the difference between dropping the `Pin` vs dropping the pinned value. I have extended the explanation to highlight this difference. In my opinion it is clearer now, and I hope it helps others understand `Pin` better.
2 parents 5105b1e + 0f248d8 commit 8c04c06

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

library/core/src/pin.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -572,7 +572,10 @@ impl<P: Deref> Pin<P> {
572572
/// // though we have previously pinned it! We have violated the pinning API contract.
573573
/// }
574574
/// ```
575-
/// A value, once pinned, must remain pinned forever (unless its type implements `Unpin`).
575+
/// A value, once pinned, must remain pinned until it is dropped (unless its type implements
576+
/// `Unpin`). Because `Pin<&mut T>` does not own the value, dropping the `Pin` will not drop
577+
/// the value and will not end the pinning contract. So moving the value after dropping the
578+
/// `Pin<&mut T>` is still a violation of the API contract.
576579
///
577580
/// Similarly, calling `Pin::new_unchecked` on an `Rc<T>` is unsafe because there could be
578581
/// aliases to the same data that are not subject to the pinning restrictions:

0 commit comments

Comments
 (0)