]> git.lizzy.rs Git - rust.git/commitdiff
examples
authorRalf Jung <post@ralfj.de>
Tue, 19 Feb 2019 19:54:31 +0000 (20:54 +0100)
committerRalf Jung <post@ralfj.de>
Tue, 19 Feb 2019 19:54:31 +0000 (20:54 +0100)
src/libcore/pin.rs

index 2d674fe4f791ec8d80c405cc5d7ab80a6ac5b318..a142fd811ad8ef17fe96ddc04c03df11b4496f18 100644 (file)
@@ -36,7 +36,9 @@
 //!
 //! However, these restrictions are usually not necessary. Many types are always freely
 //! movable, even when pinned, because they do not rely on having a stable address.
-//! These types implement the [`Unpin`] auto-trait, which
+//! This includes all the basic types (`bool`, `i32` and friends, references)
+//! as well as types consisting solely of these types.
+//! Types that do not care about pinning implement the [`Unpin`] auto-trait, which
 //! nullifies the effect of [`Pin`]. For `T: Unpin`, `Pin<Box<T>>` and `Box<T>` function
 //! identically, as do `Pin<&mut T>` and `&mut T`.
 //!