TaskJoiner

Struct TaskJoiner 

Source
pub struct TaskJoiner<'a, T> { /* private fields */ }
Expand description

A handle to a running task.

You can call TaskJoiner::join from a synchronous context to block execution and yield the future’s value. If you want to wait for execution to finish from an asynchronous context, use .await on the joiner. If the joiner is dropped then execution of the future continues to completion but the return value is lost, aka detatch-on-drop.

Implementations§

Source§

impl<'a, T> TaskJoiner<'a, T>

Source

pub fn join(self) -> T

Block execution and wait for a task to finish executing. The return value T is the value yielded by the task’s future.

Note This function should only be called from synchronous contexts. To prevent deadlocks in an asynchronous context, use .await instead.

Trait Implementations§

Source§

impl<'a, T> Future for TaskJoiner<'a, T>

Source§

type Output = T

The type of value produced on completion.
Source§

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. Read more

Auto Trait Implementations§

§

impl<'a, T> Freeze for TaskJoiner<'a, T>

§

impl<'a, T> !RefUnwindSafe for TaskJoiner<'a, T>

§

impl<'a, T> !Send for TaskJoiner<'a, T>

§

impl<'a, T> !Sync for TaskJoiner<'a, T>

§

impl<'a, T> Unpin for TaskJoiner<'a, T>

§

impl<'a, T> !UnwindSafe for TaskJoiner<'a, T>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<F> IntoFuture for F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

type IntoFuture = F

Which kind of future are we turning this into?
Source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<F, T, E> TryFuture for F
where F: Future<Output = Result<T, E>> + ?Sized,

Source§

type Ok = T

The type of successful values yielded by this future
Source§

type Error = E

The type of failures yielded by this future
Source§

fn try_poll( self: Pin<&mut F>, cx: &mut Context<'_>, ) -> Poll<<F as Future>::Output>

Poll this TryFuture as if it were a Future. Read more
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.