Struct embassy_executor::SendSpawner

source ·
pub struct SendSpawner { /* private fields */ }
Expand description

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§

source§

impl SendSpawner

source

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.

source

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]).

source

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§

source§

impl Clone for SendSpawner

source§

fn clone(&self) -> SendSpawner

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Copy for SendSpawner

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.