Struct SendableJoinHandle 

pub struct SendableJoinHandle<T> { /* private fields */ }

A sendable task handle returned by spawn_sendable().

The handle is Send when T is Send, but is not Sync. It may be moved and polled on another thread while the task stays on its original runtime. That runtime must keep being driven for the task to make progress.

Dropping the handle detaches the task unless cancel_on_drop is enabled. Awaiting it yields the output, or crate::JoinError if the task ends without one, including on panic or runtime shutdown.

Implementations

impl<T> SendableJoinHandle<T>

pub fn cancel_on_drop(self) -> SendableJoinHandle<T>

Requests cancellation when this handle is dropped instead of detaching the task.

Cancellation follows cancel and does not wait for cleanup. A running poll is not interrupted.

pub fn cancel(self)

Requests cancellation and discards the result without waiting for cleanup.

The future is dropped on its runtime thread when the runtime next processes the task, or during shutdown. A running poll is not interrupted. This method may be called from another thread without a runtime context.

pub fn is_finished(&self) -> bool

Returns true if the task completed or was closed without an output.

Trait Implementations

impl<T> Debug for SendableJoinHandle<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Drop for SendableJoinHandle<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T> Future for SendableJoinHandle<T>

type Output = Result<T, JoinError>

The type of value produced on completion.

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

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.