Struct ScheduledTaskHandle 

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

Tracked handle for a task accepted by a scheduled executor service.

The handle delegates result and status observation to the standard TrackedTask while also waking the scheduler when pre-start cancellation wins. This prevents a cancelled timer entry from keeping the single scheduler thread asleep until the original deadline.

Implementations

impl<R, E> ScheduledTaskHandle<R, E>

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

where R: Send, E: Send,

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

Returns

The final task result.

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

where R: Send, E: Send,

Attempts to retrieve the final result without blocking.

Returns

A ready result or the pending scheduled handle.

pub fn is_done(&self) -> bool

where R: Send, E: Send,

Returns whether the tracked task has installed a terminal state.

Returns

true after the task succeeds, fails, panics, is cancelled, or loses its completion endpoint.

pub fn status(&self) -> TaskStatus

Returns the currently observed task status.

Returns

The current task status.

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 cancel(&self) -> CancelResult

Attempts to cancel this task before it starts.

Returns

The observed cancellation outcome.

Trait Implementations

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

fn into_future(self) -> Self::IntoFuture

Converts this scheduled 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 ScheduledTaskHandle<R, E>

where R: Send, E: Send,

fn is_done(&self) -> bool

Returns whether the tracked state is terminal.

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

Blocks until the underlying result handle yields a result.

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

Attempts to retrieve the underlying result without blocking.

impl<R, E> TrackedTaskHandle<R, E> for ScheduledTaskHandle<R, E>

where R: Send, E: Send,

fn status(&self) -> TaskStatus

Returns the currently observed task status.

fn cancel(&self) -> CancelResult

Attempts to publish a cancellation result while the task is pending.