Struct SubcommandSet 

pub struct SubcommandSet<Ctx> { /* private fields */ }

Implementations

impl<Ctx> SubcommandSet<Ctx>

where Ctx: 'static,

pub fn toggle<F>( self, name: &'static str, help: &'static str, handler: F, ) -> SubcommandSet<Ctx>

where F: FnMut(&mut Ctx, Option<bool>) -> Result<(), Error> + 'static,

Parses on|off|true|false|1|0; a bare invocation passes None.

pub fn choice<F>( self, name: &'static str, help: &'static str, choices: &[&'static str], handler: F, ) -> SubcommandSet<Ctx>

where F: FnMut(&mut Ctx, Option<&str>) -> Result<(), Error> + 'static,

The handler receives the raw value string, unvalidated against choices.

pub fn custom<F>( self, name: &'static str, help: &'static str, arg_choices: &[&[&'static str]], value_choices: &[(&'static str, &[&'static str])], handler: F, ) -> SubcommandSet<Ctx>

where F: FnMut(&mut Ctx, &[&str], &mut ConsoleWriter) -> Result<(), Error> + 'static,

arg_choices[i] completes the i-th arg after the subcommand name.

pub fn with_long_help(self, long: &'static str) -> SubcommandSet<Ctx>

The subcommand table is appended either way.

pub fn on_bare<F>(self, handler: F) -> SubcommandSet<Ctx>

where F: FnMut(&mut Ctx) -> Result<(), Error> + 'static,

A bare command name runs handler instead of a usage error.

Trait Implementations

impl<Ctx> Command<Ctx> for SubcommandSet<Ctx>

where Ctx: 'static,

fn name(&self) -> &str

fn help(&self) -> &str

fn long_help(&self) -> String

\n breaks paint as separate scrollback entries.

fn arg_choices(&self, arg_index: usize) -> &[&'static str]

fn arg_choices_ctx<'a>( &'a self, arg_index: usize, prior: &[&str], ) -> &'a [&'static str]

prior is the arg tokens before the cursor.

fn arg_value_choices_ctx<'a>( &'a self, _arg_index: usize, key: &str, prior: &[&str], ) -> &'a [&'static str]

fn run( &mut self, args: &[&str], ctx: &mut Ctx, out: &mut ConsoleWriter, ) -> Result<(), Error>

Recoverable issues go to out.error(..); unrecoverable ones return Err.

fn arg_value_choices(&self, arg_index: usize, key: &str) -> &[&'static str]

key carries no trailing =; empty means free-form.