1 //! Types that pin data to its location in memory.
3 //! It is sometimes useful to have objects that are guaranteed not to move,
4 //! in the sense that their placement in memory does not change, and can thus be relied upon.
5 //! A prime example of such a scenario would be building self-referential structs,
6 //! as moving an object with pointers to itself will invalidate them, which could cause undefined
9 //! A [`Pin<P>`] ensures that the pointee of any pointer type `P` has a stable location in memory,
10 //! meaning it cannot be moved elsewhere and its memory cannot be deallocated
11 //! until it gets dropped. We say that the pointee is "pinned".
13 //! By default, all types in Rust are movable. Rust allows passing all types by-value,
14 //! and common smart-pointer types such as [`Box<T>`] and `&mut T` allow replacing and
15 //! moving the values they contain: you can move out of a [`Box<T>`], or you can use [`mem::swap`].
16 //! [`Pin<P>`] wraps a pointer type `P`, so [`Pin`]`<`[`Box`]`<T>>` functions much like a regular
17 //! [`Box<T>`]: when a [`Pin`]`<`[`Box`]`<T>>` gets dropped, so do its contents, and the memory gets
18 //! deallocated. Similarly, [`Pin`]`<&mut T>` is a lot like `&mut T`. However, [`Pin<P>`] does
19 //! not let clients actually obtain a [`Box<T>`] or `&mut T` to pinned data, which implies that you
20 //! cannot use operations such as [`mem::swap`]:
23 //! use std::pin::Pin;
24 //! fn swap_pins<T>(x: Pin<&mut T>, y: Pin<&mut T>) {
25 //! // `mem::swap` needs `&mut T`, but we cannot get it.
26 //! // We are stuck, we cannot swap the contents of these references.
27 //! // We could use `Pin::get_unchecked_mut`, but that is unsafe for a reason:
28 //! // we are not allowed to use it for moving things out of the `Pin`.
32 //! It is worth reiterating that [`Pin<P>`] does *not* change the fact that a Rust compiler
33 //! considers all types movable. [`mem::swap`] remains callable for any `T`. Instead, [`Pin<P>`]
34 //! prevents certain *values* (pointed to by pointers wrapped in [`Pin<P>`]) from being
35 //! moved by making it impossible to call methods that require `&mut T` on them
36 //! (like [`mem::swap`]).
38 //! [`Pin<P>`] can be used to wrap any pointer type `P`, and as such it interacts with
39 //! [`Deref`] and [`DerefMut`]. A [`Pin<P>`] where `P: Deref` should be considered
40 //! as a "`P`-style pointer" to a pinned `P::Target` -- so, a [`Pin`]`<`[`Box`]`<T>>` is
41 //! an owned pointer to a pinned `T`, and a [`Pin`]`<`[`Rc`]`<T>>` is a reference-counted
42 //! pointer to a pinned `T`.
43 //! For correctness, [`Pin<P>`] relies on the implementations of [`Deref`] and
44 //! [`DerefMut`] not to move out of their `self` parameter, and only ever to
45 //! return a pointer to pinned data when they are called on a pinned pointer.
49 //! Many types are always freely movable, even when pinned, because they do not
50 //! rely on having a stable address. This includes all the basic types (like
51 //! [`bool`], [`i32`], and references) as well as types consisting solely of these
52 //! types. Types that do not care about pinning implement the [`Unpin`]
53 //! auto-trait, which cancels the effect of [`Pin<P>`]. For `T: Unpin`,
54 //! [`Pin`]`<`[`Box`]`<T>>` and [`Box<T>`] function identically, as do [`Pin`]`<&mut T>` and
57 //! Note that pinning and [`Unpin`] only affect the pointed-to type `P::Target`, not the pointer
58 //! type `P` itself that got wrapped in [`Pin<P>`]. For example, whether or not [`Box<T>`] is
59 //! [`Unpin`] has no effect on the behavior of [`Pin`]`<`[`Box`]`<T>>` (here, `T` is the
62 //! # Example: self-referential struct
65 //! use std::pin::Pin;
66 //! use std::marker::PhantomPinned;
67 //! use std::ptr::NonNull;
69 //! // This is a self-referential struct because the slice field points to the data field.
70 //! // We cannot inform the compiler about that with a normal reference,
71 //! // as this pattern cannot be described with the usual borrowing rules.
72 //! // Instead we use a raw pointer, though one which is known not to be null,
73 //! // as we know it's pointing at the string.
74 //! struct Unmovable {
76 //! slice: NonNull<String>,
77 //! _pin: PhantomPinned,
81 //! // To ensure the data doesn't move when the function returns,
82 //! // we place it in the heap where it will stay for the lifetime of the object,
83 //! // and the only way to access it would be through a pointer to it.
84 //! fn new(data: String) -> Pin<Box<Self>> {
85 //! let res = Unmovable {
87 //! // we only create the pointer once the data is in place
88 //! // otherwise it will have already moved before we even started
89 //! slice: NonNull::dangling(),
90 //! _pin: PhantomPinned,
92 //! let mut boxed = Box::pin(res);
94 //! let slice = NonNull::from(&boxed.data);
95 //! // we know this is safe because modifying a field doesn't move the whole struct
97 //! let mut_ref: Pin<&mut Self> = Pin::as_mut(&mut boxed);
98 //! Pin::get_unchecked_mut(mut_ref).slice = slice;
104 //! let unmoved = Unmovable::new("hello".to_string());
105 //! // The pointer should point to the correct location,
106 //! // so long as the struct hasn't moved.
107 //! // Meanwhile, we are free to move the pointer around.
108 //! # #[allow(unused_mut)]
109 //! let mut still_unmoved = unmoved;
110 //! assert_eq!(still_unmoved.slice, NonNull::from(&still_unmoved.data));
112 //! // Since our type doesn't implement Unpin, this will fail to compile:
113 //! // let mut new_unmoved = Unmovable::new("world".to_string());
114 //! // std::mem::swap(&mut *still_unmoved, &mut *new_unmoved);
117 //! # Example: intrusive doubly-linked list
119 //! In an intrusive doubly-linked list, the collection does not actually allocate
120 //! the memory for the elements itself. Allocation is controlled by the clients,
121 //! and elements can live on a stack frame that lives shorter than the collection does.
123 //! To make this work, every element has pointers to its predecessor and successor in
124 //! the list. Elements can only be added when they are pinned, because moving the elements
125 //! around would invalidate the pointers. Moreover, the [`Drop`] implementation of a linked
126 //! list element will patch the pointers of its predecessor and successor to remove itself
129 //! Crucially, we have to be able to rely on [`drop`] being called. If an element
130 //! could be deallocated or otherwise invalidated without calling [`drop`], the pointers into it
131 //! from its neighbouring elements would become invalid, which would break the data structure.
133 //! Therefore, pinning also comes with a [`drop`]-related guarantee.
135 //! # `Drop` guarantee
137 //! The purpose of pinning is to be able to rely on the placement of some data in memory.
138 //! To make this work, not just moving the data is restricted; deallocating, repurposing, or
139 //! otherwise invalidating the memory used to store the data is restricted, too.
140 //! Concretely, for pinned data you have to maintain the invariant
141 //! that *its memory will not get invalidated or repurposed from the moment it gets pinned until
142 //! when [`drop`] is called*. Only once [`drop`] returns or panics, the memory may be reused.
144 //! Memory can be "invalidated" by deallocation, but also by
145 //! replacing a [`Some(v)`] by [`None`], or calling [`Vec::set_len`] to "kill" some elements
146 //! off of a vector. It can be repurposed by using [`ptr::write`] to overwrite it without
147 //! calling the destructor first. None of this is allowed for pinned data without calling [`drop`].
149 //! This is exactly the kind of guarantee that the intrusive linked list from the previous
150 //! section needs to function correctly.
152 //! Notice that this guarantee does *not* mean that memory does not leak! It is still
153 //! completely okay not ever to call [`drop`] on a pinned element (e.g., you can still
154 //! call [`mem::forget`] on a [`Pin`]`<`[`Box`]`<T>>`). In the example of the doubly-linked
155 //! list, that element would just stay in the list. However you may not free or reuse the storage
156 //! *without calling [`drop`]*.
158 //! # `Drop` implementation
160 //! If your type uses pinning (such as the two examples above), you have to be careful
161 //! when implementing [`Drop`]. The [`drop`] function takes `&mut self`, but this
162 //! is called *even if your type was previously pinned*! It is as if the
163 //! compiler automatically called [`Pin::get_unchecked_mut`].
165 //! This can never cause a problem in safe code because implementing a type that
166 //! relies on pinning requires unsafe code, but be aware that deciding to make
167 //! use of pinning in your type (for example by implementing some operation on
168 //! [`Pin`]`<&Self>` or [`Pin`]`<&mut Self>`) has consequences for your [`Drop`]
169 //! implementation as well: if an element of your type could have been pinned,
170 //! you must treat [`Drop`] as implicitly taking [`Pin`]`<&mut Self>`.
172 //! For example, you could implement `Drop` as follows:
175 //! # use std::pin::Pin;
176 //! # struct Type { }
177 //! impl Drop for Type {
178 //! fn drop(&mut self) {
179 //! // `new_unchecked` is okay because we know this value is never used
180 //! // again after being dropped.
181 //! inner_drop(unsafe { Pin::new_unchecked(self)});
182 //! fn inner_drop(this: Pin<&mut Type>) {
183 //! // Actual drop code goes here.
189 //! The function `inner_drop` has the type that [`drop`] *should* have, so this makes sure that
190 //! you do not accidentally use `self`/`this` in a way that is in conflict with pinning.
192 //! Moreover, if your type is `#[repr(packed)]`, the compiler will automatically
193 //! move fields around to be able to drop them. It might even do
194 //! that for fields that happen to be sufficiently aligned. As a consequence, you cannot use
195 //! pinning with a `#[repr(packed)]` type.
197 //! # Projections and Structural Pinning
199 //! When working with pinned structs, the question arises how one can access the
200 //! fields of that struct in a method that takes just [`Pin`]`<&mut Struct>`.
201 //! The usual approach is to write helper methods (so called *projections*)
202 //! that turn [`Pin`]`<&mut Struct>` into a reference to the field, but what
203 //! type should that reference have? Is it [`Pin`]`<&mut Field>` or `&mut Field`?
204 //! The same question arises with the fields of an `enum`, and also when considering
205 //! container/wrapper types such as [`Vec<T>`], [`Box<T>`], or [`RefCell<T>`].
206 //! (This question applies to both mutable and shared references, we just
207 //! use the more common case of mutable references here for illustration.)
209 //! It turns out that it is actually up to the author of the data structure
210 //! to decide whether the pinned projection for a particular field turns
211 //! [`Pin`]`<&mut Struct>` into [`Pin`]`<&mut Field>` or `&mut Field`. There are some
212 //! constraints though, and the most important constraint is *consistency*:
213 //! every field can be *either* projected to a pinned reference, *or* have
214 //! pinning removed as part of the projection. If both are done for the same field,
215 //! that will likely be unsound!
217 //! As the author of a data structure you get to decide for each field whether pinning
218 //! "propagates" to this field or not. Pinning that propagates is also called "structural",
219 //! because it follows the structure of the type.
220 //! In the following subsections, we describe the considerations that have to be made
221 //! for either choice.
223 //! ## Pinning *is not* structural for `field`
225 //! It may seem counter-intuitive that the field of a pinned struct might not be pinned,
226 //! but that is actually the easiest choice: if a [`Pin`]`<&mut Field>` is never created,
227 //! nothing can go wrong! So, if you decide that some field does not have structural pinning,
228 //! all you have to ensure is that you never create a pinned reference to that field.
230 //! Fields without structural pinning may have a projection method that turns
231 //! [`Pin`]`<&mut Struct>` into `&mut Field`:
234 //! # use std::pin::Pin;
235 //! # type Field = i32;
236 //! # struct Struct { field: Field }
238 //! fn pin_get_field(self: Pin<&mut Self>) -> &mut Field {
239 //! // This is okay because `field` is never considered pinned.
240 //! unsafe { &mut self.get_unchecked_mut().field }
245 //! You may also `impl Unpin for Struct` *even if* the type of `field`
246 //! is not [`Unpin`]. What that type thinks about pinning is not relevant
247 //! when no [`Pin`]`<&mut Field>` is ever created.
249 //! ## Pinning *is* structural for `field`
251 //! The other option is to decide that pinning is "structural" for `field`,
252 //! meaning that if the struct is pinned then so is the field.
254 //! This allows writing a projection that creates a [`Pin`]`<&mut Field>`, thus
255 //! witnessing that the field is pinned:
258 //! # use std::pin::Pin;
259 //! # type Field = i32;
260 //! # struct Struct { field: Field }
262 //! fn pin_get_field(self: Pin<&mut Self>) -> Pin<&mut Field> {
263 //! // This is okay because `field` is pinned when `self` is.
264 //! unsafe { self.map_unchecked_mut(|s| &mut s.field) }
269 //! However, structural pinning comes with a few extra requirements:
271 //! 1. The struct must only be [`Unpin`] if all the structural fields are
272 //! [`Unpin`]. This is the default, but [`Unpin`] is a safe trait, so as the author of
273 //! the struct it is your responsibility *not* to add something like
274 //! `impl<T> Unpin for Struct<T>`. (Notice that adding a projection operation
275 //! requires unsafe code, so the fact that [`Unpin`] is a safe trait does not break
276 //! the principle that you only have to worry about any of this if you use `unsafe`.)
277 //! 2. The destructor of the struct must not move structural fields out of its argument. This
278 //! is the exact point that was raised in the [previous section][drop-impl]: `drop` takes
279 //! `&mut self`, but the struct (and hence its fields) might have been pinned before.
280 //! You have to guarantee that you do not move a field inside your [`Drop`] implementation.
281 //! In particular, as explained previously, this means that your struct must *not*
282 //! be `#[repr(packed)]`.
283 //! See that section for how to write [`drop`] in a way that the compiler can help you
284 //! not accidentally break pinning.
285 //! 3. You must make sure that you uphold the [`Drop` guarantee][drop-guarantee]:
286 //! once your struct is pinned, the memory that contains the
287 //! content is not overwritten or deallocated without calling the content's destructors.
288 //! This can be tricky, as witnessed by [`VecDeque<T>`]: the destructor of [`VecDeque<T>`]
289 //! can fail to call [`drop`] on all elements if one of the destructors panics. This violates
290 //! the [`Drop`] guarantee, because it can lead to elements being deallocated without
291 //! their destructor being called. ([`VecDeque<T>`] has no pinning projections, so this
292 //! does not cause unsoundness.)
293 //! 4. You must not offer any other operations that could lead to data being moved out of
294 //! the structural fields when your type is pinned. For example, if the struct contains an
295 //! [`Option<T>`] and there is a `take`-like operation with type
296 //! `fn(Pin<&mut Struct<T>>) -> Option<T>`,
297 //! that operation can be used to move a `T` out of a pinned `Struct<T>` -- which means
298 //! pinning cannot be structural for the field holding this data.
300 //! For a more complex example of moving data out of a pinned type, imagine if [`RefCell<T>`]
301 //! had a method `fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>`.
302 //! Then we could do the following:
304 //! fn exploit_ref_cell<T>(rc: Pin<&mut RefCell<T>>) {
305 //! { let p = rc.as_mut().get_pin_mut(); } // Here we get pinned access to the `T`.
306 //! let rc_shr: &RefCell<T> = rc.into_ref().get_ref();
307 //! let b = rc_shr.borrow_mut();
308 //! let content = &mut *b; // And here we have `&mut T` to the same data.
311 //! This is catastrophic, it means we can first pin the content of the [`RefCell<T>`]
312 //! (using `RefCell::get_pin_mut`) and then move that content using the mutable
313 //! reference we got later.
317 //! For a type like [`Vec<T>`], both possibilities (structural pinning or not) make sense.
318 //! A [`Vec<T>`] with structural pinning could have `get_pin`/`get_pin_mut` methods to get
319 //! pinned references to elements. However, it could *not* allow calling
320 //! [`pop`][Vec::pop] on a pinned [`Vec<T>`] because that would move the (structurally pinned)
321 //! contents! Nor could it allow [`push`][Vec::push], which might reallocate and thus also move the
324 //! A [`Vec<T>`] without structural pinning could `impl<T> Unpin for Vec<T>`, because the contents
325 //! are never pinned and the [`Vec<T>`] itself is fine with being moved as well.
326 //! At that point pinning just has no effect on the vector at all.
328 //! In the standard library, pointer types generally do not have structural pinning,
329 //! and thus they do not offer pinning projections. This is why `Box<T>: Unpin` holds for all `T`.
330 //! It makes sense to do this for pointer types, because moving the `Box<T>`
331 //! does not actually move the `T`: the [`Box<T>`] can be freely movable (aka `Unpin`) even if
332 //! the `T` is not. In fact, even [`Pin`]`<`[`Box`]`<T>>` and [`Pin`]`<&mut T>` are always
333 //! [`Unpin`] themselves, for the same reason: their contents (the `T`) are pinned, but the
334 //! pointers themselves can be moved without moving the pinned data. For both [`Box<T>`] and
335 //! [`Pin`]`<`[`Box`]`<T>>`, whether the content is pinned is entirely independent of whether the
336 //! pointer is pinned, meaning pinning is *not* structural.
338 //! When implementing a [`Future`] combinator, you will usually need structural pinning
339 //! for the nested futures, as you need to get pinned references to them to call [`poll`].
340 //! But if your combinator contains any other data that does not need to be pinned,
341 //! you can make those fields not structural and hence freely access them with a
342 //! mutable reference even when you just have [`Pin`]`<&mut Self>` (such as in your own
343 //! [`poll`] implementation).
345 //! [`Pin<P>`]: struct.Pin.html
346 //! [`Unpin`]: ../marker/trait.Unpin.html
347 //! [`Deref`]: ../ops/trait.Deref.html
348 //! [`DerefMut`]: ../ops/trait.DerefMut.html
349 //! [`mem::swap`]: ../mem/fn.swap.html
350 //! [`mem::forget`]: ../mem/fn.forget.html
351 //! [`Box<T>`]: ../../std/boxed/struct.Box.html
352 //! [`Vec<T>`]: ../../std/vec/struct.Vec.html
353 //! [`Vec::set_len`]: ../../std/vec/struct.Vec.html#method.set_len
354 //! [`Pin`]: struct.Pin.html
355 //! [`Box`]: ../../std/boxed/struct.Box.html
356 //! [Vec::pop]: ../../std/vec/struct.Vec.html#method.pop
357 //! [Vec::push]: ../../std/vec/struct.Vec.html#method.push
358 //! [`Rc`]: ../../std/rc/struct.Rc.html
359 //! [`RefCell<T>`]: ../../std/cell/struct.RefCell.html
360 //! [`Drop`]: ../../std/ops/trait.Drop.html
361 //! [`drop`]: ../../std/ops/trait.Drop.html#tymethod.drop
362 //! [`VecDeque<T>`]: ../../std/collections/struct.VecDeque.html
363 //! [`Option<T>`]: ../../std/option/enum.Option.html
364 //! [`VecDeque<T>`]: ../../std/collections/struct.VecDeque.html
365 //! [`RefCell<T>`]: ../cell/struct.RefCell.html
366 //! [`None`]: ../option/enum.Option.html#variant.None
367 //! [`Some(v)`]: ../option/enum.Option.html#variant.Some
368 //! [`ptr::write`]: ../ptr/fn.write.html
369 //! [`Future`]: ../future/trait.Future.html
370 //! [drop-impl]: #drop-implementation
371 //! [drop-guarantee]: #drop-guarantee
372 //! [`poll`]: ../../std/future/trait.Future.html#tymethod.poll
373 //! [`Pin::get_unchecked_mut`]: struct.Pin.html#method.get_unchecked_mut
374 //! [`bool`]: ../../std/primitive.bool.html
375 //! [`i32`]: ../../std/primitive.i32.html
377 #![stable(feature = "pin", since = "1.33.0")]
379 use crate::cmp::{self, PartialEq, PartialOrd};
381 use crate::hash::{Hash, Hasher};
382 use crate::marker::{Sized, Unpin};
383 use crate::ops::{CoerceUnsized, Deref, DerefMut, DispatchFromDyn, Receiver};
385 /// A pinned pointer.
387 /// This is a wrapper around a kind of pointer which makes that pointer "pin" its
388 /// value in place, preventing the value referenced by that pointer from being moved
389 /// unless it implements [`Unpin`].
391 /// *See the [`pin` module] documentation for an explanation of pinning.*
393 /// [`Unpin`]: ../../std/marker/trait.Unpin.html
394 /// [`pin` module]: ../../std/pin/index.html
396 // Note: the `Clone` derive below causes unsoundness as it's possible to implement
397 // `Clone` for mutable references.
398 // See <https://internals.rust-lang.org/t/unsoundness-in-pin/11311> for more details.
399 #[stable(feature = "pin", since = "1.33.0")]
403 #[derive(Copy, Clone)]
408 // The following implementations aren't derived in order to avoid soundness
409 // issues. `&self.pointer` should not be accessible to untrusted trait
412 // See <https://internals.rust-lang.org/t/unsoundness-in-pin/11311/73> for more details.
414 #[stable(feature = "pin_trait_impls", since = "1.41.0")]
415 impl<P: Deref, Q: Deref> PartialEq<Pin<Q>> for Pin<P>
417 P::Target: PartialEq<Q::Target>,
419 fn eq(&self, other: &Pin<Q>) -> bool {
420 P::Target::eq(self, other)
423 fn ne(&self, other: &Pin<Q>) -> bool {
424 P::Target::ne(self, other)
428 #[stable(feature = "pin_trait_impls", since = "1.41.0")]
429 impl<P: Deref<Target: Eq>> Eq for Pin<P> {}
431 #[stable(feature = "pin_trait_impls", since = "1.41.0")]
432 impl<P: Deref, Q: Deref> PartialOrd<Pin<Q>> for Pin<P>
434 P::Target: PartialOrd<Q::Target>,
436 fn partial_cmp(&self, other: &Pin<Q>) -> Option<cmp::Ordering> {
437 P::Target::partial_cmp(self, other)
440 fn lt(&self, other: &Pin<Q>) -> bool {
441 P::Target::lt(self, other)
444 fn le(&self, other: &Pin<Q>) -> bool {
445 P::Target::le(self, other)
448 fn gt(&self, other: &Pin<Q>) -> bool {
449 P::Target::gt(self, other)
452 fn ge(&self, other: &Pin<Q>) -> bool {
453 P::Target::ge(self, other)
457 #[stable(feature = "pin_trait_impls", since = "1.41.0")]
458 impl<P: Deref<Target: Ord>> Ord for Pin<P> {
459 fn cmp(&self, other: &Self) -> cmp::Ordering {
460 P::Target::cmp(self, other)
464 #[stable(feature = "pin_trait_impls", since = "1.41.0")]
465 impl<P: Deref<Target: Hash>> Hash for Pin<P> {
466 fn hash<H: Hasher>(&self, state: &mut H) {
467 P::Target::hash(self, state);
471 impl<P: Deref<Target: Unpin>> Pin<P> {
472 /// Construct a new `Pin<P>` around a pointer to some data of a type that
473 /// implements [`Unpin`].
475 /// Unlike `Pin::new_unchecked`, this method is safe because the pointer
476 /// `P` dereferences to an [`Unpin`] type, which cancels the pinning guarantees.
478 /// [`Unpin`]: ../../std/marker/trait.Unpin.html
479 #[stable(feature = "pin", since = "1.33.0")]
481 pub fn new(pointer: P) -> Pin<P> {
482 // Safety: the value pointed to is `Unpin`, and so has no requirements
484 unsafe { Pin::new_unchecked(pointer) }
487 /// Unwraps this `Pin<P>` returning the underlying pointer.
489 /// This requires that the data inside this `Pin` is [`Unpin`] so that we
490 /// can ignore the pinning invariants when unwrapping it.
492 /// [`Unpin`]: ../../std/marker/trait.Unpin.html
493 #[stable(feature = "pin_into_inner", since = "1.39.0")]
495 pub fn into_inner(pin: Pin<P>) -> P {
500 impl<P: Deref> Pin<P> {
501 /// Construct a new `Pin<P>` around a reference to some data of a type that
502 /// may or may not implement `Unpin`.
504 /// If `pointer` dereferences to an `Unpin` type, `Pin::new` should be used
509 /// This constructor is unsafe because we cannot guarantee that the data
510 /// pointed to by `pointer` is pinned, meaning that the data will not be moved or
511 /// its storage invalidated until it gets dropped. If the constructed `Pin<P>` does
512 /// not guarantee that the data `P` points to is pinned, that is a violation of
513 /// the API contract and may lead to undefined behavior in later (safe) operations.
515 /// By using this method, you are making a promise about the `P::Deref` and
516 /// `P::DerefMut` implementations, if they exist. Most importantly, they
517 /// must not move out of their `self` arguments: `Pin::as_mut` and `Pin::as_ref`
518 /// will call `DerefMut::deref_mut` and `Deref::deref` *on the pinned pointer*
519 /// and expect these methods to uphold the pinning invariants.
520 /// Moreover, by calling this method you promise that the reference `P`
521 /// dereferences to will not be moved out of again; in particular, it
522 /// must not be possible to obtain a `&mut P::Target` and then
523 /// move out of that reference (using, for example [`mem::swap`]).
525 /// For example, calling `Pin::new_unchecked` on an `&'a mut T` is unsafe because
526 /// while you are able to pin it for the given lifetime `'a`, you have no control
527 /// over whether it is kept pinned once `'a` ends:
530 /// use std::pin::Pin;
532 /// fn move_pinned_ref<T>(mut a: T, mut b: T) {
534 /// let p: Pin<&mut T> = Pin::new_unchecked(&mut a);
535 /// // This should mean the pointee `a` can never move again.
537 /// mem::swap(&mut a, &mut b);
538 /// // The address of `a` changed to `b`'s stack slot, so `a` got moved even
539 /// // though we have previously pinned it! We have violated the pinning API contract.
542 /// A value, once pinned, must remain pinned forever (unless its type implements `Unpin`).
544 /// Similarly, calling `Pin::new_unchecked` on an `Rc<T>` is unsafe because there could be
545 /// aliases to the same data that are not subject to the pinning restrictions:
548 /// use std::pin::Pin;
550 /// fn move_pinned_rc<T>(mut x: Rc<T>) {
551 /// let pinned = unsafe { Pin::new_unchecked(x.clone()) };
553 /// let p: Pin<&T> = pinned.as_ref();
554 /// // This should mean the pointee can never move again.
557 /// let content = Rc::get_mut(&mut x).unwrap();
558 /// // Now, if `x` was the only reference, we have a mutable reference to
559 /// // data that we pinned above, which we could use to move it as we have
560 /// // seen in the previous example. We have violated the pinning API contract.
564 /// [`mem::swap`]: ../../std/mem/fn.swap.html
565 #[stable(feature = "pin", since = "1.33.0")]
567 pub unsafe fn new_unchecked(pointer: P) -> Pin<P> {
571 /// Gets a pinned shared reference from this pinned pointer.
573 /// This is a generic method to go from `&Pin<Pointer<T>>` to `Pin<&T>`.
574 /// It is safe because, as part of the contract of `Pin::new_unchecked`,
575 /// the pointee cannot move after `Pin<Pointer<T>>` got created.
576 /// "Malicious" implementations of `Pointer::Deref` are likewise
577 /// ruled out by the contract of `Pin::new_unchecked`.
578 #[stable(feature = "pin", since = "1.33.0")]
580 pub fn as_ref(&self) -> Pin<&P::Target> {
581 // SAFETY: see documentation on this function
582 unsafe { Pin::new_unchecked(&*self.pointer) }
585 /// Unwraps this `Pin<P>` returning the underlying pointer.
589 /// This function is unsafe. You must guarantee that you will continue to
590 /// treat the pointer `P` as pinned after you call this function, so that
591 /// the invariants on the `Pin` type can be upheld. If the code using the
592 /// resulting `P` does not continue to maintain the pinning invariants that
593 /// is a violation of the API contract and may lead to undefined behavior in
594 /// later (safe) operations.
596 /// If the underlying data is [`Unpin`], [`Pin::into_inner`] should be used
599 /// [`Unpin`]: ../../std/marker/trait.Unpin.html
600 /// [`Pin::into_inner`]: #method.into_inner
601 #[stable(feature = "pin_into_inner", since = "1.39.0")]
603 pub unsafe fn into_inner_unchecked(pin: Pin<P>) -> P {
608 impl<P: DerefMut> Pin<P> {
609 /// Gets a pinned mutable reference from this pinned pointer.
611 /// This is a generic method to go from `&mut Pin<Pointer<T>>` to `Pin<&mut T>`.
612 /// It is safe because, as part of the contract of `Pin::new_unchecked`,
613 /// the pointee cannot move after `Pin<Pointer<T>>` got created.
614 /// "Malicious" implementations of `Pointer::DerefMut` are likewise
615 /// ruled out by the contract of `Pin::new_unchecked`.
617 /// This method is useful when doing multiple calls to functions that consume the pinned type.
622 /// use std::pin::Pin;
626 /// fn method(self: Pin<&mut Self>) {
630 /// fn call_method_twice(mut self: Pin<&mut Self>) {
631 /// // `method` consumes `self`, so reborrow the `Pin<&mut Self>` via `as_mut`.
632 /// self.as_mut().method();
633 /// self.as_mut().method();
637 #[stable(feature = "pin", since = "1.33.0")]
639 pub fn as_mut(&mut self) -> Pin<&mut P::Target> {
640 // SAFETY: see documentation on this function
641 unsafe { Pin::new_unchecked(&mut *self.pointer) }
644 /// Assigns a new value to the memory behind the pinned reference.
646 /// This overwrites pinned data, but that is okay: its destructor gets
647 /// run before being overwritten, so no pinning guarantee is violated.
648 #[stable(feature = "pin", since = "1.33.0")]
650 pub fn set(&mut self, value: P::Target)
654 *(self.pointer) = value;
658 impl<'a, T: ?Sized> Pin<&'a T> {
659 /// Constructs a new pin by mapping the interior value.
661 /// For example, if you wanted to get a `Pin` of a field of something,
662 /// you could use this to get access to that field in one line of code.
663 /// However, there are several gotchas with these "pinning projections";
664 /// see the [`pin` module] documentation for further details on that topic.
668 /// This function is unsafe. You must guarantee that the data you return
669 /// will not move so long as the argument value does not move (for example,
670 /// because it is one of the fields of that value), and also that you do
671 /// not move out of the argument you receive to the interior function.
673 /// [`pin` module]: ../../std/pin/index.html#projections-and-structural-pinning
674 #[stable(feature = "pin", since = "1.33.0")]
675 pub unsafe fn map_unchecked<U, F>(self, func: F) -> Pin<&'a U>
680 let pointer = &*self.pointer;
681 let new_pointer = func(pointer);
682 Pin::new_unchecked(new_pointer)
685 /// Gets a shared reference out of a pin.
687 /// This is safe because it is not possible to move out of a shared reference.
688 /// It may seem like there is an issue here with interior mutability: in fact,
689 /// it *is* possible to move a `T` out of a `&RefCell<T>`. However, this is
690 /// not a problem as long as there does not also exist a `Pin<&T>` pointing
691 /// to the same data, and `RefCell<T>` does not let you create a pinned reference
692 /// to its contents. See the discussion on ["pinning projections"] for further
695 /// Note: `Pin` also implements `Deref` to the target, which can be used
696 /// to access the inner value. However, `Deref` only provides a reference
697 /// that lives for as long as the borrow of the `Pin`, not the lifetime of
698 /// the `Pin` itself. This method allows turning the `Pin` into a reference
699 /// with the same lifetime as the original `Pin`.
701 /// ["pinning projections"]: ../../std/pin/index.html#projections-and-structural-pinning
702 #[stable(feature = "pin", since = "1.33.0")]
704 pub fn get_ref(self) -> &'a T {
709 impl<'a, T: ?Sized> Pin<&'a mut T> {
710 /// Converts this `Pin<&mut T>` into a `Pin<&T>` with the same lifetime.
711 #[stable(feature = "pin", since = "1.33.0")]
713 pub fn into_ref(self) -> Pin<&'a T> {
714 Pin { pointer: self.pointer }
717 /// Gets a mutable reference to the data inside of this `Pin`.
719 /// This requires that the data inside this `Pin` is `Unpin`.
721 /// Note: `Pin` also implements `DerefMut` to the data, which can be used
722 /// to access the inner value. However, `DerefMut` only provides a reference
723 /// that lives for as long as the borrow of the `Pin`, not the lifetime of
724 /// the `Pin` itself. This method allows turning the `Pin` into a reference
725 /// with the same lifetime as the original `Pin`.
726 #[stable(feature = "pin", since = "1.33.0")]
728 pub fn get_mut(self) -> &'a mut T
735 /// Gets a mutable reference to the data inside of this `Pin`.
739 /// This function is unsafe. You must guarantee that you will never move
740 /// the data out of the mutable reference you receive when you call this
741 /// function, so that the invariants on the `Pin` type can be upheld.
743 /// If the underlying data is `Unpin`, `Pin::get_mut` should be used
745 #[stable(feature = "pin", since = "1.33.0")]
747 pub unsafe fn get_unchecked_mut(self) -> &'a mut T {
751 /// Construct a new pin by mapping the interior value.
753 /// For example, if you wanted to get a `Pin` of a field of something,
754 /// you could use this to get access to that field in one line of code.
755 /// However, there are several gotchas with these "pinning projections";
756 /// see the [`pin` module] documentation for further details on that topic.
760 /// This function is unsafe. You must guarantee that the data you return
761 /// will not move so long as the argument value does not move (for example,
762 /// because it is one of the fields of that value), and also that you do
763 /// not move out of the argument you receive to the interior function.
765 /// [`pin` module]: ../../std/pin/index.html#projections-and-structural-pinning
766 #[stable(feature = "pin", since = "1.33.0")]
767 pub unsafe fn map_unchecked_mut<U, F>(self, func: F) -> Pin<&'a mut U>
770 F: FnOnce(&mut T) -> &mut U,
772 let pointer = Pin::get_unchecked_mut(self);
773 let new_pointer = func(pointer);
774 Pin::new_unchecked(new_pointer)
778 #[stable(feature = "pin", since = "1.33.0")]
779 impl<P: Deref> Deref for Pin<P> {
780 type Target = P::Target;
781 fn deref(&self) -> &P::Target {
782 Pin::get_ref(Pin::as_ref(self))
786 #[stable(feature = "pin", since = "1.33.0")]
787 impl<P: DerefMut<Target: Unpin>> DerefMut for Pin<P> {
788 fn deref_mut(&mut self) -> &mut P::Target {
789 Pin::get_mut(Pin::as_mut(self))
793 #[unstable(feature = "receiver_trait", issue = "none")]
794 impl<P: Receiver> Receiver for Pin<P> {}
796 #[stable(feature = "pin", since = "1.33.0")]
797 impl<P: fmt::Debug> fmt::Debug for Pin<P> {
798 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
799 fmt::Debug::fmt(&self.pointer, f)
803 #[stable(feature = "pin", since = "1.33.0")]
804 impl<P: fmt::Display> fmt::Display for Pin<P> {
805 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
806 fmt::Display::fmt(&self.pointer, f)
810 #[stable(feature = "pin", since = "1.33.0")]
811 impl<P: fmt::Pointer> fmt::Pointer for Pin<P> {
812 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
813 fmt::Pointer::fmt(&self.pointer, f)
817 // Note: this means that any impl of `CoerceUnsized` that allows coercing from
818 // a type that impls `Deref<Target=impl !Unpin>` to a type that impls
819 // `Deref<Target=Unpin>` is unsound. Any such impl would probably be unsound
820 // for other reasons, though, so we just need to take care not to allow such
821 // impls to land in std.
822 #[stable(feature = "pin", since = "1.33.0")]
823 impl<P, U> CoerceUnsized<Pin<U>> for Pin<P> where P: CoerceUnsized<U> {}
825 #[stable(feature = "pin", since = "1.33.0")]
826 impl<P, U> DispatchFromDyn<Pin<U>> for Pin<P> where P: DispatchFromDyn<U> {}