Struct JobHandle 

pub struct JobHandle<T> { /* private fields */ }

Handle to the job, allowing to await for it to finish

It provides methods to block current thread to wait for job to finish. Alternatively the handle implements Future allowing it to be used in async context.

It is impossible to await this handle from multiple threads at the same time as it would require locking, hence Clone is not implemented even though under the hood it is shared pointer.

Implementations

impl<T> JobHandle<T>

pub fn is_finished(&self) -> bool

Checks if the associated job has finished running.

pub fn try_wait(&self) -> Result<Option<T>, JoinError>

Attempts to check of job is ready

pub fn wait(self) -> Result<T, JoinError>

Awaits for job to finish indefinitely.

pub fn wait_timeout(&self, timeout: Duration) -> Result<Option<T>, JoinError>

Awaits for job to finish for limited time.

Trait Implementations

impl<T> Debug for JobHandle<T>

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

Formats the value using the given formatter.

impl<T> Future for JobHandle<T>

type Output = Result<T, JoinError>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.