Skip to content

Commit 945d38c

Browse files
committed
Remove P: Unpin bound on impl Future for Pin
The `Unpin` bound was originally added in rust-lang#56939 following the recommendation of @withoutboats in rust-lang#55766 (comment) That comment does not give explicit justification for why the bound should be added. The relevant context was: > [ ] Remove `impl<P> Unpin for Pin<P>` > > This impl is not justified by our standard justification for unpin > impls: there is no pointer direction between `Pin<P>` and `P`. Its > usefulness is covered by the impls for pointers themselves. > > This futures impl (link to the impl changed in this PR) will need to > change to add a `P: Unpin` bound. The decision to remove the unconditional impl of `Unpin for Pin` is sound (these days there is just an auto-impl for when `P: Unpin`). But, I think the decision to also add the `Unpin` bound for `impl Future` may have been unnecessary. Or if that's not the case, I'd be very interested to have the argument for why written down somewhere. The bound _appears_ to not be needed, since the presence of a `Pin<P>` should indicate that it's safe to project to `Pin<&mut P::Target>` just like for `Pin::as_mut`.
1 parent 46c1da2 commit 945d38c

File tree

3 files changed

+41
-2
lines changed

3 files changed

+41
-2
lines changed

core/src/future/future.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,11 @@ impl<F: ?Sized + Future + Unpin> Future for &mut F {
111111
#[stable(feature = "futures_api", since = "1.36.0")]
112112
impl<P> Future for Pin<P>
113113
where
114-
P: Unpin + ops::DerefMut<Target: Future>,
114+
P: ops::DerefMut<Target: Future>,
115115
{
116116
type Output = <<P as ops::Deref>::Target as Future>::Output;
117117

118118
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
119-
Pin::get_mut(self).as_mut().poll(cx)
119+
<P::Target as Future>::poll(self.as_deref_mut(), cx)
120120
}
121121
}

core/src/lib.rs

+1
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@
127127
#![feature(no_core)]
128128
#![feature(auto_traits)]
129129
#![cfg_attr(bootstrap, feature(or_patterns))]
130+
#![feature(pin_deref_mut)]
130131
#![feature(prelude_import)]
131132
#![cfg_attr(not(bootstrap), feature(ptr_metadata))]
132133
#![feature(repr_simd, platform_intrinsics)]

core/src/pin.rs

+38
Original file line numberDiff line numberDiff line change
@@ -793,6 +793,44 @@ impl<T: ?Sized> Pin<&'static T> {
793793
}
794794
}
795795

796+
impl<'a, P: DerefMut> Pin<&'a mut Pin<P>> {
797+
/// Gets a pinned mutable reference from this nested pinned pointer.
798+
///
799+
/// This is a generic method to go from `Pin<&mut Pin<Pointer<T>>>` to `Pin<&mut T>`. It is
800+
/// safe because the existence of a `Pin<Pointer<T>>` ensures that the pointee, `T`, cannot
801+
/// move in the future, and this method does not enable the pointee to move. "Malicious"
802+
/// implementations of `Pointer::DerefMut` are likewise ruled out by the contract of
803+
/// `Pin::new_unchecked`.
804+
#[unstable(feature = "pin_deref_mut", issue = "none")]
805+
#[inline(always)]
806+
pub fn as_deref_mut(self) -> Pin<&'a mut P::Target> {
807+
// SAFETY: What we're asserting here is that going from
808+
//
809+
// Pin<&mut Pin<P>>
810+
//
811+
// to
812+
//
813+
// Pin<&mut P::Target>
814+
//
815+
// is safe.
816+
//
817+
// We need to ensure that two things hold for that to be the case:
818+
//
819+
// 1) Once we give out a `Pin<&mut P::Target>`, an `&mut P::Target` will not be given out.
820+
// 2) By giving out a `Pin<&mut P::Target>`, we do not risk of violating `Pin<&mut Pin<P>>`
821+
//
822+
// The existence of `Pin<P>` is sufficient to guarantee #1: since we already have a
823+
// `Pin<P>`, it must already uphold the pinning guarantees, which must mean that
824+
// `Pin<&mut P::Target>` does as well, since `Pin::as_mut` is safe. We do not have to rely
825+
// on the fact that P is _also_ pinned.
826+
//
827+
// For #2, we need to ensure that code given a `Pin<&mut P::Target>` cannot cause the
828+
// `Pin<P>` to move? That is not possible, since `Pin<&mut P::Target>` no longer retains
829+
// any access to the `P` itself, much less the `Pin<P>`.
830+
unsafe { self.get_unchecked_mut() }.as_mut()
831+
}
832+
}
833+
796834
impl<T: ?Sized> Pin<&'static mut T> {
797835
/// Get a pinned mutable reference from a static mutable reference.
798836
///

0 commit comments

Comments
 (0)