flagtory/
lib.rs

1
2//! a simple library to make command line flags.
3//! This library provides the user to make their own command line flags easily.
4//! though there are some limitations on how to create a flag that is parsable by the
5//! [`flags::Flags::parse`] method.
6//! 
7//! - **if the flag name has only 1 character, the user must use a one dash flag**:
8//!     e.g: -w, -p, -v.
9//! - **if the flag name has more than 1 character, the user must use a double dash flag**
10//!     e.g: --bin, --lib, --http.
11//! - **if the flag name has more than 1 character and has a space delimiter, the delimeter must be changed into a dash**
12//!     e.g: --allow-net.
13//!
14//!     flagtory will assume that if you register a flag using the [`flags::Flags::add`] method and
15//!     the name of the flag is 1 characters long it will match to the user provided flags that has
16//!     one dash flag, same as the double dash flag it the name of the flag is more than a
17//!     character.
18
19mod flags;
20mod traits;
21mod element;
22
23pub use traits::Flag;
24pub use element::Element;
25pub use flags::Flags;