Struct Handle

pub struct Handle { /* private fields */ }

Handle to the runtime.

Implementations

impl Handle

pub fn new(inner: TokioHandle, guard: Option<Sender<()>>) -> Self

Create a new Handle

pub fn drop_guard(&mut self)

Drop the guard

impl Handle

pub fn enter<F, R>(&self, f: F) -> R

where F: FnOnce() -> R,

Enter the runtime context. This allows you to construct types that must have an executor available on creation such as [tokio::time::Sleep] or [tokio::net::TcpStream]. It will also allow you to call methods such as tokio::spawn.

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

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

Spawns a future onto the runtime.

This spawns the given future onto the runtime’s executor

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

Run a future to completion on the Tokio runtime from a synchronous context.

pub fn spawn_blocking<F, R>(&self, f: F) -> JoinHandle<R>

where F: FnOnce() -> R + Send + 'static, R: Send + 'static,

Spawns a future onto the runtime blocking pool.

This spawns the given future onto the runtime’s blocking executor

pub fn into_inner(self) -> TokioHandle

Transform to inner tokio handler

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy 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

Formats the value using the given formatter.

impl Spawn for Handle

fn spawn_task<F>(&self, future: F)

where F: Future<Output = ()> + Send + 'static,

This spawns the given future onto the runtime’s executor