Struct CliRunner 

pub struct CliRunner { /* private fields */ }

Executes CLI commands.

Provides utilities for running a cli command to completion.

Implementations

impl CliRunner

pub fn try_default_runtime() -> Result<Self, RuntimeBuildError>

Attempts to create a new CliRunner using the default Runtime.

The default runtime is multi-threaded, with both I/O and time drivers enabled.

pub fn try_with_runtime_config( config: RuntimeConfig, ) -> Result<Self, RuntimeBuildError>

Creates a new CliRunner with the given RuntimeConfig.

pub const fn with_config(self, config: CliRunnerConfig) -> Self

Sets the CliRunnerConfig for this runner.

pub fn runtime(&self) -> Runtime

Returns a clone of the underlying Runtime.

pub fn block_on<F, T>(&self, fut: F) -> T

where F: Future<Output = T>,

Executes an async block on the runtime and blocks until completion.

pub fn run_command_until_exit<F, E>( self, command: impl FnOnce(CliContext) -> F, ) -> Result<(), E>

where F: Future<Output = Result<(), E>>, E: Send + Sync + Display + From<Error> + From<PanickedTaskError> + 'static,

Executes the given async command on the tokio runtime until the command future resolves or until the process receives a SIGINT or SIGTERM signal.

Tasks spawned by the command via the [TaskExecutor] are shut down and an attempt is made to drive their shutdown to completion after the command has finished.

pub fn run_blocking_command_until_exit<F, E>( self, command: impl FnOnce(CliContext) -> F + Send + 'static, ) -> Result<(), E>

where F: Future<Output = Result<(), E>> + Send + 'static, E: Send + Sync + Display + From<Error> + From<PanickedTaskError> + 'static,

Executes a command in a blocking context with access to CliContext.

See Runtime::spawn_blocking.

pub fn run_until_ctrl_c<F, E>(self, fut: F) -> Result<(), E>

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

Executes a regular future until completion or until external signal received.

pub fn run_blocking_until_ctrl_c<F, E>(self, fut: F) -> Result<(), E>

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

Executes a regular future as a spawned blocking task until completion or until external signal received.

See Runtime::spawn_blocking.

Trait Implementations

impl Debug for CliRunner

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes