Struct Runtime

pub struct Runtime<'a, S> { /* private fields */ }

This is the Runtime that runs a Flowgraph to completion.

Runtimes are generic over the scheduler used to run the Flowgraph.

Implementations

impl Runtime<'_, SmolScheduler>

pub fn new() -> Self

Constructs a new Runtime using SmolScheduler::default() for the Scheduler.

pub fn with_custom_routes(routes: Router) -> Self

Set custom routes for the control port Axum webserver

impl<'a, S: Scheduler + Sync> Runtime<'a, S>

pub fn with_scheduler(scheduler: S) -> Self

Create a Runtime with a given Scheduler

pub fn with_config(scheduler: S, routes: Router) -> Self

Create runtime with given scheduler and Axum routes

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

Spawn task on runtime

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

Block thread, waiting for future to complete

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

Spawn task on runtime in background, detaching the handle

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

Spawn a blocking task

This is usually moved in a separate thread.

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

Spawn a blocking task in the background

pub async fn start<'b>( &'a self, fg: Flowgraph, ) -> (TaskHandle<'b, Result<Flowgraph, Error>>, FlowgraphHandle)

where 'a: 'b,

Start a Flowgraph on the Runtime

Returns, once the flowgraph is constructed and running.

pub fn start_sync( &self, fg: Flowgraph, ) -> (TaskHandle<'_, Result<Flowgraph, Error>>, FlowgraphHandle)

Start a Flowgraph on the Runtime

Blocks until the flowgraph is constructed and running.

pub fn run(&self, fg: Flowgraph) -> Result<Flowgraph, Error>

Start a Flowgraph on the Runtime and block until it terminates.

pub async fn run_async(&self, fg: Flowgraph) -> Result<Flowgraph, Error>

Start a Flowgraph on the Runtime and await its termination.

pub fn scheduler(&self) -> S

Get the Scheduler that is associated with the Runtime.

pub fn handle(&self) -> RuntimeHandle

Get the RuntimeHandle

Trait Implementations

impl Default for Runtime<'_, SmolScheduler>

fn default() -> Self

Returns the “default value” for a type.

impl<S> Drop for Runtime<'_, S>

fn drop(&mut self)

Executes the destructor for this type.