Struct JoinHandle

pub struct JoinHandle<F: Future> { /* private fields */ }

A potentially running Work.

This encapsulates a Future that is potentially running in the Zephyr work queue system.

Safety

Once the worker has been started (meaning once WorkBuilder::start returns this Work), all but one field here is owned by the worker itself (it runs on the worker thread, hence the Send constraint). The exception is the ‘answer’ field which can be used by the caller to wait for the Work to finish.

Implementations

impl<F: Future> JoinHandle<F>

pub fn join(&self) -> F::Output

Synchronously wait for this future to have an answer.

pub async fn join_async(&self) -> F::Output

Asynchronously wait for this future to have an answer.

Trait Implementations

impl<F> Send for JoinHandle<F>

where F: Future, F::Output: Send,