Struct App 

pub struct App { /* private fields */ }

Command line application

Implementations

impl App

pub fn new<T: Into<String>>(help: T, version: T) -> App

Create a new command line application.

Examples found in repository

examples/ecla.rs (line 36)

fn main() {
    let app = App::new(HELP, VERSION);

    if let Some(_) = app.get_command("command") {
        command();
    } else if let Some(command) = app.get_command("flag") {
        let flag = command.get_flag(&["-f", "--force"]);
        if flag.is_some() {
            command_with_flag(flag.unwrap().get_value());
        } else {
            command_with_no_flag();
        }
    } else if let Some(command) = app.get_command("value") {
        command_with_value(command.get_value());
    } else {
        app.show_unknown_or_help();
    }
}

pub fn get_command(&self, name: &str) -> Option<Command>

Get sub command

Examples found in repository

examples/ecla.rs (line 38)

fn main() {
    let app = App::new(HELP, VERSION);

    if let Some(_) = app.get_command("command") {
        command();
    } else if let Some(command) = app.get_command("flag") {
        let flag = command.get_flag(&["-f", "--force"]);
        if flag.is_some() {
            command_with_flag(flag.unwrap().get_value());
        } else {
            command_with_no_flag();
        }
    } else if let Some(command) = app.get_command("value") {
        command_with_value(command.get_value());
    } else {
        app.show_unknown_or_help();
    }
}

pub fn has_flag(&self) -> bool

Check arguments if has flags

pub fn show_unknown_or_help(&self)

If you can not find any supported sub commands or flags, you can use this to tell user something is wrong.

Examples found in repository

examples/ecla.rs (line 50)

fn main() {
    let app = App::new(HELP, VERSION);

    if let Some(_) = app.get_command("command") {
        command();
    } else if let Some(command) = app.get_command("flag") {
        let flag = command.get_flag(&["-f", "--force"]);
        if flag.is_some() {
            command_with_flag(flag.unwrap().get_value());
        } else {
            command_with_no_flag();
        }
    } else if let Some(command) = app.get_command("value") {
        command_with_value(command.get_value());
    } else {
        app.show_unknown_or_help();
    }
}

pub fn has_command(&self) -> bool

Check arguments if has sub command

pub fn get_flag<T: AsRef<str>>(&self, names: &[T]) -> Option<Flag>

Get flag

pub fn show_command_unknown(&self)

Tell user is entering an unknown sub command

pub fn show_help(&self)

Print help message

pub fn show_version(&self)

Print version

Trait Implementations

impl Debug for App

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

Formats the value using the given formatter.