Struct embassy_executor::SendSpawner

pub struct SendSpawner { /* private fields */ }

Handle to spawn tasks into an executor from any thread.

This Spawner can be used from any thread (it is Send), but it can only spawn Send tasks. The reason for this is spawning is effectively “sending” the tasks to the executor thread.

If you want to spawn non-Send tasks, use Spawner.

Implementations

impl SendSpawner

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: Send>(&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: Send>(&self, token: SpawnToken<S>)

Spawn a task into an executor, panicking on failure.

Panics

Panics if the spawning fails.

Trait Implementations

impl Clone for SendSpawner

fn clone(&self) -> SendSpawner

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SendSpawner

impl Send for SendSpawner

impl Sync for SendSpawner