Struct FutureHandle

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

A handle to a running idle future.

You can use this handle to cancel the future and to retrieve the return value of a future that has finished.

If the Handle is dropped, the future will keep on running, and there will be no way to cancel it or get the return value.

This type is notably !Send.

Implementations

impl<T> FutureHandle<T>

pub fn cancel(self) -> Option<T>

If the future has finished, it returns Some(t) the first time it is called. If it has not finished, the future is dropped and it returns None.

pub fn result(&self) -> Option<T>

If the future has finished, it returns Some(t). If it has not finished, it does nothing and return None.

pub fn has_finished(&self) -> bool

Returns true if the future has finished, false otherwise. If it returns true then you can be sure that cancel will return Some(t).

pub async fn future(self) -> T

Converts this handle into a future that is satisfied when the original job finishes. It returns the value returned by the original future.

pub fn guard(self) -> FutureHandleGuard<T>

Creates a FutureHandleGuard that cancels the future on drop.