Struct Runtime 

pub struct Runtime { /* private fields */ }

Implementations

impl Runtime

pub fn spawner(&self) -> Spawner

Returns a weak capability for submitting work to this runtime.

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

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

Submits a task to one priority queue.

Errors

Returns SpawnError::Closed after shutdown begins.

A successful return means the task was admitted into the runtime’s lifecycle. A concurrent forced or timed shutdown may cancel it before its first poll; graceful shutdown still waits for it to reach a terminal state.

pub fn shutdown_graceful(self) -> Result<(), ShutdownError>

Rejects new tasks, drains every accepted task, and joins all workers.

Errors

Returns ShutdownError::CalledFromWorker when invoked by this runtime’s worker, or ShutdownError::WorkerPanicked if a joined worker panicked.

pub fn shutdown_timeout( self, timeout: Duration, ) -> Result<ShutdownOutcome, ShutdownError>

Drains accepted tasks until timeout, then cancels the remainder.

Errors

Returns ShutdownError::CalledFromWorker when invoked by this runtime’s worker, or ShutdownError::WorkerPanicked if a joined worker panicked.

pub fn shutdown_now(self) -> Result<(), ShutdownError>

Cancels remaining work and joins all workers.

Errors

Returns ShutdownError::CalledFromWorker when invoked by this runtime’s worker, or ShutdownError::WorkerPanicked if a joined worker panicked.

Trait Implementations

impl Drop for Runtime

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.