Struct futures::sync::oneshot::SpawnHandle

pub struct SpawnHandle<T, E> { /* fields omitted */ }

Handle returned from the spawn function.

This handle is a future representing the completion of a different future on a separate executor. Created through the oneshot::spawn function this handle will resolve when the future provided to spawn resolves on the Executor instance provided to that function.

If this handle is dropped then the future will automatically no longer be polled and is scheduled to be dropped. This can be canceled with the forget function, however.

Methods

impl<T, E> SpawnHandle<T, E>

pub fn forget(self)

Drop this future without canceling the underlying future.

When SpawnHandle is dropped, the spawned future will be canceled as well if the future hasn't already resolved. This function can be used when to drop this future but keep executing the underlying future.

Trait Implementations

impl<T, E> Future for SpawnHandle<T, E>

type Item = T

The type of value that this future will resolved with if it is successful.

type Error = E

The type of error that this future will resolve with if it fails in a normal fashion.

fn poll(&mut self) -> Poll<T, E>

Query this future to see if its value has become available, registering interest if it is not.

fn wait(self) -> Result<Self::Item, Self::Error> where
    Self: Sized, 

Block the current thread until this future is resolved.

fn map<F, U>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Item) -> U,
    Self: Sized, 

Map this future's result to a different type, returning a new future of the resulting type.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E,
    Self: Sized, 

Map this future's error to a different error, returning a new future.

fn from_err<E: From<Self::Error>>(self) -> FromErr<Self, E> where
    Self: Sized, 

Map this future's error to any error implementing From for this future's Error, returning a new future.

fn then<F, B>(self, f: F) -> Then<Self, B, F> where
    F: FnOnce(Result<Self::Item, Self::Error>) -> B,
    B: IntoFuture,
    Self: Sized, 

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where
    F: FnOnce(Self::Item) -> B,
    B: IntoFuture<Error = Self::Error>,
    Self: Sized, 

Execute another future after this one has resolved successfully.

fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where
    F: FnOnce(Self::Error) -> B,
    B: IntoFuture<Item = Self::Item>,
    Self: Sized, 

Execute another future if this one resolves with an error.

fn select<B>(self, other: B) -> Select<Self, B::Future> where
    B: IntoFuture<Item = Self::Item, Error = Self::Error>,
    Self: Sized, 

Waits for either one of two futures to complete.

fn select2<B>(self, other: B) -> Select2<Self, B::Future> where
    B: IntoFuture,
    Self: Sized, 

Waits for either one of two differently-typed futures to complete.

fn join<B>(self, other: B) -> Join<Self, B::Future> where
    B: IntoFuture<Error = Self::Error>,
    Self: Sized, 

Joins the result of two futures, waiting for them both to complete.

fn join3<B, C>(self, b: B, c: C) -> Join3<Self, B::Future, C::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    Self: Sized, 

Same as join, but with more futures.

fn join4<B, C, D>(
    self,
    b: B,
    c: C,
    d: D
) -> Join4<Self, B::Future, C::Future, D::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    Self: Sized, 

Same as join, but with more futures.

fn join5<B, C, D, E>(
    self,
    b: B,
    c: C,
    d: D,
    e: E
) -> Join5<Self, B::Future, C::Future, D::Future, E::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    E: IntoFuture<Error = Self::Error>,
    Self: Sized, 

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self> where
    Self: Sized, 

Convert this future into a single element stream.

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error: From<Self::Error>,
    Self: Sized, 

Flatten the execution of this future when the successful result of this future is itself another future.

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Item: Stream<Error = Self::Error>,
    Self: Sized, 

Flatten the execution of this future when the successful result of this future is a stream.

fn fuse(self) -> Fuse<Self> where
    Self: Sized, 

Fuse a future such that poll will never again be called once it has completed.

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Item),
    Self: Sized, 

Do something with the item of a future, passing it on.

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: Sized + UnwindSafe, 

Catches unwinding panics while polling the future.

fn shared(self) -> Shared<Self> where
    Self: Sized, 

Create a cloneable handle to this future where all handles will resolve to the same result.

impl<T: Debug, E: Debug> Debug for SpawnHandle<T, E>

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

Formats the value using the given formatter.

impl<T, E> Drop for SpawnHandle<T, E>

fn drop(&mut self)

Executes the destructor for this type.