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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
use std::process; use std::error::Error; use std::fmt; /// Command line argument parser error types #[derive(PartialEq, Debug, Copy, Clone)] pub enum ClapErrorType { /// Error occurs when some possible values were set, but clap found unexpected value /// /// /// # Examples /// /// ```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 /// /// /// # Examples /// /// ```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 /// /// /// # Examples /// /// ```no_run /// # use clap::{App, Arg, SubCommand}; /// let result = App::new("myprog") /// .subcommand(SubCommand::with_name("config") /// .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 /// /// /// # Examples /// /// ```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, /// Option fails validation of a custom validator ValueValidationError, /// Parser inner error ArgumentError, /// Error occurs when an application got more arguments then were expected /// /// /// # Examples /// /// ```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"]); /// ``` TooManyArgs, /// Error occurs when argument got more values then were expected /// /// /// # Examples /// /// ```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"]); /// ``` TooManyValues, /// Error occurs when argument got less values then were expected /// /// /// # Examples /// /// ```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 argument got a different number of values then were expected /// /// /// # Examples /// /// ```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"]); /// ``` WrongNumValues, /// Error occurs when clap find two ore more conflicting arguments /// /// /// # Examples /// /// ```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 /// /// /// # Examples /// /// ```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 /// /// /// # Examples /// /// ```no_run /// # use clap::{App, Arg, AppSettings, SubCommand}; /// let result = App::new("myprog") /// .setting(AppSettings::SubcommandRequired) /// .subcommand(SubCommand::with_name("config") /// .about("Used for configuration") /// .arg(Arg::with_name("config_file") /// .help("The configuration file to use") /// .index(1))) /// .get_matches_from_safe(vec![""]); /// ``` MissingSubcommand, /// Occurs when no argument or subcommand has been supplied and /// `AppSettings::ArgRequiredElseHelp` was used /// /// /// # Examples /// /// ```no_run /// # use clap::{App, Arg, AppSettings, SubCommand}; /// let result = App::new("myprog") /// .setting(AppSettings::ArgRequiredElseHelp) /// .subcommand(SubCommand::with_name("config") /// .about("Used for configuration") /// .arg(Arg::with_name("config_file") /// .help("The configuration file to use") /// .index(1))) /// .get_matches_from_safe(vec![""]); /// ``` MissingArgumentOrSubcommand, /// Error occurs when clap find argument while is was not expecting any /// /// /// # Examples /// /// ```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. /// /// /// # Examples /// /// ```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, /// Error occurs when argument contains invalid unicode characters /// /// /// # Examples /// /// ```no_run /// # use clap::{App, Arg}; /// # use std::os::unix::ffi::OsStringExt; /// # use std::ffi::OsString; /// let result = App::new("myprog") /// .arg(Arg::with_name("debug") /// .short("u") /// .takes_value(true)) /// .get_matches_from_safe(vec![OsString::from_vec(vec![0x20]), /// OsString::from_vec(vec![0xE9])]); /// assert!(result.is_err()); /// ``` InvalidUnicode, /// Not a true 'error' as it means `--help` or similar was used. The help message will be sent /// to `stdout` unless the help is displayed due to an error (such as missing subcommands) at /// which point it will be sent to `stderr` /// /// /// # Examples /// /// ```no_run /// # use clap::{App, Arg}; /// # use clap::ClapErrorType; /// let result = App::new("myprog") /// .get_matches_from_safe(vec!["", "--help"]); /// assert!(result.is_err()); /// assert_eq!(result.unwrap_err().error_type, ClapErrorType::HelpDisplayed); /// ``` HelpDisplayed, /// Not a true 'error' as it means `--version` or similar was used. The message will be sent /// to `stdout` /// /// /// # Examples /// /// ```no_run /// # use clap::{App, Arg}; /// # use clap::ClapErrorType; /// let result = App::new("myprog") /// .get_matches_from_safe(vec!["", "--version"]); /// assert!(result.is_err()); /// assert_eq!(result.unwrap_err().error_type, ClapErrorType::VersionDisplayed); /// ``` VersionDisplayed, /// Represents an internal error, please consider filing a bug report if this happens! InternalError, } /// 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 ClapError { /// Prints the error to `stderr` and exits with a status of `1` pub fn exit(&self) -> ! { if self.use_stderr() { wlnerr!("{}", self.error); process::exit(1); } println!("{}", self.error); process::exit(0); } fn use_stderr(&self) -> bool { match self.error_type { ClapErrorType::HelpDisplayed | ClapErrorType::VersionDisplayed => false, _ => true } } } 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) } }