Expand documantation for std::pin module

src/libcore/pin.rs

@@ -7,23 +7,30 @@
 //! since moving an object with pointers to itself will invalidate them,
 //! which could cause undefined behavior.
 //!
-//! In order to prevent objects from moving, they must be pinned
+//! By default, all types in Rust are movable. Rust allows passing all types by-value,
-//! by wrapping a pointer to the data in the [`Pin`] type. A pointer wrapped
+//! and common smart-pointer types such as `Box`, `Rc`, and `&mut` allow replacing and
-//! in a `Pin` is otherwise equivalent to its normal version, e.g., `Pin<Box<T>>`
+//! moving the values they contain. In order to prevent objects from moving, they must
-//! and `Box<T>` work the same way except that the first is pinning the value
+//! be pinned by wrapping a pointer to the data in the [`Pin`] type.
-//! of `T` in place.
+//! Doing this prohibits moving the value behind the pointer.
+//! For example, `Pin<Box<T>>` functions much like a regular `Box<T>`,
+//! but doesn't allow moving `T`. The pointer value itself (the `Box`) can still be moved,
+//! but the value behind it cannot.
 //!
-//! First of all, these are pointer types because pinned data mustn't be passed around by value
+//! Since data can be moved out of `&mut` and `Box` with functions such as [`swap`],
-//! (that would change its location in memory).
+//! changing the location of the underlying data, [`Pin`] prohibits accessing the
-//! Secondly, since data can be moved out of `&mut` and `Box` with functions such as [`swap`],
+//! underlying pointer type (the `&mut` or `Box`) directly, and provides its own set of
-//! which causes their contents to swap places in memory,
+//! APIs for accessing and using the value.
-//! we need dedicated types that prohibit such operations.
 //!
-//! However, these restrictions are usually not necessary,
+//! However, these restrictions are usually not necessary. Many types are always freely
-//! so most types implement the [`Unpin`] auto-trait,
+//! movable. These types implement the [`Unpin`] auto-trait, which nullifies the affect
-//! which indicates that the type can be moved out safely.
+//! of [`Pin`]. For `T: Unpin`, `Pin<Box<T>>` and `Box<T>` function identically, as do
-//! Doing so removes the limitations of pinning types,
+//! `Pin<&mut T>` and `&mut T`.
-//! making them the same as their non-pinning counterparts.
+//!
+//! Note that pinning and `Unpin` only affect the pointed-to type. For example, whether
+//! or not `Box<T>` is `Unpin` has no affect on the behavior of `Pin<Box<T>>`. Similarly,
+//! `Pin<Box<T>>` and `Pin<&mut T>` are always `Unpin` themselves, even though the
+//! `T` underneath them isn't, because the pointers in `Pin<Box<_>>` and `Pin<&mut _>`
+//! are always freely movable, even if the data they point to isn't.
 //!
 //! [`Pin`]: struct.Pin.html
 //! [`Unpin`]: trait.Unpin.html