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(config: Configuration, tokio_runtime: Runtime) -> Result<Runner<C>>

Create a new runtime with the command provided in argument

Examples found in repository

src/lib.rs (line 203)

	fn create_runner<T: CliConfiguration<DVC>, DVC: DefaultConfigurationValues>(
		&self,
		command: &T,
	) -> error::Result<Runner<Self>> {
		let tokio_runtime = build_runtime()?;
		let config = command.create_configuration(self, tokio_runtime.handle().clone())?;

		command.init(&Self::support_url(), &Self::impl_version(), |_, _| {}, &config)?;
		Runner::new(config, tokio_runtime)
	}

	/// Create a runner for the command provided in argument. The `logger_hook` can be used to setup
	/// a custom profiler or update the logger configuration before it is initialized.
	///
	/// Example:
	/// ```
	/// use sc_tracing::{SpanDatum, TraceEvent};
	/// struct TestProfiler;
	///
	/// impl sc_tracing::TraceHandler for TestProfiler {
	///  	fn handle_span(&self, sd: &SpanDatum) {}
	/// 		fn handle_event(&self, _event: &TraceEvent) {}
	/// };
	///
	/// fn logger_hook() -> impl FnOnce(&mut sc_cli::LoggerBuilder, &sc_service::Configuration) -> () {
	/// 	|logger_builder, config| {
	/// 			logger_builder.with_custom_profiling(Box::new(TestProfiler{}));
	/// 	}
	/// }
	/// ```
	fn create_runner_with_logger_hook<T: CliConfiguration, F>(
		&self,
		command: &T,
		logger_hook: F,
	) -> error::Result<Runner<Self>>
	where
		F: FnOnce(&mut LoggerBuilder, &Configuration),
	{
		let tokio_runtime = build_runtime()?;
		let config = command.create_configuration(self, tokio_runtime.handle().clone())?;

		command.init(&Self::support_url(), &Self::impl_version(), logger_hook, &config)?;
		Runner::new(config, tokio_runtime)
	}

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

Examples found in repository

src/runner.rs (line 134)

	fn print_node_infos(&self) {
		print_node_infos::<C>(self.config())
	}

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

Get a mutable reference to the node Configuration