getopt is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install getopt

It will make the getopt command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall getopt uninstalls.

Adding `getopt` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add getopt

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

getopt = "1.1.9"

The getopt library will be automatically available globally.

Back to the crate overview.

Readme

getopt

A minimal, (essentially) POSIX-compliant option parser.

getopt::Parser iterates over the provided arguments, producing options one at a time in the order in which they are given on the command line, and stopping at the first non-option argument.

Example:

#![allow(unused_assignments, unused_variables)]

use getopt::Opt;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut args: Vec<String> = std::env::args().collect();
    let mut opts = getopt::Parser::new(&args, "ab:");

    let mut a_flag = false;
    let mut b_flag = String::new();
    loop {
        match opts.next().transpose()? {
            None => break,
            Some(opt) => match opt {
                Opt('a', None) => a_flag = true,
                Opt('b', Some(string)) => b_flag = string.clone(),
                _ => unreachable!(),
            }
        }
    }

    let args = args.split_off(opts.index());

    // …

    Ok(())
}

Installing the command-line executable

Adding getopt library as a dependency

Adding `getopt` library as a dependency