Just Getopt

A getopt-like command-line parser for the Rust language

Introduction

This Rust language library crate implements a Posix getopt-like command-line option parser with simple programming interface. More specifically the parser is like getopt’s GNU extension called getopt_long which is familiar command-line option format for users of Linux-based operating systems.

The name is Just Getopt because this is just a getopt parser and (almost) nothing more. The intent is to provide the parsed output and basic methods for examining the output. There will not be anything for interpreting the output or for printing messages to program’s user. The responsibility of interpretation is left to your program.

In getopt logic there are two types of command-line options:

1. short options with a single letter name (-f)
2. long options with more than one letter as their name (--file).

Both option types may accept an optional value or they may require a value. Values are given after the option.

Availability

The crate is available at Github and crates.io and it can added to a Rust project with command cargo add just-getopt. The Github site has information about releases and issues.

Documentation is available at docs.rs. From the source code directory the documentation can be built and shown in a web browser with command cargo doc --open.

Also see file examples/basic.rs for basic programming examples.

Incompatible Changes in 2.0

Version 2.0 introduced some incompatible changes. When updating the crate from 1.x versions the following changes must be addressed:

• Methods of Args struct no longer return a vector. They return a type which implements the trait DoubleEndedIterator. The methods are: required_value_missing, options_all and options_value_all.
• Enum OptValueType was renamed to OptValue and the enum is now marked as non-exhaustive: more variants were added in 2.0 and can be added in the future.

License

Author: Teemu Likonen <[email protected]>

OpenPGP key: 6965F03973F0D4CA22B9410F0F2CAE0E07608462

License: Creative Commons CC0 (public domain dedication)