]> git.lizzy.rs Git - rust.git/commitdiff
Add doc example for `std::thread::Builder::name`.
authorCorey Farwell <coreyf@rwell.org>
Sat, 25 Jun 2016 11:22:19 +0000 (07:22 -0400)
committerCorey Farwell <coreyf@rwell.org>
Sat, 25 Jun 2016 11:22:19 +0000 (07:22 -0400)
src/libstd/thread/mod.rs

index 1f78b32bcf38e9c8f7445d3e895a23d4080f1f85..8be4f619c7dc49942b0a14734419ef12c9bee0ee 100644 (file)
@@ -220,6 +220,21 @@ pub fn new() -> Builder {
 
     /// Names the thread-to-be. Currently the name is used for identification
     /// only in panic messages.
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// use std::thread;
+    ///
+    /// let builder = thread::Builder::new()
+    ///     .name("foo".into());
+    ///
+    /// let handler = builder.spawn(|| {
+    ///     assert_eq!(thread::current().name(), Some("foo"))
+    /// }).unwrap();
+    ///
+    /// handler.join().unwrap();
+    /// ```
     #[stable(feature = "rust1", since = "1.0.0")]
     pub fn name(mut self, name: String) -> Builder {
         self.name = Some(name);