Expand description
§use-option
Primitive CLI option key/value types for RustUse.
CliOption is a command-line option primitive, not Rust’s Option<T>. It stores a validated option name and an owned value for forms such as --key=value and --key value.
§Example
use use_option::{CliOption, split_equals_token};
let from_equals = split_equals_token("--color=auto")?;
let from_pair = CliOption::from_name_value("format", "json")?;
assert_eq!(from_equals.name().as_str(), "color");
assert_eq!(from_pair.to_equals_token(), "--format=json");§Scope
This crate does not implement argument parsing, option registries, defaults, type conversion, or parser DSLs.
Modules§
- prelude
- Commonly used CLI option primitives.
Structs§
- CliOption
- A primitive command-line key/value option.
- CliOption
Name - A validated CLI option name without a leading
--. - Option
Value - An owned CLI option value.
Enums§
- CliOption
Error - Errors for primitive CLI option construction.
- Option
Name Error - Validation errors for CLI option names.
Functions§
- is_
valid_ option_ name - Returns whether
nameis a valid primitive CLI option name. - split_
equals_ token - Splits a token like
--key=valueinto a primitive CLI option.