https://github.com/kixunil/parse_arg

Rust traits and implementations for parsing command-line arguments.
https://github.com/kixunil/parse_arg

Last synced: 3 months ago
JSON representation

Rust traits and implementations for parsing command-line arguments.

• Host: GitHub
• URL: https://github.com/kixunil/parse_arg
• Owner: Kixunil
• Created: 2018-11-05T17:53:44.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-09-05T12:01:27.000Z (over 5 years ago)
• Last Synced: 2024-04-25T19:01:09.617Z (9 months ago)
• Language: Rust
• Size: 8.79 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Parse arg

=========

Traits and implementations for parsing command-line arguments.

About

-----

This crate provides traits and implementations for parsing command-line arguments.

The core of the crate is `ParseArg` trait. It works much like `FromStr` trait, but with

these differences:

* It operates on `&OsStr` instead of `&str`, thus allowing wider range of possible inputs.

* It provides `parse_owned_arg()` method which can be specialized to avoid allocations.

* It requires the implementor to provide `describe_type()` to print human-readable description.

  of expected input.

* It requires the error type to implement `Display` in order to enable user-friendly interface.

Further, the crate provides `ParseArgFromStr` trait, which causes any type implementing it to

auto-implement `ParseArg` trait. This is handy when implementing `ParseArg` for types that

already have `FromStr` implemented, so that boilerplate is reduced.

Since matching both `--foo VAL` and `--foo=VAL` arguments is common and it's not an easy task to

implement on top of `OsStr`, due to limitation of `std`, this crate also provides a function to

match and parse such arguments.

Further, since many programs support `-xVAL` style parameters and short switches grouped into a

single argument, which isn't easy to achieve using `OsStr` either, this crate provides a helper

for this too.

Contibutions

------------

I will merge new implementations liberally, provided these conditions are met:

* The type is either in `std` or in another crate which is added as an *optional* dependency.

* The description of the type is gramatically correct, readable explanation of the type, that

  can be appended to the string "The input must be " without sounding unnatural.

* The user must be able to know how to formt the input based on the description without any

  googling. In case of doubt provide more precise description in parentheses.

* Your contribution is licensed under MIT or MITNFA license.

License

-------

MITNFA