[][src]Crate dia_args

A command line parser

Project

Features

  • 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() can be useful: it helps you parse arguments stored in your file.

Specification 0.0.1

A program argument can be:

  • A command.

  • An argument.

  • An option.

  • Two special phrases: - and --.

  1. Commands

    • A command can be anything which does not start with either - or --.
  2. Arguments

    • Same as a command, an argument can be anything which does not start with either - or --.
  3. 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.

  4. Special phrases

    • - means: the program should process standard input.
    • -- means: the program should process all arguments after it as arguments. This is normally used to pass arguments to sub process.
  5. Passing arguments to a program

    Must be in this form:

    program [command] [arguments...|options...|-] [-- [arguments...]]
    

    in which:

    • [] means optional.
    • ... means multiple arguments.

Modules

docs

Kit for documentation

paths

Paths - extensions for Args

version_info

0.28.1 (April 7th, 2019)

Macros

display

Borrows an array of Display as a vector of &Display

Structs

Args

Arguments

Constants

CODE_NAME

Crate code name

DIA_ARGS_FILE_NAME

Default file name for storing arguments: .dia-args

FALSE_AS_STR

false as string

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

UUID

Unique universally identifier of this crate

VERSION

Crate version

Functions

parse

Parses from process' arguments

parse_file

Parses from file

parse_strings

Parses from an iterator of strings

read_line

Reads a line from stdin, trims and converts it to T