Struct Console 

pub struct Console { /* private fields */ }

The console kernel: a registry of commands and the dispatcher for them.

Implementations

impl Console

pub fn new(name: impl Into<String>) -> Self

A console named name, as shown in its usage line.

pub fn register(self, command: impl Command) -> Self

Register a command.

pub fn register_arc(self, command: Arc<dyn Command>) -> Self

Register an already-shared command.

pub fn commands(&self) -> Vec<Arc<dyn Command>>

Every registered command, sorted by name.

pub fn find(&self, name: &str) -> Option<Arc<dyn Command>>

Look a command up by name.

pub async fn run(&self, app: &Application, args: Arguments) -> i32

Run the command named in args, returning its exit code.

Never panics and never propagates: a console’s job is to report and exit with a code, so an error becomes a message on stderr and exit::FAILURE.

pub async fn run_argv<I, S>(&self, app: &Application, argv: I) -> i32

where I: IntoIterator<Item = S>, S: Into<String>,

Parse argv (without the program name) and run it.

pub async fn run_from_env(&self, app: &Application) -> i32

Parse the process’s own arguments and run.

pub fn usage(&self) -> String

The usage text: a header and the command list, aligned.

Trait Implementations

impl Debug for Console

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

Formats the value using the given formatter.