about summary refs log tree commit diff
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2016-04-06 12:12:09 -0700
committerSteve Klabnik <steve@steveklabnik.com>2016-04-06 12:12:09 -0700
commit510b3803174fc3effff6a6ffe3dcc93bdfaaa534 (patch)
tree7383bcfb7e2f93cb68372e916fe718f21486506f
parentea28533e251f490ca5034a549a9b2def4464fdf2 (diff)
parent6fee337b10107e421fee0ca580f0feba224dbb93 (diff)
downloadrust-510b3803174fc3effff6a6ffe3dcc93bdfaaa534.tar.gz
rust-510b3803174fc3effff6a6ffe3dcc93bdfaaa534.zip
Rollup merge of #32744 - GuillaumeGomez:patch-3, r=steveklabnik
Add example doc for ToOwned trait

Fixes #29342.

r? @steveklabnik
-rw-r--r--src/libcollections/borrow.rs12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/libcollections/borrow.rs b/src/libcollections/borrow.rs
index 0e92676cf97..6ca0db68a88 100644
--- a/src/libcollections/borrow.rs
+++ b/src/libcollections/borrow.rs
@@ -49,6 +49,18 @@ pub trait ToOwned {
     type Owned: Borrow<Self>;
 
     /// Creates owned data from borrowed data, usually by cloning.
+    ///
+    /// # Examples
+    ///
+    /// Basic usage:
+    ///
+    /// ```
+    /// let s = "a"; // &str
+    /// let ss = s.to_owned(); // String
+    ///
+    /// let v = &[1, 2]; // slice
+    /// let vv = v.to_owned(); // Vec
+    /// ```
     #[stable(feature = "rust1", since = "1.0.0")]
     fn to_owned(&self) -> Self::Owned;
 }