Struct BackgroundExecutor 

pub struct BackgroundExecutor { /* private fields */ }

A pointer to the executor that is currently running, for spawning background tasks.

Implementations

impl BackgroundExecutor

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

Creates a new BackgroundExecutor from the given PlatformDispatcher.

pub fn scheduler_executor(&self) -> BackgroundExecutor

Returns the underlying scheduler::BackgroundExecutor.

This is used by Ex to pass the executor to thread/worktree code.

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

where R: Send + 'static,

Enqueues the given future to be run to completion on a background thread.

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

where R: Send + 'static,

Enqueues the given future to be run to completion on a background thread with the given priority.

When Priority::RealtimeAudio is used, the task runs on a dedicated thread with realtime scheduling priority, suitable for audio processing.

pub async fn await_on_background<R>( &self, future: impl Future<Output = R> + Send, ) -> R

where R: Send,

Enqueues the given future to be run to completion on a background thread and blocking the current task on it.

This allows to spawn background work that borrows from its scope. Note that the supplied future will run to completion before the current task is resumed, even if the current task is slated for cancellation.

pub async fn scoped<'scope, F>(&self, scheduler: F)

where F: FnOnce(&mut Scope<'scope>),

Scoped lets you start a number of tasks and waits for all of them to complete before returning.

pub async fn scoped_priority<'scope, F>(&self, priority: Priority, scheduler: F)

where F: FnOnce(&mut Scope<'scope>),

Scoped lets you start a number of tasks and waits for all of them to complete before returning.

pub fn now(&self) -> Instant

Get the current time.

Calling this instead of std::time::Instant::now allows the use of fake timers in tests.

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

Returns a task that will complete after the given duration. Depending on other concurrent tasks the elapsed duration may be longer than requested.

pub fn num_cpus(&self) -> usize

How many CPUs are available to the dispatcher.

pub fn is_main_thread(&self) -> bool

Whether we’re on the main thread.

Trait Implementations

impl Clone for BackgroundExecutor

fn clone(&self) -> BackgroundExecutor

Returns a duplicate of the value.

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

Performs copy-assignment from source.