pub struct SpawnToken<S> { /* private fields */ }
Expand description

Token to spawn a newly-created task in an executor.

When calling a task function (like #[embassy_executor::task] async fn my_task() { ... }), the returned value is a SpawnToken that represents an instance of the task, ready to spawn. You must then spawn it into an executor, typically with Spawner::spawn().

The generic parameter S determines whether the task can be spawned in executors in other threads or not. If S: Send, it can, which allows spawning it into a SendSpawner. If not, it can’t, so it can only be spawned into the current thread’s executor, with Spawner.

Panics

Dropping a SpawnToken instance panics. You may not “abort” spawning a task in this way. Once you’ve invoked a task function and obtained a SpawnToken, you must spawn it.

Implementations§

source§

impl<S> SpawnToken<S>

source

pub fn new_failed() -> Self

Return a SpawnToken that represents a failed spawn.

Trait Implementations§

source§

impl<S> Drop for SpawnToken<S>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for SpawnToken<S>

§

impl<S> !Send for SpawnToken<S>

§

impl<S> !Sync for SpawnToken<S>

§

impl<S> Unpin for SpawnToken<S>

§

impl<S> !UnwindSafe for SpawnToken<S>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere 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 Twhere 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.