Struct LocalDomain 

pub struct LocalDomain { /* private fields */ }

A thread-affine executor driven explicitly by the thread that creates it.

The Rc marker deliberately makes this type !Send + !Sync. In particular, a LocalExecutor runnable is never sent through the cross-thread inbox.

Implementations

impl LocalDomain

pub fn new() -> Self

Creates a new domain bound to the current host thread.

pub fn spawner(&self) -> LocalSpawner

Returns a cross-thread capability that accepts Send futures only.

pub fn spawn_local<F, T>(&self, future: F) -> Result<Task<T>, SpawnError>

where F: Future<Output = T> + 'static, T: 'static,

Spawns a future that is allowed to borrow only this local thread’s affinity.

Errors

Returns SpawnError::Closed after this domain begins shutting down.

Panics

Panics if the internal lifecycle mutex was poisoned by an earlier panic.

pub fn is_empty(&self) -> bool

Returns whether the domain currently has no accepted, queued, or runnable work.

pub fn try_tick(&self) -> bool

Processes a pending remote command or one scheduled local runnable.

pub fn run_n(&self, max_steps: usize) -> usize

Performs at most max_steps non-blocking drive steps.

Returns the number of steps that made progress. A step has the same scheduling semantics as Self::try_tick; it is not a completed-task count. Passing zero does not poll work.

pub fn run_for(&self, budget: Duration) -> RunStats

Drives ready work without blocking until the soft time budget expires.

The clock is checked before every drive step. A step may execute one inbox command and then give one local runnable an opportunity to poll. The budget check does not preempt either phase, so time spent in either may cause elapsed to exceed budget. A zero budget starts no work.

pub async fn tick(&self)

Waits until a remote command or local runnable can make progress.

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

Drives this domain until future completes.

pub async fn shutdown_graceful(self)

Rejects new work and drives accepted tasks to completion.

pub async fn shutdown_until<D>(self, deadline: D) -> ShutdownOutcome

where D: Future,

Gracefully drains until deadline resolves, then cancels remaining work.

The deadline future is supplied by the host, so this executor does not require or drive a particular timer or I/O reactor.

pub fn shutdown_now(self)

Rejects new work and drops the executor’s remaining local tasks.

Trait Implementations

impl Default for LocalDomain

fn default() -> Self

Returns the “default value” for a type.

impl Drop for LocalDomain

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.