Struct std::thread::JoinHandle
1.0.0 · source · pub struct JoinHandle<T>(/* private fields */);
Expand description
An owned permission to join on a thread (block on its termination).
A JoinHandle
detaches the associated thread when it is dropped, which
means that there is no longer any handle to the thread and no way to join
on it.
Due to platform restrictions, it is not possible to Clone
this
handle: the ability to join a thread is a uniquely-owned permission.
This struct
is created by the thread::spawn
function and the
thread::Builder::spawn
method.
§Examples
Creation from thread::spawn
:
use std::thread;
let join_handle: thread::JoinHandle<_> = thread::spawn(|| {
// some work here
});
RunCreation from thread::Builder::spawn
:
use std::thread;
let builder = thread::Builder::new();
let join_handle: thread::JoinHandle<_> = builder.spawn(|| {
// some work here
}).unwrap();
RunA thread being detached and outliving the thread that spawned it:
use std::thread;
use std::time::Duration;
let original_thread = thread::spawn(|| {
let _detached_thread = thread::spawn(|| {
// Here we sleep to make sure that the first thread returns before.
thread::sleep(Duration::from_millis(10));
// This will be called, even though the JoinHandle is dropped.
println!("♫ Still alive ♫");
});
});
original_thread.join().expect("The thread being joined has panicked");
println!("Original thread is joined.");
// We make sure that the new thread has time to run, before the main
// thread returns.
thread::sleep(Duration::from_millis(1000));
RunImplementations§
source§impl<T> JoinHandle<T>
impl<T> JoinHandle<T>
sourcepub fn join(self) -> Result<T>
pub fn join(self) -> Result<T>
Waits for the associated thread to finish.
This function will return immediately if the associated thread has already finished.
In terms of atomic memory orderings, the completion of the associated
thread synchronizes with this function returning. In other words, all
operations performed by that thread happen
before all
operations that happen after join
returns.
If the associated thread panics, Err
is returned with the parameter given
to panic!
.
§Panics
This function may panic on some platforms if a thread attempts to join itself or otherwise may create a deadlock with joining threads.
§Examples
use std::thread;
let builder = thread::Builder::new();
let join_handle: thread::JoinHandle<_> = builder.spawn(|| {
// some work here
}).unwrap();
join_handle.join().expect("Couldn't join on the associated thread");
Run1.61.0 · sourcepub fn is_finished(&self) -> bool
pub fn is_finished(&self) -> bool
Checks if the associated thread has finished running its main function.
is_finished
supports implementing a non-blocking join operation, by checking
is_finished
, and calling join
if it returns true
. This function does not block. To
block while waiting on the thread to finish, use join
.
This might return true
for a brief moment after the thread’s main
function has returned, but before the thread itself has stopped running.
However, once this returns true
, join
can be expected
to return quickly, without blocking for any significant amount of time.