Struct Command 

pub struct Command<C = Context> { /* private fields */ }

Command structure which represents command-line task.

Implementations

impl<C> Command<C>

Command structure implementation.

pub fn name(&self) -> &String

Returns name.

pub fn about(&self) -> &Option<String>

Returns about.

pub fn description(&self) -> &Option<String>

Returns description.

pub fn author(&self) -> &Option<String>

Returns author.

pub fn version(&self) -> &Option<String>

Returns version.

pub fn flags(&self) -> &Vec<Flag>

Returns flags.

pub fn params(&self) -> &Vec<Param>

Returns flags.

pub fn resources(&self) -> &Vec<Resource>

Returns resources.

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

Returns commands.

impl<C> Command<C>

Command structure implementation.

pub fn with_name<S: Into<String>>(name: S) -> Self

Returns new instance.

pub fn with_about<S: Into<String>>(self, val: S) -> Self

Sets about.

pub fn with_description<S: Into<String>>(self, val: S) -> Self

Sets description.

pub fn with_author<S: Into<String>>(self, val: S) -> Self

Sets about.

pub fn with_version<S: Into<String>>(self, val: S) -> Self

Sets version.

pub fn with_handler(self, handler: CommandHandler<C>) -> Self

Sets error handler function.

pub fn with_resolver(self, resolver: CommandResolver<C>) -> Self

Sets resolver function.

pub fn with_flag(self, flag: Flag) -> Self

Adds flag.

pub fn with_param(self, param: Param) -> Self

Adds param.

pub fn with_resource(self, resource: Resource) -> Self

Adds resource.

pub fn with_subcommand(self, command: Command<C>) -> Self

Adds subcommand.

pub fn run(self, ctx: &mut C) -> Result<i32>

Executes as a command-line application.

pub fn run_args<A, T>(self, args: A, ctx: &mut C) -> Result<i32>

where A: IntoIterator<Item = T>, T: Into<String>,

Executes as a command-line application.