Struct sc_cli::Runner

pub struct Runner<C: SubstrateCli> { /* private fields */ }

A Substrate CLI runtime that can be used to run a node or a command

Implementations

impl<C: SubstrateCli> Runner<C>

pub fn new<T: CliConfiguration>(
    cli: &C,
    command: &T,
    telemetry_worker: TelemetryWorker
) -> Result<Runner<C>>

Create a new runtime with the command provided in argument

pub fn run_node_until_exit<F, E>(
    self,
    initialize: impl FnOnce(Configuration) -> F
) -> Result<(), E> where
    F: Future<Output = Result<TaskManager, E>>,
    E: Error + Send + Sync + 'static + From<ServiceError>, 

A helper function that runs a node with tokio and stops if the process receives the signal SIGTERM or SIGINT.

pub fn sync_run<E>(
    self,
    runner: impl FnOnce(Configuration) -> Result<(), E>
) -> Result<(), E> where
    E: Error + Send + Sync + 'static + From<ServiceError>, 

A helper function that runs a command with the configuration of this node.

pub fn async_run<F, E>(
    self,
    runner: impl FnOnce(Configuration) -> Result<(F, TaskManager), E>
) -> Result<(), E> where
    F: Future<Output = Result<(), E>>,
    E: Error + Send + Sync + 'static + From<ServiceError> + From<CliError>, 

A helper function that runs a future with tokio and stops if the process receives the signal SIGTERM or SIGINT.

pub fn config(&self) -> &Configuration

Get an immutable reference to the node Configuration

pub fn config_mut(&mut self) -> &mut Configuration

Get a mutable reference to the node Configuration

pub fn telemetry_handle(&self) -> TelemetryHandle

Get a new TelemetryHandle.

This is used when you want to register with the TelemetryWorker.