Skip to content

Commit

Permalink
link Unpin to pin module documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nivkner committed Aug 22, 2018
1 parent bfed149 commit c3fd65b
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/libcore/marker.rs
Expand Up @@ -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`].
Expand All @@ -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 {}

Expand Down

0 comments on commit c3fd65b

Please sign in to comment.