Struct CliRunner

#[non_exhaustive]
pub struct CliRunner;

Executes CLI commands.

Provides utilities for running a cli command to completion.

Implementations

impl CliRunner

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 + 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_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 Clone for CliRunner

fn clone(&self) -> CliRunner

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CliRunner

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

Formats the value using the given formatter.

impl Default for CliRunner

fn default() -> CliRunner

Returns the “default value” for a type.

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: 0 bytes