pub struct LocalExecutor<'a> { /* private fields */ }
Expand description

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§

source§

impl<'a> LocalExecutor<'a>

source

pub const fn new() -> LocalExecutor<'a>

Creates a single-threaded executor.

Examples
use async_executor::LocalExecutor;

let local_ex = LocalExecutor::new();
source

pub fn is_empty(&self) -> bool

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());
source

pub fn spawn<T: 'a>(&self, future: impl Future<Output = T> + 'a) -> Task<T>

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");
});
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 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
source

pub async fn tick(&self)

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
source

pub async fn run<T>(&self, future: impl Future<Output = T>) -> T

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§

source§

impl Debug for LocalExecutor<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'a> Default for LocalExecutor<'a>

source§

fn default() -> LocalExecutor<'a>

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

impl RefUnwindSafe for LocalExecutor<'_>

source§

impl UnwindSafe for LocalExecutor<'_>

Auto Trait Implementations§

§

impl<'a> !Send for LocalExecutor<'a>

§

impl<'a> !Sync for LocalExecutor<'a>

§

impl<'a> Unpin for LocalExecutor<'a>

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.