[][src]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>[src]

pub fn forget(self)[src]

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>[src]

type Item = T

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

type Error = E

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

impl<T, E> Drop for SpawnHandle<T, E>[src]

impl<T: Debug, E: Debug> Debug for SpawnHandle<T, E>[src]

Auto Trait Implementations

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

impl<T, E> Send for SpawnHandle<T, E> where
    E: Send,
    T: Send

impl<T, E> Sync for SpawnHandle<T, E> where
    E: Send,
    T: Send

impl<T, E> !UnwindSafe for SpawnHandle<T, E>

impl<T, E> !RefUnwindSafe for SpawnHandle<T, E>

Blanket Implementations

impl<F> IntoFuture for F where
    F: Future
[src]

type Future = F

The future that this type can be converted into.

type Item = <F as Future>::Item

The item that the future may resolve with.

type Error = <F as Future>::Error

The error that the future may resolve with.

impl<T> From<T> for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]