#parser #duration

macro clap-duration

Macros for clap argument value_parse

8 releases

0.1.11 Dec 10, 2022
0.1.10 Dec 10, 2022

#174 in #duration

Download history 126/week @ 2024-06-24 179/week @ 2024-07-01 185/week @ 2024-07-08 225/week @ 2024-07-15 127/week @ 2024-07-22 257/week @ 2024-07-29 255/week @ 2024-08-05 199/week @ 2024-08-12 176/week @ 2024-08-19 208/week @ 2024-08-26 237/week @ 2024-09-02 130/week @ 2024-09-09 113/week @ 2024-09-16 146/week @ 2024-09-23 64/week @ 2024-09-30 214/week @ 2024-10-07

565 downloads per month
Used in 2 crates

Custom license

47KB
706 lines

Macros for clap argument value_parse

Macros to add duration value parsers for clap arguments, where the fields are compile-time checked

1. duration_range_value_parse
   To be used as the value_parse value on a clap arg 
2. assign_duration_range_validator
   Create a constant to be used on multiple arguments of a clap arg
3. duration_range_validator 
   Create a DurationHumanValidator with compile-time checking

Macro duration_range_value_parse

use clap::Parser;
use clap_duration::duration_range_value_parse;
use duration_human::{DurationHuman, DurationHumanValidator};

#[derive(Parser)]
struct SampleOptions {
    #[arg(
        long, default_value="666000ms",
        value_parser = duration_range_value_parse!(min: 10min, max: 1h)
    )]
    interval: DurationHuman,
}

let opts = SampleOptions::parse();
assert_eq!(format!("{:#}",opts.interval), format!("11min 6s"));
assert_eq!(opts.interval.to_string(), "666s".to_string())

Macro: assign_duration_range_validator

use clap::Parser;
use clap_duration::duration_range_value_parse;
use duration_human::{DurationHuman, DurationHumanValidator};

assign_duration_range_validator!( LIFETIME_RANGE = {default: 2h, min: 333s, max: 60day});

#[derive(Parser)]
struct ServerOptions {
    
    #[arg(
        long,
        help = format!("What lifetime will it have, between {}", LIFETIME_RANGE),
        default_value = LIFETIME_RANGE.default,
        value_parser = {|lifetime: &str|LIFETIME_RANGE.parse_and_validate(lifetime)}
    )]
    lifetime: DurationHuman,
}

 let opts = ServerOptions::parse();
 assert_eq!(format!("{:#}",opts.lifetime), format!("11min 6s"));
 assert_eq!(opts.lifetime.to_string(), "666s".to_string());

Dependencies

~3.5–5MB
~87K SLoC