Crate dia_args[−][src]

A command line parser

Repository: https://bitbucket.org/haibison/dia-args
License: Nice License 1.0.0 (see LICENSE file at root directory of master branch)
This project follows Semantic Versioning 2.0.0

No debts: no dependencies. It’s an argument parser, so standard Rust is enough.
There’s a specification (below). It has a separate version, not same as the library’s.
parse_file() helps parse arguments stored in your file.
::docs helps make documentation for your program.
Optional bin feature provides a program which helps you generate simple Rust source code templates. You can run the program with help command for more details.

A program argument can be:

Commands
- A command can be anything which does not start with either - or --.
Arguments
- Same as a command, an argument can be anything which does not start with either - or --.
Options

An option starts with - or --.
- - supports either:
  - A single short format option.
  - Or multiple short format boolean options.
- -- supports a single long format option.
- Option values can be anything.
- An option’s key and value can be separated by either:
  - An equals sign =.
  - Or mutiple white spaces.
- A boolean option has 2 values: true and false. The value is optional. If absent, true will be assigned.
Special phrases
- - means: the program should process standard input.
- -- means: the program should process all phrases after it as arguments. This is normally used to pass arguments to sub process.
Passing arguments to a program

Must be in this form:
```
program [command|arguments...|options...|-] [-- [arguments...]]
```
in which:
- [] means optional.
- ... means multiple arguments.

make_cmds	Makes a vector of `Cow<'_, Cmd<'_>>` from a list of either `Cmd` or `&Cmd`
make_opts	Makes a vector of `Cow<'_, Opt<'_>>` from a list of either `Opt` or `&Opt`

Arguments

Answer	Answer
MergeOption	Merge option

CODE_NAME	Crate code name
DIA_ARGS_FILE_FORMAT	Description of argument file format, in English
DIA_ARGS_FILE_NAME	Default file name for storing arguments: `.dia-args`
FALSE_AS_STR	`false` as string
ID	ID of this crate
MAX_DIA_ARGS_FILE_SIZE	Maximum size allowed for argument file to be parsed (3 MiB)
NAME	Crate name
RELEASE_DATE	Crate release date (year/month/day)
TAG	Tag, which can be used for logging…
TRUE_AS_STR	`true` as string
VERSION	Crate version

ask_user	Asks user some question
lock_write_err	Locks stderr and writes to it
lock_write_out	Locks stdout and writes to it
parse	Parses from process’ arguments
parse_file	Parses from file
parse_stream	Parses a stream of strings, separated by null byte (`0`)
parse_strings	Parses from an iterator of strings
read_line	Reads a line from stdin, trims and converts it to `T`

Result type used in this crate