Struct ForegroundExecutor 

pub struct ForegroundExecutor { /* private fields */ }

A pointer to the executor that is currently running, for spawning tasks on the main thread.

Implementations

impl ForegroundExecutor

pub fn new(dispatcher: Arc<dyn PlatformDispatcher>) -> Self

Creates a new ForegroundExecutor from the given PlatformDispatcher.

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

where R: 'static,

Enqueues the given Task to run on the main thread.

pub fn spawn_with_priority<R>( &self, _priority: Priority, future: impl Future<Output = R> + 'static, ) -> Task<R>

where R: 'static,

Enqueues the given Task to run on the main thread with the given priority.

pub fn spawn_when_idle<R>( &self, timeout: Option<Duration>, future: impl Future<Output = R> + 'static, ) -> Task<R>

where R: 'static,

On platforms with dedicated support, enqueues the given future to run on the main thread during platform idle time. Without a timeout, polls may be deferred indefinitely while the platform stays busy; with one, a poll still waiting after that long runs as ordinary main-thread work. Each poll occupies part of one idle slice, so long synchronous stretches should bound themselves against Self::idle_time_remaining and yield.

On platforms without dedicated support, schedules the given future to run with a low priority, ignoring timeout.

pub fn idle_time_remaining(&self) -> Option<Duration>

The time remaining in the current idle slice, when called from a task spawned via Self::spawn_when_idle on a platform that meters idle time. None when idle time is unmetered (or the caller is not inside an idle slice); work that must bound itself should then fall back to a budget of its own.

pub fn block_on<R>(&self, future: impl Future<Output = R>) -> R

Block the current thread until the given future resolves. Consider using block_with_timeout instead.

pub fn block_with_timeout<R, Fut: Future<Output = R>>( &self, duration: Duration, future: Fut, ) -> Result<R, impl Future<Output = R> + use<R, Fut>>

Block the current thread until the given future resolves or the timeout elapses.

Trait Implementations

impl Clone for ForegroundExecutor

fn clone(&self) -> ForegroundExecutor

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.