27 releases

0.2.21 Aug 19, 2019
0.2.19 May 2, 2019
0.2.18 Jul 5, 2018
0.2.17 Jan 25, 2018
0.1.0 Dec 13, 2014

#13 in Command-line interface

Download history 26147/week @ 2019-08-08 26771/week @ 2019-08-15 25597/week @ 2019-08-22 26925/week @ 2019-08-29 28762/week @ 2019-09-05 24946/week @ 2019-09-12 26894/week @ 2019-09-19 30073/week @ 2019-09-26 34586/week @ 2019-10-03 33240/week @ 2019-10-10 31550/week @ 2019-10-17 32711/week @ 2019-10-24 30710/week @ 2019-10-31 34097/week @ 2019-11-07 36104/week @ 2019-11-14

115,861 downloads per month
Used in 579 crates (271 directly)

MIT/Apache

72KB
2K SLoC

getopts

A Rust library for option parsing for CLI utilities.

Documentation

Usage

Add this to your Cargo.toml:

[dependencies]
getopts = "0.2"

lib.rs:

Simple getopt alternative.

Construct a vector of options, either by using reqopt, optopt, and optflag or by building them from components yourself, and pass them to getopts, along with a vector of actual arguments (not including argv[0]). You'll either get a failure code back, or a match. You'll have to verify whether the amount of 'free' arguments in the match is what you expect. Use opt_* accessors to get argument values out of the matches object.

Single-character options are expected to appear on the command line with a single preceding dash; multiple-character options are expected to be proceeded by two dashes. Options that expect an argument accept their argument following either a space or an equals sign. Single-character options don't require the space.

Usage

This crate is on crates.io and can be used by adding getopts to the dependencies in your project's Cargo.toml.

[dependencies]
getopts = "0.2"

and this to your crate root:

extern crate getopts;

Example

The following example shows simple command line parsing for an application that requires an input file to be specified, accepts an optional output file name following -o, and accepts both -h and --help as optional flags.

extern crate getopts;
use getopts::Options;
use std::env;

fn do_work(inp: &str, out: Option<String>) {
    println!("{}", inp);
    match out {
        Some(x) => println!("{}", x),
        None => println!("No Output"),
    }
}

fn print_usage(program: &str, opts: Options) {
    let brief = format!("Usage: {} FILE [options]", program);
    print!("{}", opts.usage(&brief));
}

fn main() {
    let args: Vec<String> = env::args().collect();
    let program = args[0].clone();

    let mut opts = Options::new();
    opts.optopt("o", "", "set output file name", "NAME");
    opts.optflag("h", "help", "print this help menu");
    let matches = match opts.parse(&args[1..]) {
        Ok(m) => { m }
        Err(f) => { panic!(f.to_string()) }
    };
    if matches.opt_present("h") {
        print_usage(&program, opts);
        return;
    }
    let output = matches.opt_str("o");
    let input = if !matches.free.is_empty() {
        matches.free[0].clone()
    } else {
        print_usage(&program, opts);
        return;
    };
    do_work(&input, output);
}

Dependencies

~120KB