From 684fe9a6b2b39e6b8a1089eecd0334ef484fcc56 Mon Sep 17 00:00:00 2001
From: Taylor Cramer <cramertj@google.com>
Date: Tue, 18 Dec 2018 10:25:02 -0800
Subject: Rename Box/Arc/Rc::pinned to ::pin

---
 src/liballoc/boxed.rs | 4 +++-
 src/liballoc/rc.rs    | 4 +++-
 src/liballoc/sync.rs  | 4 +++-
 3 files changed, 9 insertions(+), 3 deletions(-)

(limited to 'src/liballoc')

diff --git a/src/liballoc/boxed.rs b/src/liballoc/boxed.rs
index 6a63bee2795..7438f3e6c9d 100644
--- a/src/liballoc/boxed.rs
+++ b/src/liballoc/boxed.rs
@@ -111,9 +111,11 @@ impl<T> Box<T> {
         box x
     }
 
+    /// Constructs a new `Pin<Box<T>>`. If `T` does not implement `Unpin`, then
+    /// `x` will be pinned in memory and unable to be moved.
     #[stable(feature = "pin", since = "1.33.0")]
     #[inline(always)]
-    pub fn pinned(x: T) -> Pin<Box<T>> {
+    pub fn pin(x: T) -> Pin<Box<T>> {
         (box x).into()
     }
 }
diff --git a/src/liballoc/rc.rs b/src/liballoc/rc.rs
index a8574e82c27..14cbb204f5f 100644
--- a/src/liballoc/rc.rs
+++ b/src/liballoc/rc.rs
@@ -325,8 +325,10 @@ impl<T> Rc<T> {
         }
     }
 
+    /// Constructs a new `Pin<Rc<T>>`. If `T` does not implement `Unpin`, then
+    /// `value` will be pinned in memory and unable to be moved.
     #[stable(feature = "pin", since = "1.33.0")]
-    pub fn pinned(value: T) -> Pin<Rc<T>> {
+    pub fn pin(value: T) -> Pin<Rc<T>> {
         unsafe { Pin::new_unchecked(Rc::new(value)) }
     }
 
diff --git a/src/liballoc/sync.rs b/src/liballoc/sync.rs
index ac709a15aaa..c1a1e6f1591 100644
--- a/src/liballoc/sync.rs
+++ b/src/liballoc/sync.rs
@@ -303,8 +303,10 @@ impl<T> Arc<T> {
         Arc { ptr: Box::into_raw_non_null(x), phantom: PhantomData }
     }
 
+    /// Constructs a new `Pin<Arc<T>>`. If `T` does not implement `Unpin`, then
+    /// `data` will be pinned in memory and unable to be moved.
     #[stable(feature = "pin", since = "1.33.0")]
-    pub fn pinned(data: T) -> Pin<Arc<T>> {
+    pub fn pin(data: T) -> Pin<Arc<T>> {
         unsafe { Pin::new_unchecked(Arc::new(data)) }
     }
 
-- 
cgit 1.4.1-3-g733a5