1.0.0[−][src]Struct std::thread::Thread
A handle to a thread.
Threads are represented via the Thread
type, which you can get in one of
two ways:
- By spawning a new thread, e.g., using the
thread::spawn
function, and callingthread
on theJoinHandle
. - By requesting the current thread, using the
thread::current
function.
The thread::current
function is available even for threads not spawned
by the APIs of this module.
There is usually no need to create a Thread
struct yourself, one
should instead use a function like spawn
to create new threads, see the
docs of Builder
and spawn
for more details.
Methods
impl Thread
[src]
pub fn unpark(&self)
[src]
Atomically makes the handle's token available if it is not already.
Every thread is equipped with some basic low-level blocking support, via
the park
function and the unpark()
method. These can be
used as a more CPU-efficient implementation of a spinlock.
See the park documentation for more details.
Examples
use std::thread; use std::time::Duration; let parked_thread = thread::Builder::new() .spawn(|| { println!("Parking thread"); thread::park(); println!("Thread unparked"); }) .unwrap(); // Let some time pass for the thread to be spawned. thread::sleep(Duration::from_millis(10)); println!("Unpark the thread"); parked_thread.thread().unpark(); parked_thread.join().unwrap();Run
pub fn id(&self) -> ThreadId
1.19.0[src]
Gets the thread's unique identifier.
Examples
use std::thread; let other_thread = thread::spawn(|| { thread::current().id() }); let other_thread_id = other_thread.join().unwrap(); assert!(thread::current().id() != other_thread_id);Run
pub fn name(&self) -> Option<&str>
[src]
Gets the thread's name.
For more information about named threads, see this module-level documentation.
Examples
Threads by default have no name specified:
use std::thread; let builder = thread::Builder::new(); let handler = builder.spawn(|| { assert!(thread::current().name().is_none()); }).unwrap(); handler.join().unwrap();Run
Thread with a specified name:
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();Run
Trait Implementations
Auto Trait Implementations
Blanket Implementations
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
ⓘImportant traits for &'_ mut Ffn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,