Trait futures_util::task::LocalSpawnExt

pub trait LocalSpawnExt: LocalSpawn {
    // Provided method
    fn spawn_local<Fut>(&self, future: Fut) -> Result<(), SpawnError>
       where Fut: Future<Output = ()> + 'static { ... }
}

Extension trait for LocalSpawn.

Provided Methods

fn spawn_local<Fut>(&self, future: Fut) -> Result<(), SpawnError>

where Fut: Future<Output = ()> + 'static,

Spawns a task that polls the given future with output () to completion.

This method returns a Result that contains a SpawnError if spawning fails.

You can use spawn_with_handle if you want to spawn a future with output other than () or if you want to be able to await its completion.

Note this method will eventually be replaced with the upcoming Spawn::spawn method which will take a dyn Future as input. Technical limitations prevent Spawn::spawn from being implemented today. Feel free to use this method in the meantime.

use futures::executor::LocalPool;
use futures::task::LocalSpawnExt;

let executor = LocalPool::new();
let spawner = executor.spawner();

let future = async { /* ... */ };
spawner.spawn_local(future).unwrap();

Object Safety

This trait is not object safe.

Implementors

impl<Sp> LocalSpawnExt for Sp

where Sp: LocalSpawn + ?Sized,