RustCmdLine Repository

Parse console command line arguments

Quick Status

Version

1.1.0

Code status

No known defects

Demonstration code

yes

Documentation

yes

Test cases

coming soon

Static library

yes

Build requires

Rust installation

Planned design changes

Many

Fig 1. CmdLineParser Output

Concept:

RustCmdLine is a facility for parsing command line arguments. Here's a sample:

/P "." /p "rs,txt" /s /H /r "abc"

where:

/P "."          - path
/p "rs,txt" - file patterns
/s                 - recurse through directory tree rooted at path
/H                 - hide directories that don't contain target files
/r "abc"       - regular expression

The intent is that a program creates an instance of CmdLineParser, uses that to parse its command line, then passes it to any code that needs to know about an option.

Design:

This repository contains a library with a single user-defined type: CmdLineParser. It contains a vector of pattern strings (file extensions), a HashMap of option char and value, e.g., {P, "."}, and a help string. It provides methods for initiating the parse, returning pattern strings, returning options, and returning the path.

CmdLineParser implements the following methods and functions:

new() -> Self
Create new CmdLineParser which has an options hashmap, patterns vector, and help string.
parse(&self)
Builds internal options hashmap and patterns vector.
path(&self) -> String
Return value of relative root path, held in options map.
abs_path(&self) -> String
Return value of absolute root path, from canonicalized relative path.
set_path(&mut self, p:&str)
Replaces value of root path, held in options map.
set_regex(&mut self, re:&str)
Replaces value of regex string, held in options map.
get_regex(&mut self) -> &str
Retrieves value of regex string, held in options map.
default_options(&mut self)
Sets values of some of the options in options map.
contains_option(&self, opt:char) -> bool
returns true if options map contains key opt, else returns false.
add_option(&mut self, opt:char, val:&str)
Inserts option in options hashmap, adding key if it does not exist, else overriding previous value.
value(&self, opt:char) -> &str
Inserts option in options hashmap, adding key if it does not exist, else overriding previous value.
add_pattern(&mut self, patt:&str) -> &mut self
Inserts patt into patterns vector. Method can be chained.
patterns(&self) -> &CmdLinePatterns
Returns reference to vector of patterns.
options(&self) -> &Options
Returns reference to hashmap of options.
help(&self) -> &str
Returns default help string.
replace_help(&mut self, hs:&str)
Replace internal help string.

Operation:

See Test1.rs in examples folder for typical usage.

Build:

Download and, in a command prompt, cargo build or cargo run.

Status:

This is version 1.1.0
Tested on both Windows 10 and Ubuntu Linux