# Struct futures::sync::oneshot::SpawnHandle [−] [src]

    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

#### `fn poll(&mut self) -> Poll<T, E>`
[src]

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

#### `fn wait(self) -> Result<Self::Item, Self::Error> where
Self: Sized,`
[src]

Block the current thread until this future is resolved. Read more

#### `fn map<F, U>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Item) -> U,
Self: Sized,`
[src]

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

#### `fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
Self: Sized,`
[src]

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

#### `fn from_err<E: From<Self::Error>>(self) -> FromErr<Self, E> where
Self: Sized,`
[src]

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

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

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

#### `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,`
[src]

Execute another future after this one has resolved successfully. Read more

#### `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,`
[src]

Execute another future if this one resolves with an error. Read more

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

Waits for either one of two futures to complete. Read more

#### `fn select2<B>(self, other: B) -> Select2<Self, B::Future> where
B: IntoFuture,
Self: Sized,`
[src]

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

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

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

#### `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,`
[src]

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

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

Same as `join`, but with more futures.

#### `fn into_stream(self) -> IntoStream<Self> where
Self: Sized,`
[src]

Convert this future into a single element stream. Read more

#### `fn flatten(self) -> Flatten<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error: From<Self::Error>,
Self: Sized,`
[src]

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

#### `fn flatten_stream(self) -> FlattenStream<Self> where
Self::Item: Stream<Error = Self::Error>,
Self: Sized,`
[src]

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

#### `fn fuse(self) -> Fuse<Self> where
Self: Sized,`
[src]

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

#### `fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Item),
Self: Sized,`
[src]

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

#### `fn catch_unwind(self) -> CatchUnwind<Self> where
Self: Sized + UnwindSafe,`
[src]

Catches unwinding panics while polling the future. Read more

#### `fn shared(self) -> Shared<Self> where
Self: Sized,`
[src]

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

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

#### `fn fmt(&self, f: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. Read more

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

#### `fn drop(&mut self)`
[src]

Executes the destructor for this type. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)