about summary refs log tree commit diff
path: root/src/libcore
diff options
context:
space:
mode:
authorNiv Kaminer <nivkner@zoho.com>2018-08-21 22:53:50 +0300
committerNiv Kaminer <nivkner@zoho.com>2018-08-23 02:13:02 +0300
commitc3fd65ba23ab6bc7e99897bd65b069144424f48a (patch)
treeafdc10b4ec18cc4cb01a4168d2cb11c653e0639b /src/libcore
parentbfed149020cc48260056c8621d93a7931fba6bde (diff)
downloadrust-c3fd65ba23ab6bc7e99897bd65b069144424f48a.tar.gz
rust-c3fd65ba23ab6bc7e99897bd65b069144424f48a.zip
link Unpin to pin module documentation
Diffstat (limited to 'src/libcore')
-rw-r--r--src/libcore/marker.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/libcore/marker.rs b/src/libcore/marker.rs
index 11f4821a925..419170ca5ab 100644
--- a/src/libcore/marker.rs
+++ b/src/libcore/marker.rs
@@ -611,6 +611,7 @@ unsafe impl<'a, T: ?Sized> Freeze for &'a mut T {}
 /// Instead it can be used to prevent moves through the type system,
 /// by controlling the behavior of special pointer types like [`PinMut`],
 /// which "pin" the type in place by not allowing it to be moved out of them.
+/// See the [`pin module`] documentation for more information on pinning.
 ///
 /// Implementing this trait lifts the restrictions of pinning off a type,
 /// which then allows it to move out with functions such as [`replace`].
@@ -632,6 +633,7 @@ unsafe impl<'a, T: ?Sized> Freeze for &'a mut T {}
 ///
 /// [`replace`]: ../../core/mem/fn.replace.html
 /// [`PinMut`]: ../pin/struct.PinMut.html
+/// [`pin module`]: ../../alloc/pin/index.html
 #[unstable(feature = "pin", issue = "49150")]
 pub auto trait Unpin {}