std::task::Spawn - Rust
Description: API documentation for the Rust `Spawn` trait in crate `std`.
Keywords: rust, rustlang, rust-lang, Spawn

# [−][src]Trait std::task::Spawn

    pub trait Spawn {
        fn spawn_obj(
            &mut self,
            future: FutureObj<'static, ()>
        ) -> Result<(), SpawnObjError>;

        fn status(&self) -> Result<(), SpawnErrorKind> { ... }
    }

🔬 This is a nightly-only experimental API. (`futures_api` #50547)

futures in libcore are unstable

Spawns tasks that poll futures to completion onto its associated task executor.

The term "task" refers to a kind of lightweight "thread". Task executors are responsible for scheduling the execution of tasks on operating system threads.

## Required Methods

### `fn spawn_obj(
&mut self,
future: FutureObj<'static, ()>
) -> Result<(), SpawnObjError>`

🔬 This is a nightly-only experimental API. (`futures_api` #50547)

futures in libcore are unstable

Spawns a new task with the given future. The future will be polled until completion.

# Errors

The executor may be unable to spawn tasks, either because it has been shut down or is resource-constrained.

## Provided Methods

### `fn status(&self) -> Result<(), SpawnErrorKind>`

🔬 This is a nightly-only experimental API. (`futures_api` #50547)

futures in libcore are unstable

Determines whether the executor is able to spawn new tasks.

# Returns

An `Ok` return means the executor is likely (but not guaranteed) to accept a subsequent spawn attempt. Likewise, an `Err` return means that `spawn` is likely, but not guaranteed, to yield an error.

## Implementors

###

`impl<Sp> Spawn for Box<Sp> where Sp: Spawn + ?Sized,`

[src]

####

`fn spawn_obj( &mut self, future: FutureObj<'static, ()> ) -> Result<(), SpawnObjError>`

[src]

🔬 This is a nightly-only experimental API. (`futures_api` #50547)

futures in libcore are unstable

####

`fn status(&self) -> Result<(), SpawnErrorKind>`

[src]

🔬 This is a nightly-only experimental API. (`futures_api` #50547)

futures in libcore are unstable

# 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`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)