Struct async_executor::LocalExecutor [−][src]
pub struct LocalExecutor<'a> { /* fields omitted */ }
A thread-local executor.
The executor can only be run on the thread that created it.
Examples
use async_executor::LocalExecutor; use futures_lite::future; let local_ex = LocalExecutor::new(); future::block_on(local_ex.run(async { println!("Hello world!"); }));
Implementations
impl<'a> LocalExecutor<'a>
[src]
impl<'a> LocalExecutor<'a>
[src]pub const fn new() -> LocalExecutor<'a>
[src]
Creates a single-threaded executor.
Examples
use async_executor::LocalExecutor; let local_ex = LocalExecutor::new();
pub fn is_empty(&self) -> bool
[src]
Returns true
if there are no unfinished tasks.
Examples
use async_executor::LocalExecutor; let local_ex = LocalExecutor::new(); assert!(local_ex.is_empty()); let task = local_ex.spawn(async { println!("Hello world"); }); assert!(!local_ex.is_empty()); assert!(local_ex.try_tick()); assert!(local_ex.is_empty());
pub fn spawn<T: 'a>(&self, future: impl Future<Output = T> + 'a) -> Task<T>
[src]
Spawns a task onto the executor.
Examples
use async_executor::LocalExecutor; let local_ex = LocalExecutor::new(); let task = local_ex.spawn(async { println!("Hello world"); });
pub fn try_tick(&self) -> bool
[src]
Attempts to run a task if at least one is scheduled.
Running a scheduled task means simply polling its future once.
Examples
use async_executor::LocalExecutor; let ex = LocalExecutor::new(); assert!(!ex.try_tick()); // no tasks to run let task = ex.spawn(async { println!("Hello world"); }); assert!(ex.try_tick()); // a task was found
pub async fn tick(&self)
[src]
Runs a single task.
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 async_executor::LocalExecutor; use futures_lite::future; let ex = LocalExecutor::new(); let task = ex.spawn(async { println!("Hello world"); }); future::block_on(ex.tick()); // runs the task
pub async fn run<T>(&self, future: impl Future<Output = T>) -> T
[src]
Runs the executor until the given future completes.
Examples
use async_executor::LocalExecutor; use futures_lite::future; let local_ex = LocalExecutor::new(); let task = local_ex.spawn(async { 1 + 2 }); let res = future::block_on(local_ex.run(async { task.await * 2 })); assert_eq!(res, 6);
Trait Implementations
impl<'a> Default for LocalExecutor<'a>
[src]
impl<'a> Default for LocalExecutor<'a>
[src]