Struct CmdSpec 

pub struct CmdSpec<'a, Ctx: ?Sized> { /* private fields */ }

Command specification.

Implementations

impl<'a, Ctx: ?Sized> CmdSpec<'a, Ctx>

pub fn new(name: &'a str) -> Self

pub fn help(self, s: &'a str) -> Self

pub fn alias(self, a: &'a str) -> Self

pub fn opt(self, o: OptSpec<'a, Ctx>) -> Self

pub fn pos(self, p: PosSpec<'a, Ctx>) -> Self

pub fn subcmd(self, c: Self) -> Self

pub fn group(self, name: &'a str, mode: GroupMode) -> Self

pub fn validator<F, E>(self, cb: F) -> Self

where F: Fn(&Matches) -> Result<(), E> + 'a, E: Display,

Set per-command validator returning a displayable error (converted into Error::User).

pub fn validator_try<F, E>(self, cb: F) -> Self

where F: Fn(&Matches) -> Result<(), E> + 'a, E: Error + Send + Sync + 'static,

Set per-command validator returning a typed error (boxed into Error::UserAny).

pub fn handler<F>(self, cb: F) -> Self

where F: Fn(&Matches, &mut Ctx) + 'a,

Set a leaf command handler. Only the selected leaf handler is executed.

pub fn handler_try<F, E>(self, cb: F) -> Self

where F: Fn(&Matches, &mut Ctx) -> Result<(), E> + 'a, E: Error + Send + Sync + 'static,

Set a leaf command handler with a typed error (boxed into Error::UserAny).

pub fn get_name(&self) -> &str

pub fn get_help(&self) -> Option<&str>

pub fn get_aliases(&self) -> &[&'a str]

pub fn get_opts(&self) -> &[OptSpec<'a, Ctx>]

pub fn get_positionals(&self) -> &[PosSpec<'a, Ctx>]

pub fn get_subcommands(&self) -> &[Self]

pub fn get_groups(&self) -> &[GroupDecl<'a>]

pub fn get_validator(&self) -> Option<&CmdValidatorFn<'a>>

pub fn get_handler(&self) -> Option<&CmdHandlerFn<'a, Ctx>>

pub fn find_sub(&self, needle: &str) -> Option<&Self>