Struct LocalExecutor

Source

pub struct LocalExecutor<'a, const C: usize = 64> { /* private fields */ }

Expand description

A thread-local executor.

The executor can only be run on the thread that created it.

§Examples

use edge_executor::{LocalExecutor, block_on};

let local_ex: LocalExecutor = Default::default();

block_on(local_ex.run(async {
    println!("Hello world!");
}));

Implementations§

Source §

impl<'a, const C: usize> LocalExecutor<'a, C>

Source

pub const fn new() -> Self

Creates a single-threaded executor.

§Examples

use edge_executor::LocalExecutor;

let local_ex: LocalExecutor = Default::default();

Source

pub fn spawn<F>(&self, fut: F) -> Task<F::Output> ⓘ
where F: Future + 'a, F::Output: 'a,

Spawns a task onto the executor.

§Examples

use edge_executor::LocalExecutor;

let local_ex: LocalExecutor = Default::default();

let task = local_ex.spawn(async {
    println!("Hello world");
});

Note that if the executor’s queue size is equal to the number of currently spawned and running tasks, spawning this additional task might cause the executor to panic later, when the task is scheduled for polling.

Source

pub fn try_tick(&self) -> bool

Attempts to run a task if at least one is scheduled.

Running a scheduled task means simply polling its future once.

§Examples

use edge_executor::LocalExecutor;

let local_ex: LocalExecutor = Default::default();
assert!(!local_ex.try_tick()); // no tasks to run

let task = local_ex.spawn(async {
    println!("Hello world");
});
assert!(local_ex.try_tick()); // a task was found

Source

pub async fn tick(&self)

Runs a single task asynchronously.

Running a task means simply polling its future once.

If no tasks are scheduled when this method is called, it will wait until one is scheduled.

§Examples

use edge_executor::{LocalExecutor, block_on};

let local_ex: LocalExecutor = Default::default();

let task = local_ex.spawn(async {
    println!("Hello world");
});
block_on(local_ex.tick()); // runs the task

Source

pub async fn run<F>(&self, fut: F) -> F::Output
where F: Future,

Runs the executor asynchronously until the given future completes.

§Examples

use edge_executor::{LocalExecutor, block_on};

let local_ex: LocalExecutor = Default::default();

let task = local_ex.spawn(async { 1 + 2 });
let res = block_on(local_ex.run(async { task.await * 2 }));

assert_eq!(res, 6);