7 releases

0.1.6 Sep 2, 2024
0.1.5 Sep 2, 2024
0.1.4 Aug 30, 2024

#343 in Command-line interface

MIT license

6KB

argfetch

command line argument parser for rust.

about

argfetch returns a string that has all the args separated by spaces
if the flag doesnt exist, or there is no value it will return an empty string

numbers in () means it is a reference or is being referenced in a diffrent part of the code ex: line of code // (0) this does something (0)

usage

run:

$ cargo add argfetch

to use argfetch you have to pass flag you want to get the args from, and the vector of arguments

examples

in this example, we will be fetching the d flag:

use argfetch::fetch;

fn main() {
  let args: Vec<String> = env::args().collect(); // get the arguments
  let args_value = fetch(String::from("-d"), &args); // the flag (-a in this example) has to be a string, and the args have to be passed as a reference

  if args_value.is_empty() { // check if its empty, which means the flag is missing, or has no value
    println!("the flag is missing, or is empty");
    std::process::exit(1); // exit
  }

  println!("{}", args_value);
}

running this code would output:

$ argfetch-example -d "hi" -a test -e some args
hi
$

instead if you wanted to fetch the a flag, you would do:

use argfetch::fetch;

fn main() {
  let args: Vec<String> = env::args().collect();
  let args_value = fetch(String::from("-a"), &args);

  if args_value.is_empty() {
    println!("the flag is missing, or is empty");
    std::process::exit(1);
  }
  
  println!("{}", args_value);
}

then the output would be:

$ argfetch-example -d "hi" -a test -e some args
test
$

and for getting the e flag:

use argfetch::fetch;

fn main() {
  let args: Vec<String> = env::args().collect();
let a_args_value = fetch(String::from("-e"), &args);

  if a_args_value.is_empty() {
    println!("the flag is missing, or is empty");
    std::process::exit(1);
  }

  println!("{}", args_value);
}

then run:

$ argfetch-example -d "hi" -a test -e some args
some args
$

however, running it with no e flag, will output:

$ argfetch-example -d "hi" -a test
the flag is missing, or is empty
$

you can also pass the longer version of the argument, or any other arg, but its not recommended to mix arguments, because theres no indicator on which one it is, so only use arg that mean the same thing ex: -a and --attribute, both are for the attribute flag

use argfetch::fetch;

fn main() {
  let args: Vec<String> = env::args().collect();
  let a_args_value = fetch(String::from("-a --attribute"), &args); // separate all args with a space (1)

  if a_args_value.is_empty() {
    println!("the flag is missing, or is empty");
    std::process::exit(1);
  }

  println!("{}", args_value);
}

then you can run:

$ argfetch-example -a test
test
$

or:

$ argfetch-example --attribute test
test
$

but if both are present, it will get the one that is first in the string where the function is called (1)

$ argfetch-example -a hello --attribute test
hello
$  argfetch-example --attribute test -a hello
hello
$

No runtime deps