Struct TaskHandle 

pub struct TaskHandle<R, E> { /* private fields */ }

Lightweight result handle for a submitted callable task.

TaskHandle owns the receiving endpoint for exactly one task result. It can block through Self::get, poll non-blockingly through Self::try_get, or be awaited by value.

Implementations

impl<R, E> TaskHandle<R, E>

pub fn task_id(&self) -> TaskId

Returns the identifier assigned to this task.

Returns

The task id stored in the shared task state.

pub fn get(self) -> TaskResult<R, E>

Waits for the task to finish and returns its final result.

This method blocks the current thread until a result is available.

Returns

Ok(R) if the task succeeds. If the accepted task returns Err(E), panics, is cancelled, or loses its completion endpoint before producing a value, the corresponding crate::TaskExecutionError is returned.

pub fn try_get(self) -> TryGet<Self, R, E>

Attempts to retrieve the final result without blocking.

Returns

TryGet::Ready with the final result when available, otherwise TryGet::Pending containing this handle.

pub fn is_done(&self) -> bool

Returns whether the task has installed a terminal state.

Returns

true after the task succeeds, fails, panics, is cancelled, or loses its completion endpoint. The final result send may still be racing with this status observation.

Trait Implementations

impl<R, E> IntoFuture for TaskHandle<R, E>

fn into_future(self) -> Self::IntoFuture

Converts this handle into a future resolving to the task result.

type Output = Result<R, TaskExecutionError<E>>

The output that the future will produce on completion.

type IntoFuture = TaskHandleFuture<R, E>

Which kind of future are we turning this into?

impl<R, E> TaskResultHandle<R, E> for TaskHandle<R, E>

where R: Send, E: Send,

fn is_done(&self) -> bool

Returns whether the tracked task state is terminal.

fn get(self) -> TaskResult<R, E>

Blocks until the result channel yields a task result.

fn try_get(self) -> TryGet<Self, R, E>

Attempts to read the result channel without blocking.