Struct Runtime 

pub struct Runtime(/* private fields */);

Available on crate feature tasks only.

A cheaply cloneable handle to the runtime resources.

Wraps an Arc<RuntimeInner> and provides access to:

• The tokio [Handle]
• Task spawning with shutdown awareness and panic monitoring
• Rayon thread pools (with rayon feature)

Implementations

impl Runtime

pub fn with_existing_handle( handle: Handle, ) -> Result<Runtime, RuntimeBuildError>

Creates a Runtime that attaches to an existing tokio runtime handle.

impl Runtime

pub fn take_task_manager_handle( &self, ) -> Option<JoinHandle<Result<(), PanickedTaskError>>>

Takes the TaskManager handle out of this runtime, if one is stored.

The handle resolves with Err(PanickedTaskError) if a critical task panicked, or Ok(()) if shutdown was requested. If not taken, the background task still runs and logs panics at debug! level.

pub fn handle(&self) -> &Handle

Returns the tokio runtime [Handle].

pub fn cpu_pool(&self) -> &ThreadPool

Available on crate feature rayon only.

Get the general-purpose rayon CPU thread pool.

pub fn rpc_pool(&self) -> &BlockingTaskPool

Available on crate feature rayon only.

Get the RPC blocking task pool.

pub fn storage_pool(&self) -> &ThreadPool

Available on crate feature rayon only.

Get the storage I/O pool.

pub fn blocking_guard(&self) -> BlockingTaskGuard

Available on crate feature rayon only.

Get a clone of the BlockingTaskGuard.

pub fn proof_storage_worker_pool(&self) -> &ThreadPool

Available on crate feature rayon only.

Get the proof storage worker pool.

pub fn proof_account_worker_pool(&self) -> &ThreadPool

Available on crate feature rayon only.

Get the proof account worker pool.

impl Runtime

pub fn test() -> Runtime

Creates a lightweight Runtime for tests with minimal thread pools.

If called from within a tokio runtime (e.g. #[tokio::test]), attaches to the existing handle to avoid shutdown panics when the test runtime is dropped.

pub fn test_with_handle(handle: Handle) -> Runtime

Creates a lightweight Runtime for tests, attaching to the given tokio handle.

impl Runtime

pub fn on_shutdown_signal(&self) -> &Shutdown

Returns the receiver of the shutdown signal.

pub fn spawn_task<F>(&self, fut: F) -> JoinHandle<()>

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

Spawns the task onto the runtime. The given future resolves as soon as the Shutdown signal is received.

See also [Handle::spawn].

pub fn spawn_blocking_task<F>(&self, fut: F) -> JoinHandle<()>

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

Spawns a blocking task onto the runtime. The given future resolves as soon as the Shutdown signal is received.

See also [Handle::spawn_blocking].

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

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

Spawns a blocking closure directly on the tokio runtime, bypassing shutdown awareness. Useful for raw CPU-bound work.

pub fn spawn_with_signal<F>( &self, f: impl FnOnce(Shutdown) -> F, ) -> JoinHandle<()>

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

Spawns the task onto the runtime. The given future resolves as soon as the Shutdown signal is received.

See also [Handle::spawn].

pub fn spawn_critical_task<F>( &self, name: &'static str, fut: F, ) -> JoinHandle<()>

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

This spawns a critical task onto the runtime. The given future resolves as soon as the Shutdown signal is received.

If this task panics, the TaskManager is notified.

pub fn spawn_critical_blocking_task<F>( &self, name: &'static str, fut: F, ) -> JoinHandle<()>

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

This spawns a critical blocking task onto the runtime. The given future resolves as soon as the Shutdown signal is received.

If this task panics, the TaskManager is notified.

pub fn spawn_critical_with_shutdown_signal<F>( &self, name: &'static str, f: impl FnOnce(Shutdown) -> F, ) -> JoinHandle<()>

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

This spawns a critical task onto the runtime.

If this task panics, the TaskManager is notified.

pub fn spawn_critical_with_graceful_shutdown_signal<F>( &self, name: &'static str, f: impl FnOnce(GracefulShutdown) -> F, ) -> JoinHandle<()>

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

This spawns a critical task onto the runtime.

If this task panics, the TaskManager is notified. The TaskManager will wait until the given future has completed before shutting down.

Example

executor.spawn_critical_with_graceful_shutdown_signal("grace", |shutdown| async move {
    // await the shutdown signal
    let guard = shutdown.await;
    // do work before exiting the program
    tokio::time::sleep(std::time::Duration::from_secs(1)).await;
    // allow graceful shutdown
    drop(guard);
});

pub fn spawn_with_graceful_shutdown_signal<F>( &self, f: impl FnOnce(GracefulShutdown) -> F, ) -> JoinHandle<()>

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

This spawns a regular task onto the runtime.

The TaskManager will wait until the given future has completed before shutting down.

Example

executor.spawn_with_graceful_shutdown_signal(|shutdown| async move {
    // await the shutdown signal
    let guard = shutdown.await;
    // do work before exiting the program
    tokio::time::sleep(std::time::Duration::from_secs(1)).await;
    // allow graceful shutdown
    drop(guard);
});

pub fn initiate_graceful_shutdown( &self, ) -> Result<GracefulShutdown, SendError<()>>

Sends a request to the TaskManager to initiate a graceful shutdown.

Caution: This will terminate the entire program.

pub fn graceful_shutdown(&self)

Fires the shutdown signal and waits until all graceful tasks complete.

pub fn graceful_shutdown_with_timeout(&self, timeout: Duration) -> bool

Fires the shutdown signal and waits until all graceful tasks complete or the timeout elapses.

Returns true if all tasks completed before the timeout.

Trait Implementations

impl Clone for Runtime

fn clone(&self) -> Runtime

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Runtime

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

Formats the value using the given formatter.

impl Default for Runtime

Available on crate features test-utils only.

fn default() -> Runtime

Returns the “default value” for a type.

impl TaskSpawner for Runtime

fn spawn_task( &self, fut: Pin<Box<dyn Future<Output = ()> + Send>>, ) -> JoinHandle<()>

Spawns the task onto the runtime. See also [Handle::spawn].

fn spawn_critical_task( &self, name: &'static str, fut: Pin<Box<dyn Future<Output = ()> + Send>>, ) -> JoinHandle<()>

This spawns a critical task onto the runtime.

fn spawn_blocking_task( &self, fut: Pin<Box<dyn Future<Output = ()> + Send>>, ) -> JoinHandle<()>

Spawns a blocking task onto the runtime.

fn spawn_critical_blocking_task( &self, name: &'static str, fut: Pin<Box<dyn Future<Output = ()> + Send>>, ) -> JoinHandle<()>

This spawns a critical blocking task onto the runtime.

impl TaskSpawnerExt for Runtime

fn spawn_critical_with_graceful_shutdown_signal<F>( &self, name: &'static str, f: impl FnOnce(GracefulShutdown) -> F, ) -> JoinHandle<()>

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

This spawns a critical task onto the runtime.

fn spawn_with_graceful_shutdown_signal<F>( &self, f: impl FnOnce(GracefulShutdown) -> F, ) -> JoinHandle<()>

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

This spawns a regular task onto the runtime.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes