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 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
use std::error::Error; use std::fmt; /// Command line argument parser error types #[derive(PartialEq, Debug)] pub enum ClapErrorType { /// Error occurs when some possible values were set, but clap found unexpected value /// /// /// # Example /// /// ```no_run /// # use clap::{App, Arg}; /// let result = App::new("myprog") /// .arg(Arg::with_name("debug").index(1) /// .possible_value("fast") /// .possible_value("slow")) /// .get_matches_from_safe(vec!["", "other"]); /// ``` InvalidValue, /// Error occurs when clap found unexpected flag or option /// /// /// # Example /// /// ```no_run /// # use clap::{App, Arg}; /// let result = App::new("myprog") /// .arg(Arg::from_usage("-f, --flag 'some flag'")) /// .get_matches_from_safe(vec!["", "--other"]); /// ``` InvalidArgument, /// Error occurs when clap found unexpected subcommand /// /// /// # Example /// /// ```no_run /// # use clap::{App, Arg, SubCommand}; /// let result = App::new("myprog") /// .subcommand(SubCommand::with_name("conifg") /// .about("Used for configuration") /// .arg(Arg::with_name("config_file") /// .help("The configuration file to use") /// .index(1))) /// .get_matches_from_safe(vec!["", "other"]); /// ``` InvalidSubcommand, /// Error occurs when option does not allow empty values but some was found /// /// /// # Example /// /// ```no_run /// # use clap::{App, Arg}; /// let result = App::new("myprog") /// .arg(Arg::with_name("debug") /// .empty_values(false)) /// .arg(Arg::with_name("color")) /// .get_matches_from_safe(vec!["", "--debug", "--color"]); /// ``` EmptyValue, /// Parser inner error OptionError, /// Parser inner error ArgumentError, /// Parser inner error ValueError, /// Error occurs when argument got more values then were expected /// /// /// # Example /// /// ```no_run /// # use clap::{App, Arg}; /// let result = App::new("myprog") /// .arg(Arg::with_name("debug").index(1) /// .max_values(2)) /// .get_matches_from_safe(vec!["", "too", "much", "values"]); /// ``` TooMuchValues, /// Error occurs when argument got less values then were expected /// /// /// # Example /// /// ```no_run /// # use clap::{App, Arg}; /// let result = App::new("myprog") /// .arg(Arg::with_name("debug").index(1) /// .min_values(3)) /// .get_matches_from_safe(vec!["", "too", "few"]); /// ``` TooFewValues, /// Error occurs when clap find two ore more conflicting arguments /// /// /// # Example /// /// ```no_run /// # use clap::{App, Arg}; /// let result = App::new("myprog") /// .arg(Arg::with_name("debug") /// .conflicts_with("color")) /// .get_matches_from_safe(vec!["", "--debug", "--color"]); /// ``` ArgumentConflict, /// Error occurs when one or more required arguments missing /// /// /// # Example /// /// ```no_run /// # use clap::{App, Arg}; /// let result = App::new("myprog") /// .arg(Arg::with_name("debug") /// .required(true)) /// .get_matches_from_safe(vec![""]); /// ``` MissingRequiredArgument, /// Error occurs when required subcommand missing /// /// /// # Example /// /// ```no_run /// # use clap::{App, Arg, AppSettings, SubCommand}; /// let result = App::new("myprog") /// .setting(AppSettings::SubcommandRequired) /// .subcommand(SubCommand::with_name("conifg") /// .about("Used for configuration") /// .arg(Arg::with_name("config_file") /// .help("The configuration file to use") /// .index(1))) /// .get_matches_from_safe(vec![""]); /// ``` MissingSubcommand, /// Error occurs when clap find argument while is was not expecting any /// /// /// # Example /// /// ```no_run /// # use clap::{App}; /// let result = App::new("myprog") /// .get_matches_from_safe(vec!["", "--arg"]); /// ``` UnexpectedArgument, /// Error occurs when argument was used multiple times and was not set as multiple. /// /// /// # Example /// /// ```no_run /// # use clap::{App, Arg}; /// let result = App::new("myprog") /// .arg(Arg::with_name("debug") /// .multiple(false)) /// .get_matches_from_safe(vec!["", "--debug", "--debug"]); /// ``` UnexpectedMultipleUsage, } /// Command line argument parser error #[derive(Debug)] pub struct ClapError { /// Formated error message pub error: String, /// Command line argument parser error type pub error_type: ClapErrorType, } impl Error for ClapError { fn description(&self) -> &str { &*self.error } } impl fmt::Display for ClapError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self.error) } }