Struct crossbeam_utils::thread::ScopedJoinHandle

source ·

pub struct ScopedJoinHandle<'scope, T> {
    handle: Arc<Mutex<Option<JoinHandle<()>>>>,
    result: Arc<Mutex<Option<T>>>,
    thread: Thread,
    _marker: PhantomData<&'scope ()>,
}

Expand description

A handle that can be used to join its scoped thread.

This struct is created by the Scope::spawn method and the ScopedThreadBuilder::spawn method.

Fields§

§handle: Arc<Mutex<Option<JoinHandle<()>>>>

A join handle to the spawned thread.

§result: Arc<Mutex<Option<T>>>

Holds the result of the inner closure.

§thread: Thread

A handle to the spawned thread.

§_marker: PhantomData<&'scope ()>

Borrows the parent scope with lifetime 'scope.

Implementations§

source §

impl<T> ScopedJoinHandle<'_, T>

source

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

Waits for the thread to finish and returns its result.

If the child thread panics, an error is returned. Note that if panics are implemented by aborting the process, no error is returned; see the notes of std::panic::catch_unwind.

§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 crossbeam_utils::thread;

thread::scope(|s| {
    let handle1 = s.spawn(|_| println!("I'm a happy thread :)"));
    let handle2 = s.spawn(|_| panic!("I'm a sad thread :("));

    // Join the first thread and verify that it succeeded.
    let res = handle1.join();
    assert!(res.is_ok());

    // Join the second thread and verify that it panicked.
    let res = handle2.join();
    assert!(res.is_err());
}).unwrap();

source

pub fn thread(&self) -> &Thread

Returns a handle to the underlying thread.

§Examples

use crossbeam_utils::thread;

thread::scope(|s| {
    let handle = s.spawn(|_| println!("A child thread is running"));
    println!("The child thread ID: {:?}", handle.thread().id());
}).unwrap();