tokio::task

Function spawn_local

Source
pub fn spawn_local<F>(future: F) -> JoinHandle<F::Output> 
where F: Future + 'static, F::Output: 'static,
Available on crate feature rt only.
Expand description

Spawns a !Send future on the current LocalSet or LocalRuntime.

The spawned future will run on the same thread that called spawn_local.

The provided future will start running in the background immediately when spawn_local is called, even if you don’t await the returned JoinHandle.

§Panics

This function panics if called outside of a LocalSet.

Note that if tokio::spawn is used from within a LocalSet, the resulting new task will not be inside the LocalSet, so you must use spawn_local if you want to stay within the LocalSet.

§Examples

use std::rc::Rc;
use tokio::task;

#[tokio::main]
async fn main() {
    let nonsend_data = Rc::new("my nonsend data...");

    let local = task::LocalSet::new();

    // Run the local task set.
    local.run_until(async move {
        let nonsend_data = nonsend_data.clone();
        task::spawn_local(async move {
            println!("{}", nonsend_data);
            // ...
        }).await.unwrap();
    }).await;
}