Struct Opt

pub struct Opt {
    pub opts: HashMap<String, OptValue>,
}

Opt

main struct.

normal usage:

use rust_command_opt::opt::Opt;

fn main() {
    let opt = Opt::init();
    if let Some(value) = opt.get_opt_short("-a") {
        println!("{}", value.one());
    }
}

Fields

opts: HashMap<String, OptValue>

Implementations

impl Opt

pub fn init() -> Opt

Init with command args.

pub fn with(args: Vec<String>) -> Opt

Init with you custom args. (Usually used in test)

pub fn get_opt(&self, op_name: OptOption<'_>) -> Option<OptValue>

Basic get opt method.

usage:

use rust_command_opt::opt::Opt;

let opt = Opt::init();
if let Some(value) = opt.get_opt(Opt::one("-a")) {
    println!("{}", value.one());
}

pub fn get_opt_short_with_default(&self, name: &str, default: &str) -> OptValue

Only use short option, and have a default value.

usage

use rust_command_opt::opt::Opt;

let opt = Opt::init();
let value = opt.get_opt_short_with_default("-a", "default_value").one();

pub fn get_opt_normal_with_default( &self, short: &str, long: &str, default: &str, ) -> OptValue

Use short and full option, and have a default value.

usage

use rust_command_opt::opt::Opt;

let opt = Opt::init();
let value = opt.get_opt_normal_with_default("-a", "--all", "default_value").one();

pub fn get_opt_short(&self, name: &str) -> Option<OptValue>

Only use short option.

use rust_command_opt::opt::Opt;

let opt = Opt::init();
if let Some(value) = opt.get_opt_short("-a") {
    println!("{}", value.one());
}

pub fn get_opt_normal(&self, short: &str, long: &str) -> Option<OptValue>

Only use short option.

use rust_command_opt::opt::Opt;

let opt = Opt::init();
if let Some(value) = opt.get_opt_normal("-a", "--all") {
    println!("{}", value.one());
}

pub fn one(short: &str) -> OptOption<'_>

Make short option

pub fn normal<'a>(short: &'a str, long: &'a str) -> OptOption<'a>

Make short and full option