Struct app::App

pub struct App<'app> { /* fields omitted */ }

Application

Methods

impl<'app> App<'app>

fn new<S>(name: S) -> Self where
    S: Into<String>, 

name

fn version<S>(self, version: S) -> Self where
    S: Into<String>, 

version

fn desc<'s: 'app>(self, desc: &'s str) -> Self

discription

fn author<S>(self, name: S, email: S) -> Self where
    S: Into<String>, 

name, email

fn addr<S>(self, name: S, url: S) -> Self where
    S: Into<String>, 

url_name, url

fn opt(self, opt: Opt<'app>) -> Self

add a Opt

fn args(self, args: Args<'app>) -> Self

get arguments

fn cmd(self, cmd: Cmd<'app>) -> Self

add a sub_command

fn allow_zero_args(self, allow: bool) -> Self

allow env::args().count() == 1

deafult: true

impl<'app> App<'app>

fn build_helper(self) -> Self

build Helper for custom Helps

You can modify Helps.xxx by app.as_mut_helps()

fn as_mut_helps(&mut self) -> &mut Helps

fn parse_args(self) -> Helper

parse(std::env::args()[1..]) and exit(1) if parse fails.

fn parse(self, args: &[String]) -> Helper

parse(&[String]) and exit(1) if parse fails.

fn parse_strings(&mut self, args: &[String]) -> Result<(), AppError>

fn into_helper(self) -> Helper

impl<'app> App<'app>

About Cargo

If the binary being calling as subcommand by cargo,

You should call fix_helps_for_cargo() and use parse_args_for_cargo() to replace parse_args().

You could see the example: cargo-http

Notice:

If Your App's name is xxx, Your crate's name have to name like cargo-xxx,

and you can install it by cargo intsall,

you can call it by cargo xxx or cargo-xxx(If it's path in the path environment variable, but is not recommended),

if you want to call it by xxx, you can use ln or cp command.

ln -s $HOME/.cargo/bin/cargo-xxx  $HOME/.cargo/bin/xxx

or

sudo ln -s $HOME/.cargo/bin/cargo-xxx  /usr/bin/xxx

fn as_cargo_subcmd() -> bool

This function is only verified on Linux/Windows(cargo-V0.23.0) currently.

fn fix_helps_for_cargo(&mut self)

fn parse_args_for_cargo(self) -> Helper

parse(std::env::args()[2..]) and exit(1) if parse fails.

Trait Implementations

impl<'app> Debug for App<'app>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'app> Default for App<'app>

fn default() -> App<'app>

Returns the "default value" for a type.