Struct std::thread::ScopedJoinHandle

pub struct ScopedJoinHandle<'scope, T>(_);

🔬 This is a nightly-only experimental API. (scoped_threads #93203)

An owned permission to join on a scoped thread (block on its termination).

See Scope::spawn for details.

Implementations

impl<'scope, T> ScopedJoinHandle<'scope, T>

pub fn thread(&self) -> &Thread

🔬 This is a nightly-only experimental API. (scoped_threads #93203)

Extracts a handle to the underlying thread.

Examples

#![feature(scoped_threads)]

use std::thread;

thread::scope(|s| {
    let t = s.spawn(|| {
        println!("hello");
    });
    println!("thread id: {:?}", t.thread().id());
});

pub fn join(self) -> Result<T>

🔬 This is a nightly-only experimental API. (scoped_threads #93203)

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 panic payload.

Examples

#![feature(scoped_threads)]

use std::thread;

thread::scope(|s| {
    let t = s.spawn(|| {
        panic!("oh no");
    });
    assert!(t.join().is_err());
});

pub fn is_finished(&self) -> bool

🔬 This is a nightly-only experimental API. (thread_is_running #90470)

Checks if the associated thread has finished running its main function.

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.

This function does not block. To block while waiting on the thread to finish, use join.

Trait Implementations

impl<'scope, T> Debug for ScopedJoinHandle<'scope, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.