Struct Spawner

pub struct Spawner { /* private fields */ }

Handle to spawn tasks into an executor.

This Spawner can spawn any task (Send and non-Send ones), but it can only be used in the executor thread (it is not Send itself).

If you want to spawn tasks from another thread, use SendSpawner.

Implementations

impl Spawner

pub async fn for_current_executor() -> Self

Get a Spawner for the current executor.

This function is async just to get access to the current async context. It returns instantly, it does not block/yield.

Panics

Panics if the current executor is not an Embassy executor.

pub fn spawn<S>(&self, token: SpawnToken<S>) -> Result<(), SpawnError>

Spawn a task into an executor.

You obtain the token by calling a task function (i.e. one marked with #[embassy_executor::task]).

pub fn must_spawn<S>(&self, token: SpawnToken<S>)

Spawn a task into an executor, panicking on failure.

Panics

Panics if the spawning fails.

pub fn make_send(&self) -> SendSpawner

Convert this Spawner to a SendSpawner. This allows you to send the spawner to other threads, but the spawner loses the ability to spawn non-Send tasks.

Trait Implementations

impl Clone for Spawner

fn clone(&self) -> Spawner

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Spawner

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 4 bytes