Crate zigarg[][src]

Expand description

zigarg is a very light argument parser written fully in Rust. It’s not dependent on any third party libraries other than those that Rust already comes with. It lacks many features, like help generation, but enough to be suitable for a lot of applications. It’s also good for educational purposes as it isn’t very complex.

I decided to publish the library after using it on several private CLI applications I made. I may add additional features in the future if I find it useful for my own projects as well.

Quickstart

Add zigarg to Cargo.toml as a dependency

[dependencies]
zigarg = "1.1.0"

Capture user’s arguments by adding the code below, after you have added zigarg to your dependencies:

use zigarg::Arguments;
let arguments = Arguments::new();

Use the struct returned from zigarg::new() to perform different actions like the examples below

//Check if there are arguments provided by the user other than your program's name
let has_arguments = arguments.has_args();
//Check if the arguments provided by the user has a certain flag
let exist = arguments.exist("-q");
//Measure the number of arguments provided the user
let arguments_number = arguments.len();
//Get an argument from the arguments provided by the user via index number
let argument = arguments.get(1);

Check documentation of the Arguments struct below for more…

Structs

Struct that contains the arguments provided by the user