Struct std::thread::JoinHandle

1.0.0 · source ·
pub struct JoinHandle<T>(_);
Expand description

拥有加入线程的权限 (在线程终止时阻止)。

JoinHandle 被丢弃时,它会分离关联的线程,这意味着不再有线程的任何句柄,也无法在其上使用 join

由于平台的限制,无法使用 Clone 此句柄:加入线程的能力是唯一拥有的权限。

structthread::spawn 函数和 thread::Builder::spawn 方法创建。

Examples

thread::spawn 创建:

use std::thread;

let join_handle: thread::JoinHandle<_> = thread::spawn(|| {
    // 这里一些工作
});
Run

thread::Builder::spawn 创建:

use std::thread;

let builder = thread::Builder::new();

let join_handle: thread::JoinHandle<_> = builder.spawn(|| {
    // 这里一些工作
}).unwrap();
Run

一个线程被分离并且比产生它的线程生命周期更长:

use std::thread;
use std::time::Duration;

let original_thread = thread::spawn(|| {
    let _detached_thread = thread::spawn(|| {
        // 在这里我们睡觉以确保第一个线程在此之前返回。
        thread::sleep(Duration::from_millis(10));
        // 即使 JoinHandle 被丢弃,也将调用它。
        println!("♫ Still alive ♫");
    });
});

original_thread.join().expect("The thread being joined has panicked");
println!("Original thread is joined.");

// 我们确保在主线程返回之前,新线程有时间运行。

thread::sleep(Duration::from_millis(1000));
Run

Implementations§

source§

impl<T> JoinHandle<T>

source

pub fn thread(&self) -> &Thread

提取底层线程的句柄。

Examples
use std::thread;

let builder = thread::Builder::new();

let join_handle: thread::JoinHandle<_> = builder.spawn(|| {
    // 这里一些工作
}).unwrap();

let thread = join_handle.thread();
println!("thread id: {:?}", thread.id());
Run
source

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

等待关联的线程完成。

如果关联的线程已经完成,这个函数将立即返回。

原子内存排序 而言,关联线程的完成与此函数返回同步。 换句话说,该线程 之前发生过 执行的所有操作都是在 join 返回之后发生的所有操作。

如果关联的线程 panics,则返回 Err,并返回给 panic! 的参数。

Panics

如果某个线程尝试加入自身,则该函数在某些平台上可能为 panic,否则可能会在加入线程时产生死锁。

Examples
use std::thread;

let builder = thread::Builder::new();

let join_handle: thread::JoinHandle<_> = builder.spawn(|| {
    // 这里一些工作
}).unwrap();
join_handle.join().expect("Couldn't join on the associated thread");
Run
1.61.0 · source

pub fn is_finished(&self) -> bool

检查关联线程是否已完成其 main 函数的运行。

is_finished 支持实现非阻塞连接操作,通过检查 is_finished,如果返回 true 则调用 join。 该函数不会阻止。 要在等待线程完成时阻塞,请使用 join

这可能在线程的 main 函数返回之后,但在线程本身停止运行之前短暂返回 true。 但是,一旦返回 true,可以预期 join 会快速返回,而不会被阻塞很长时间。

Trait Implementations§

1.63.0 · source§

impl<T> AsHandle for JoinHandle<T>

Available on Windows only.
source§

fn as_handle(&self) -> BorrowedHandle<'_>

借用句柄。 Read more
1.9.0 · source§

impl<T> AsRawHandle for JoinHandle<T>

Available on Windows only.
source§

fn as_raw_handle(&self) -> RawHandle

提取原始句柄。 Read more
1.16.0 · source§

impl<T> Debug for JoinHandle<T>

source§

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

使用给定的格式化程序格式化该值。 Read more
1.63.0 · source§

impl<T> From<JoinHandle<T>> for OwnedHandle

Available on Windows only.
source§

fn from(join_handle: JoinHandle<T>) -> OwnedHandle

从输入类型转换为此类型。
1.9.0 · source§

impl<T> IntoRawHandle for JoinHandle<T>

Available on Windows only.
source§

fn into_raw_handle(self) -> RawHandle

消耗此对象,返回原始底层句柄。 Read more
1.9.0 · source§

impl<T> JoinHandleExt for JoinHandle<T>

Available on Unix only.
source§

fn as_pthread_t(&self) -> RawPthread

提取原始 pthread_t 而不拥有所有权
source§

fn into_pthread_t(self) -> RawPthread

消耗线程,返回原始 pthread_t Read more
1.29.0 · source§

impl<T> Send for JoinHandle<T>

1.29.0 · source§

impl<T> Sync for JoinHandle<T>

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for JoinHandle<T>

§

impl<T> Unpin for JoinHandle<T>

§

impl<T> !UnwindSafe for JoinHandle<T>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

获取 selfTypeIdRead more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

从拥有的值中一成不变地借用。 Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

从拥有的值中借用。 Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

返回未更改的参数。

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

调用 U::from(self)

也就是说,这种转换是 From<T> for U 实现选择执行的任何操作。

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

发生转换错误时返回的类型。
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

执行转换。
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

发生转换错误时返回的类型。
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

执行转换。