clap/clap_derive/examples/true_or_false.rs

//! How to parse `--foo=true --bar=false` and turn them into bool.

use clap::Parser;

fn true_or_false(s: &str) -> Result<bool, &'static str> {
    match s {
        "true" => Ok(true),
        "false" => Ok(false),
        _ => Err("expected `true` or `false`"),
    }
}

#[derive(Parser, Debug, PartialEq)]
struct Opt {
    // Default parser for `try_from_str` is FromStr::from_str.
    // `impl FromStr for bool` parses `true` or `false` so this
    // works as expected.
    #[clap(long, parse(try_from_str))]
    foo: bool,

    // Of course, this could be done with an explicit parser function.
    #[clap(long, parse(try_from_str = true_or_false))]
    bar: bool,

    // `bool` can be positional only with explicit `parse(...)` annotation
    #[clap(long, parse(try_from_str))]
    boom: bool,
}

fn main() {
    assert_eq!(
        Opt::parse_from(&["test", "--foo=true", "--bar=false", "true"]),
        Opt {
            foo: true,
            bar: false,
            boom: true
        }
    );
    // no beauty, only truth and falseness
    assert!(Opt::try_parse_from(&["test", "--foo=beauty"]).is_err());
}