Struct Handle 

pub struct Handle { /* private fields */ }

A handle to a tokio runtime that provides task spawning and execution capabilities.

This wrapper around tokio’s Handle maintains a weak reference to the parent runtime to enable proper I/O and timer driver access, particularly for signal handling.

Implementations

impl Handle

pub fn block_on<F>(&self, future: F) -> <F as Future>::Output

where F: Future,

Blocks on a future using the parent Runtime instead of Handle.

This ensures proper I/O and timer driver access for signal handling. If the runtime has been dropped, falls back to the inner handle’s block_on.

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

where T: Send + 'static,

Spawns a future onto the runtime.

Returns a JoinHandle that can be awaited to get the future’s result.

pub fn spawn_with_name<T>( &self, name: &str, future: impl Future<Output = T> + Send + 'static, ) -> JoinHandle<T>

where T: Send + 'static,

Spawns a named future onto the runtime.

The name is used for logging when trace-level logging is enabled.

pub fn spawn_blocking<T>( &self, f: impl FnOnce() -> T + Send + 'static, ) -> JoinHandle<T>

where T: Send + 'static,

Spawns a blocking task onto the runtime.

Returns a JoinHandle that can be awaited to get the task’s result.

pub fn spawn_blocking_with_name<T>( &self, name: &str, f: impl FnOnce() -> T + Send + 'static, ) -> JoinHandle<T>

where T: Send + 'static,

Spawns a named blocking task onto the runtime.

The name is used for logging when trace-level logging is enabled.

pub fn spawn_local<T>( &self, future: impl Future<Output = T> + 'static, ) -> JoinHandle<T>

where T: 'static,

Spawns a non-Send future onto the current thread.

This allows spawning futures that are not Send, which must run on the current thread. Returns a JoinHandle that can be awaited to get the future’s result.

pub fn spawn_local_with_name<T>( &self, name: &str, future: impl Future<Output = T> + 'static, ) -> JoinHandle<T>

where T: 'static,

Spawns a named non-Send future onto the current thread.

The name is used for logging when trace-level logging is enabled.

pub fn current() -> Handle

Returns a handle to the currently running runtime.

Panics

Panics if no runtime is currently running on this thread.

pub fn try_current() -> Result<Handle, TryCurrentError>

Try to get the current runtime handle

Errors

• If no runtime is currently running on this thread

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Handle

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.