-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Add missing example for Thread struct #38548
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -558,6 +558,23 @@ pub fn park_timeout(dur: Duration) { | |
/// A `ThreadId` is an opaque object that has a unique value for each thread | ||
/// that creates one. `ThreadId`s do not correspond to a thread's system- | ||
/// designated identifier. | ||
/// | ||
/// # Examples | ||
/// | ||
/// ``` | ||
/// #![feature(thread_id)] | ||
/// | ||
/// use std::thread; | ||
/// | ||
/// let handler = thread::Builder::new() | ||
/// .spawn(|| { | ||
/// let thread = thread::current(); | ||
/// let thread_id = thread.id(); | ||
/// }) | ||
/// .unwrap(); | ||
/// | ||
/// handler.join().unwrap(); | ||
/// ``` | ||
#[unstable(feature = "thread_id", issue = "21507")] | ||
#[derive(Eq, PartialEq, Copy, Clone)] | ||
pub struct ThreadId(u64); | ||
|
@@ -610,6 +627,22 @@ struct Inner { | |
#[derive(Clone)] | ||
#[stable(feature = "rust1", since = "1.0.0")] | ||
/// A handle to a thread. | ||
/// | ||
/// # Examples | ||
/// | ||
/// ``` | ||
/// use std::thread; | ||
/// | ||
/// let handler = thread::Builder::new() | ||
/// .name("foo".into()) | ||
/// .spawn(|| { | ||
/// let thread = thread::current(); | ||
/// println!("thread name: {}", thread.name().unwrap()); | ||
/// }) | ||
/// .unwrap(); | ||
/// | ||
/// handler.join().unwrap(); | ||
/// ``` | ||
pub struct Thread { | ||
inner: Arc<Inner>, | ||
} | ||
|
@@ -633,6 +666,21 @@ impl Thread { | |
/// Atomically makes the handle's token available if it is not already. | ||
/// | ||
/// See the module doc for more detail. | ||
/// | ||
/// # Examples | ||
/// | ||
/// ``` | ||
/// use std::thread; | ||
/// | ||
/// let handler = thread::Builder::new() | ||
/// .spawn(|| { | ||
/// let thread = thread::current(); | ||
/// thread.unpark(); | ||
/// }) | ||
/// .unwrap(); | ||
/// | ||
/// handler.join().unwrap(); | ||
/// ``` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What is There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not much, I really wonder how to show such an example of usage actually... :-/ |
||
#[stable(feature = "rust1", since = "1.0.0")] | ||
pub fn unpark(&self) { | ||
let mut guard = self.inner.lock.lock().unwrap(); | ||
|
@@ -643,6 +691,23 @@ impl Thread { | |
} | ||
|
||
/// Gets the thread's unique identifier. | ||
/// | ||
/// # Examples | ||
/// | ||
/// ``` | ||
/// #![feature(thread_id)] | ||
/// | ||
/// use std::thread; | ||
/// | ||
/// let handler = thread::Builder::new() | ||
/// .spawn(|| { | ||
/// let thread = thread::current(); | ||
/// println!("thread id: {:?}", thread.id()); | ||
/// }) | ||
/// .unwrap(); | ||
/// | ||
/// handler.join().unwrap(); | ||
/// ``` | ||
#[unstable(feature = "thread_id", issue = "21507")] | ||
pub fn id(&self) -> ThreadId { | ||
self.inner.id | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where is
Thread
used in this example?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the
spawn
closure.