Struct BackgroundExecutor 

pub struct BackgroundExecutor { /* private fields */ }

An executor that runs Send futures on the background thread pool.

Applications get one from background_executor on their context. Cloning is cheap, and every clone shares the same scheduler.

Implementations

impl BackgroundExecutor

pub fn new(scheduler: Arc<dyn Scheduler>) -> Self

Creates a background executor that spawns onto scheduler.

pub fn spawn<F>(&self, future: F) -> Task<F::Output>

where F: Future + Send + 'static, F::Output: Send + 'static,

Spawns a future on the background thread pool with the default priority.

The future may run on any background thread, so it must be Send. Dropping the returned Task cancels the future. Call Task::detach to let it finish on its own. Use LocalExecutor::spawn for futures that aren’t Send or that need to stay on the main thread.

pub fn spawn_with_priority<F>( &self, priority: Priority, future: F, ) -> Task<F::Output>

where F: Future + Send + 'static, F::Output: Send + 'static,

Spawns a future on the background thread pool at priority.

Like Self::spawn, but the scheduler uses priority to order this future against other background work waiting to run.

pub fn spawn_realtime<F>(&self, future: F) -> Task<F::Output>

where F: Future + Send + 'static, F::Output: Send + 'static,

Spawns a future on the platform’s realtime thread, for latency-sensitive work such as audio processing.

The future must be Send. Use Self::spawn for everything else.

pub fn timer(&self, duration: Duration) -> Timer

Returns a Timer that completes after duration.

pub fn now(&self) -> Instant

Returns the current time from this scheduler’s clock.

Under the test scheduler this is the simulated clock, which moves only when the test advances it.

pub fn scheduler(&self) -> &Arc<dyn Scheduler>

Returns the scheduler that this executor spawns onto.

pub fn is_test(&self) -> bool

Whether this executor runs on a TestScheduler.

pub fn spawn_dedicated<F, Fut>(&self, f: F) -> Task<Fut::Output>

where F: FnOnce(LocalExecutor) -> Fut + Send + 'static, Fut: Future + 'static, Fut::Output: Send + Sync + 'static,

Spawns a closure on a new session that has its own LocalExecutor.

The closure runs on a new OS thread under the platform scheduler, or on the test scheduler’s loop under TestScheduler. Its future can use the executor it receives to spawn more work on that thread.

The returned task is the closure’s work. Dropping it cancels the work, awaiting it yields the closure’s return value, and Task::detach lets the work run on after the caller is done with it.

Trait Implementations

impl Clone for BackgroundExecutor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.