docopticon 0.1.2

An argument-parser based on the obligatory help-text
Documentation
  • Coverage
  • 31.58%
    6 out of 19 items documented0 out of 0 items with examples
  • Size
  • Source code size: 90.05 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 3.56 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 10s Average build duration of successful builds.
  • all releases: 10s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Repository
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • CuriouslyCurious

docopticon

docopticon is yet-another argument parsing library for Rust, however, this one relies upon constructing the argument tree from the actual help text that every command-line program should have. This is instead of generating the help for every argument.

Example

use docopticon;
???
profit

TODO

Stuff I need to write:

Parsers

  • usage-option
  • usage-parameter
  • usage-optional-parameters () {} []
  • default-in-description () {} []
  • stdin - and parameter flag --
  • slices / ranges of values a..b
  • multiple choice parameters

Argument Tree

  • option levels
  • associated function?

Features

  • Compile-time generation of an argument tree from a given Usage string slice.
  • no_std - only depends on libc and Rust's core library.
  • Does not require an allocator - could potentially work on embedded targets.
  • Also includes a set of functions to allow for XDG-dirs compliant saving/loading of configuration, state and data files.

Docopt

docopt is a standard that is vaguely defined by the docopt team behind the initial Python library. This library attempts to be more rigorous in the definition of the core protocol but still allowing for some flexibility when it comes to how you write your Usage: text.

Credits