Struct Executor

pub struct Executor { /* private fields */ }

Available on crate feature executor-thread only.

Thread mode executor for Ariel OS threads.

Implementations

impl Executor

pub fn new() -> Executor

Creates a new Executor.

This must be called from the thread that will actually poll the executor. Otherwise, the internally used thread flag will be sent to the wrong thread, causing the executor thread to never wake up.

Panics

This function panics when called without a running thread.

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

Runs 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)
• a local variable in a function you know never returns (like fn main() -> !), upgrading its lifetime with transmute. (unsafe)