Skip to main content

RemoteJoinHandle

Struct RemoteJoinHandle 

Source
pub struct RemoteJoinHandle<T> { /* private fields */ }
Expand description

A native task handle returned by crate::rt::Handle::spawn().

It is neither Send nor Sync and stays on the calling thread. Submissions on the runtime thread retain the local spawn fast path. Dropping the handle detaches the task. Awaiting it yields the output or an error if the task ended without one, including when submission was rejected during shutdown.

Implementations§

Source§

impl<T> RemoteJoinHandle<T>

Source

pub fn cancel(self)

Requests cancellation and discards the result without waiting for cleanup.

An accepted future is dropped on the runtime thread, which must make progress to observe a remote cancellation request. A running poll is not interrupted.

Source

pub fn detach(self)

Detaches the task so it continues running independently.

Source

pub fn is_finished(&self) -> bool

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

Trait Implementations§

Source§

impl<T: Debug> Debug for RemoteJoinHandle<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Future for RemoteJoinHandle<T>

Source§

type Output = Result<T, JoinError>

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<T> !RefUnwindSafe for RemoteJoinHandle<T>

§

impl<T> !Send for RemoteJoinHandle<T>

§

impl<T> !Sync for RemoteJoinHandle<T>

§

impl<T> !UnwindSafe for RemoteJoinHandle<T>

§

impl<T> Freeze for RemoteJoinHandle<T>
where Inner<T>: Freeze,

§

impl<T> Unpin for RemoteJoinHandle<T>
where Inner<T>: Unpin,

§

impl<T> UnsafeUnpin for RemoteJoinHandle<T>
where Inner<T>: UnsafeUnpin,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.