just-getopt 2.1.0

Just a getopt-like command-line option parser
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

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.


[Rust]: https://www.rust-lang.org/


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](examples/basic.rs) for basic
programming examples.


[Github]:    https://github.com/tlikonen/just-getopt
[crates.io]: https://crates.io/crates/just-getopt
[releases]:  https://github.com/tlikonen/just-getopt/releases
[issues]:    https://github.com/tlikonen/just-getopt/issues
[docs.rs]:   https://docs.rs/just-getopt/


Incompatible Changes in 2.0
---------------------------

Version 2.0 introduced some backward 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 <<tlikonen@iki.fi>> ([web][], [PGP][])

License: [Creative Commons CC0][CC0] (public domain dedication)

[web]: http://www.iki.fi/tlikonen/
[PGP]: http://www.iki.fi/tlikonen/teemu.pgp
[CC0]: https://creativecommons.org/publicdomain/zero/1.0/legalcode