Struct Runtime 

pub struct Runtime { /* private fields */ }

Cheaply cloneable handle to the application runtime, providing access to services, the egui context, and the application events channel.

Implementations

impl Runtime

pub fn new(egui_ctx: &Context, events: Option<ApplicationEventsChannel>) -> Self

Create a new runtime bound to the given egui context, registering it as the global runtime. An optional application events channel may be supplied, otherwise an unbounded channel is created.

pub fn bind(&self, service: Arc<dyn Service>)

Register a service with the runtime under its name and immediately spawn its async task.

pub fn uptime(&self) -> Duration

Returns the elapsed time since the runtime was created.

pub fn start_services(&self)

Spawn the async task for each bound service.

pub fn services(&self) -> Vec<Arc<dyn Service>>

Returns a snapshot of all currently bound services.

pub fn stop_services(&self)

Request termination of all bound services.

pub async fn join_services(&self)

Await the completion of all services’ join futures.

pub fn drop(&self)

Unregister this runtime from the global slot.

pub fn start(&self)

Mark the runtime as running and start all bound services.

pub async fn shutdown(&self)

Shutdown runtime runtime.

pub fn repaint_service(&self) -> &Arc<RepaintService>

Returns the reference to the repaint service driving egui redraws.

pub fn events(&self) -> &ApplicationEventsChannel

Returns the reference to the application events channel.

pub async fn send<T>(&self, msg: T) -> Result<()>

where T: Any + Send + Sync + 'static,

Send an application even to the UI asynchronously.

pub async fn send_runtime_event(&self, msg: RuntimeEvent) -> Result<()>

Send a RuntimeEvent to the UI asynchronously.

pub fn try_send<T>(&self, msg: T) -> Result<()>

where T: Any + Send + Sync + 'static,

Send an application event to the UI synchronously.

pub fn try_send_runtime_event(&self, msg: RuntimeEvent) -> Result<()>

Send a RuntimeEvent to the UI synchronously without blocking.

pub fn spawn_task<F>(&self, task: F)

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

Spawn an async task on the runtime; if the task returns an error, it is forwarded to the UI as a RuntimeEvent::Error.

pub fn spawn_task_with_result<R, F>( &self, payload: &Payload<Result<R, Error>>, task: F, )

where R: Clone + Send + 'static, F: Future<Output = Result<R>> + Send + 'static,

Spawn an async task whose result is stored into the supplied Payload. The payload is marked pending while the task runs and then populated with the Ok or Err outcome on completion.

pub fn egui_ctx(&self) -> &Context

Returns the reference to the egui context bound to this runtime.

pub fn request_repaint(&self)

Request an egui repaint via the repaint service.

impl Runtime

Gracefully halt the runtime runtime. This is used to shutdown kaspad when the kaspa-ng process exit is an inevitable eventuality.

pub fn halt()

Trigger a graceful shutdown of the runtime, sending an exit event and blocking until all services have completed their shutdown.

pub fn abort()

Attempt to halt the runtime runtime but exit the process if it takes too long. This is used in attempt to shutdown kaspad if the kaspa-ng process panics, which can result in a still functioning zombie child process on unix systems.

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.