Expand description
§use-flag
Primitive short, long, and boolean flag types for CLI-adjacent Rust code.
use-flag validates flag names and stores flag intent. It does not scan an argv stream, expand combined short flags, define negation policy, or implement a parser.
§Example
use use_flag::{BooleanFlag, Flag};
let flag = Flag::try_from_token("--verbose")?;
let verbose = BooleanFlag::enabled(flag);
assert!(verbose.is_enabled());
assert_eq!(verbose.flag().to_token(), "--verbose");§Scope
Use this crate for small flag vocabulary. Use a parser framework when you need parsing, validation across multiple tokens, or derived command definitions.
Modules§
- prelude
- Commonly used flag primitives.
Structs§
- Boolean
Flag - A flag paired with a boolean state.
- Long
Flag - A long flag name such as
verbosefor--verbose. - Short
Flag - A one-character short flag such as
-v.
Enums§
- Flag
- A primitive flag token.
- Flag
Name Error - Validation errors for primitive flag names and tokens.
Functions§
- is_
valid_ long_ flag_ name - Returns whether
nameis valid for a long flag without the leading--. - is_
valid_ short_ flag - Returns whether
nameis valid for a short flag.