We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent f9efd05 commit 1bb0579Copy full SHA for 1bb0579
src/liballoc/pin.rs
@@ -103,6 +103,15 @@ use core::task::{Context, Poll};
103
use boxed::Box;
104
105
/// A pinned, heap allocated reference.
106
+///
107
+/// This type is similar to [`Box`], except that it pins its value,
108
+/// which prevents it from moving out of the reference, unless it implements [`Unpin`].
109
110
+/// See the [module documentation] for furthur explaination on pinning.
111
112
+/// [`Box`]: ../boxed/struct.Box.html
113
+/// [`Unpin`]: ../../core/marker/trait.Unpin.html
114
+/// [module documentation]: index.html
115
#[unstable(feature = "pin", issue = "49150")]
116
#[fundamental]
117
#[repr(transparent)]
0 commit comments