aboutsummaryrefslogtreecommitdiff
path: root/clap/examples/15_custom_validator.rs
blob: a5c0d42f5ec7a88d1db6d4fadda3c23a09e8ed6c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
extern crate clap;

use clap::{App, Arg};

fn main() {
    // You can define a function (or a closure) to use as a validator to argument values. The
    // function must accept a String and return Result<(), String> where Err(String) is the message
    // displayed to the user.

    let matches = App::new("myapp")
                        // Application logic goes here...
                        .arg(Arg::with_name("input")
                                     .help("the input file to use")
                                     .index(1)
                                     .required(true)
                                     // You can pass in a closure, or a function
                                     .validator(is_png))
                        .get_matches();

    // Here we can call .unwrap() because the argument is required.
    println!("The .PNG file is: {}", matches.value_of("input").unwrap());
}

fn is_png(val: String) -> Result<(), String> {
    // val is the argument value passed in by the user
    // val has type of String.
    if val.ends_with(".png") {
        Ok(())
    } else {
        // clap automatically adds "error: " to the beginning
        // of the message.
        Err(String::from("the file format must be png."))
    }
    // Of course, you can do more complicated validation as
    // well, but for the simplicity, this example only checks
    // if the value passed in ends with ".png" or not.
}