Struct RuntimeHandle 

pub struct RuntimeHandle { /* private fields */ }

Handle for spawning tasks onto a runtime from outside async context.

Cheap to clone (shared handle backing). Use Runtime::handle to obtain one.

let runtime = RuntimeBuilder::new().build()?;
let handle = runtime.handle();

// Spawn from any thread.
let join = handle.spawn(async { compute_result().await });
let result = runtime.block_on(join);

Implementations

impl RuntimeHandle

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

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

Spawn a task from outside async context.

Panics if the runtime is no longer available or if the root region rejects admission. Use RuntimeHandle::try_spawn to handle those failures explicitly.

pub fn try_spawn<F>( &self, future: F, ) -> Result<JoinHandle<F::Output>, SpawnError>

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

Spawn a task from outside async context, returning runtime-availability or admission errors instead of panicking.

pub fn spawn_with_cx<F, Fut>(&self, f: F)

where F: FnOnce(Cx) -> Fut + Send + 'static, Fut: Future<Output = ()> + Send + 'static,

Spawn a task with a Cx from outside async context.

Creates a child Cx in the runtime’s root region and passes it to the factory closure. The Cx participates in structured cancellation: it will observe cancellation when the runtime shuts down.

Panics if the runtime is no longer available or if the root region rejects admission. Use RuntimeHandle::try_spawn_with_cx to handle those failures explicitly.

Example

let handle = runtime.handle();
handle.spawn_with_cx(|cx| async move {
    while !cx.is_cancel_requested() {
        // do work
    }
});

pub fn try_spawn_with_cx<F, Fut>(&self, f: F) -> Result<(), SpawnError>

where F: FnOnce(Cx) -> Fut + Send + 'static, Fut: Future<Output = ()> + Send + 'static,

Spawn a task with a Cx from outside async context, returning runtime-availability or admission errors instead of panicking.

Creates a child Cx in the runtime’s root region and passes it to the factory closure. The Cx participates in structured cancellation: it will observe cancellation when the runtime shuts down.

Example

let handle = runtime.handle();
handle.try_spawn_with_cx(|cx| async move {
    while !cx.is_cancel_requested() {
        // do work
    }
})?;

pub fn spawn_blocking<F>(&self, f: F) -> Option<BlockingTaskHandle>

where F: FnOnce() + Send + 'static,

Spawns a blocking task on the blocking pool.

Returns None if the blocking pool is not configured or if this handle is a stale weak handle whose runtime has already been dropped.

pub fn spawn_blocking_on_cohort<F>( &self, cohort: usize, f: F, ) -> Option<BlockingTaskHandle>

where F: FnOnce() + Send + 'static,

Spawns a blocking task with an explicit preferred cohort hint.

Returns None if the blocking pool is not configured or if this handle is stale.

pub fn blocking_handle(&self) -> Option<BlockingPoolHandle>

Returns a handle to the blocking pool, if configured and the runtime is still alive.

Trait Implementations

impl Clone for RuntimeHandle

fn clone(&self) -> RuntimeHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.