argin

Crates.ioargin
lib.rsargin
version0.1.0
sourcesrc
created_at2023-09-11 19:33:31.717606
updated_at2023-09-11 19:33:31.717606
descriptionA very simple command line argument parser
homepage
repositoryhttps://github.com/proxin187/argin
max_upload_size
id970043
size5,040
Prox (proxin187)

documentation

README

Stars Forks

Argin

A very simple command line argument parser.

  • Description
  • Getting Started
  • Help
  • Authors
  • Versions
  • License
  • Description

    Argin is a very simple library with only 5 functions but its still able to do all the expected argument parsing

    Getting Started

    Usage

    Example

    ./program [file] [-format (name)] would look like this:

    use argin::Argin;
    
    let arg = Argin::new();
    arg.add_positional_arg();
    arg.add_value("-format");
    let args = arg.parse();
    
    let file = args.pos_arg.get(0).unwrap();
    let format = arg.values.get("-format").unwrap();
    

    Functions

    new:

    pub fn new() -> Argin
    

    add_flag:

    pub fn add_flag(&mut self, flag: &str)
    

    add_value:

    pub fn add_value(&mut self, name: &str)
    

    add_positional_arg:

    pub fn add_positional_arg(&mut self)
    

    parse:

    pub fn parse(&self) -> Argin
    

    Help

    Its common to forget .parse() at the end

    Authors

    Contributors names and contact info

    Versions

    • 0.1
      • Initial Release

    License

    Currently there is no license, this may change in the future

    Commit count: 4

    cargo fmt