Struct muse_reactor::TaskHandle

pub struct TaskHandle { /* private fields */ }

A handle to a task spawned in a reactor.

Implementations

impl TaskHandle

pub fn join(&self) -> Result<RootedValue, TaskError>

Blocks the current thread until the task is finished.

This function is not safe to execute from async code. TaskHandle implements Future and can be awaited.

pub fn try_join(&self) -> Option<Result<RootedValue, TaskError>>

Checks if the task has executed, returning the result if it has.

This function returns None if the task is pending execution or still executing.

This function is safe to call from both async and non-async code.

pub fn join_until( &self, deadline: Instant, ) -> Option<Result<RootedValue, TaskError>>

Blocks the current thread until the task is finished or deadline has passed.

This function is not safe to execute from async code. TaskHandle implements Future and can be awaited, and the future can be cancelled using the async runtime’s timeout functionality.

pub fn join_for( &self, duration: Duration, ) -> Option<Result<RootedValue, TaskError>>

Blocks the current thread until the task is finished or duration has elapsed.

This function is not safe to execute from async code. TaskHandle implements Future and can be awaited, and the future can be cancelled using the async runtime’s timeout functionality.

pub fn cancel(&self)

Cancels the task if it is still running.

Joining the task will return TaskError::Cancelled if the task was successfully cancelled.

Trait Implementations

impl CustomType for TaskHandle

fn muse_type(&self) -> &TypeRef

Returns the Muse type for this Rust type.

impl Debug for TaskHandle

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

Formats the value using the given formatter.

impl Future for &TaskHandle

type Output = Result<RootedValue, TaskError>

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.

impl Trace for TaskHandle

const MAY_CONTAIN_REFERENCES: bool = false

If true, this type may contain references and should have its trace() function invoked during the collector’s “mark” phase.

fn trace(&self, tracer: &mut Tracer<'_>)

Traces all refrences that this value references.