Struct Main 

pub struct Main<'m> { /* private fields */ }

A main runner.

The idea of the main runner is to perform all setup steps, gathering all tasks (futures) to be executed, and then initialize the stack and drive the tasks, until one of them completes.

In some cases it might be necessary to run a set of tasks on a different context (like actix, or ntex). In this case it is possible to create a SubMain instance using SubMain::sub_main.

Implementations

impl<'m> Main<'m>

pub fn new(config: RuntimeConfig) -> Self

pub fn from_env() -> Result<Self>

pub fn add_tasks<I>(self, tasks: I) -> Self

where I: IntoIterator<Item = LocalBoxFuture<'m, Result<()>>>,

Add tasks to run.

pub fn add_checks<I>(&mut self, i: I)

where I: IntoIterator<Item = Box<dyn HealthChecked>>,

pub async fn run(self) -> Result<()>

Methods from Deref<Target = SubMain<'m>>

pub fn is_empty(&self) -> bool

Returns true is there are no tasks scheduled so far.

pub fn sub_main(&self) -> SubMain<'_>

Create a new sub-main instance.

pub fn sub_main_seed(&self) -> SubMainSeed

Create a seed or a sub-main instance, which can be sent.

Trait Implementations

impl<'m> Default for Main<'m>

fn default() -> Self

Returns the “default value” for a type.

impl<'m> Deref for Main<'m>

type Target = SubMain<'m>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'m> DerefMut for Main<'m>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Spawner for Main<'_>

fn spawn_boxed(&mut self, future: Pin<Box<dyn Future<Output = Result<()>>>>)

impl Startup for Main<'_>

fn check_boxed(&mut self, check: Box<dyn HealthChecked>)

Add a health check.

fn use_tracing(&self) -> bool

Allow the application to check if the runtime wants to enable tracing.

fn runtime_config(&self) -> &RuntimeConfig

Access the runtime config.