Executor

Struct Executor 

Source
pub struct Executor { /* private fields */ }
Available on crate feature embassy only.
Expand description

Thread-mode executor.

This executor runs in an OS thread, meaning the scheduler needs to be started before using any async operations.

Implementations§

Source§

impl Executor

Source

pub const fn new() -> Self

Create a new thread-mode executor.

Source

pub fn run(&'static mut self, init: impl FnOnce(Spawner)) -> !

Run the executor.

The init closure is called with a Spawner that spawns tasks on this executor. Use it to spawn the initial task(s). After init returns, the executor starts running the tasks.

To spawn more tasks later, you may keep copies of the Spawner (it is Copy), for example by passing it as an argument to the initial tasks.

This function requires &'static mut self. This means you have to store the Executor instance in a place where it’ll live forever and grants you mutable access. There’s a few ways to do this:

  • a StaticCell (safe)
  • a static mut (unsafe, not recommended)
  • a local variable in a function you know never returns (like fn main() -> !), upgrading its lifetime with transmute. (unsafe)

This function never returns.

Source

pub fn run_with_callbacks( &'static mut self, init: impl FnOnce(Spawner), callbacks: impl Callbacks, ) -> !

Run the executor with callbacks.

See Callbacks on when the callbacks are called.

See Self::run for more information about running the executor.

This function never returns.

Trait Implementations§

Source§

impl Default for Executor

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl !Freeze for Executor

§

impl !RefUnwindSafe for Executor

§

impl !Send for Executor

§

impl !Sync for Executor

§

impl Unpin for Executor

§

impl !UnwindSafe for Executor

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

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> Same for T

Source§

type Output = T

Should always be Self
§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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.
§

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

Performs the conversion.