Rename parameter to '--parameter-scan'

src/hyperfine/error.rs

@@ -3,35 +3,35 @@ use std::error::Error;
 use std::fmt;
 
 #[derive(Debug)]
-pub enum ParameterRangeError {
+pub enum ParameterScanError {
     ParseIntError(num::ParseIntError),
     EmptyRange,
     TooLarge,
 }
 
-impl ParameterRangeError {
+impl ParameterScanError {
     fn __description(&self) -> &str {
         match *self {
-            ParameterRangeError::ParseIntError(ref e) => e.description(),
+            ParameterScanError::ParseIntError(ref e) => e.description(),
-            ParameterRangeError::EmptyRange => "Empty parameter range",
+            ParameterScanError::EmptyRange => "Empty parameter range",
-            ParameterRangeError::TooLarge => "Parameter range is too large",
+            ParameterScanError::TooLarge => "Parameter range is too large",
         }
     }
 }
 
-impl From<num::ParseIntError> for ParameterRangeError {
+impl From<num::ParseIntError> for ParameterScanError {
-    fn from(e: num::ParseIntError) -> ParameterRangeError {
+    fn from(e: num::ParseIntError) -> ParameterScanError {
-        ParameterRangeError::ParseIntError(e)
+        ParameterScanError::ParseIntError(e)
     }
 }
 
-impl fmt::Display for ParameterRangeError {
+impl fmt::Display for ParameterScanError {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         write!(f, "{}", self.__description())
     }
 }
 
-impl Error for ParameterRangeError {
+impl Error for ParameterScanError {
     fn description(&self) -> &str {
         self.__description()
     }

src/main.rs

@@ -43,7 +43,7 @@ use hyperfine::types::{BenchmarkResult, CmdFailureAction, Command, HyperfineOpti
                        OutputStyleOption};
 use hyperfine::benchmark::{mean_shell_spawning_time, run_benchmark};
 use hyperfine::export::{ExportManager, ExportType};
-use hyperfine::error::ParameterRangeError;
+use hyperfine::error::ParameterScanError;
 
 /// Print error message to stderr and terminate
 pub fn error(message: &str) -> ! {
@@ -65,21 +65,21 @@ fn run(commands: &Vec<Command>, options: &HyperfineOptions) -> io::Result<Vec<Be
     Ok(timing_results)
 }
 
-/// A function to read the `--parameter-range` arguments
+/// A function to read the `--parameter-scan` arguments
-fn parse_parameter_range_args<'a>(
+fn parse_parameter_scan_args<'a>(
     mut vals: clap::Values<'a>,
-) -> Result<(&'a str, Range<i32>), ParameterRangeError> {
+) -> Result<(&'a str, Range<i32>), ParameterScanError> {
     let param_name = vals.next().unwrap();
     let param_min: i32 = vals.next().unwrap().parse()?;
     let param_max: i32 = vals.next().unwrap().parse()?;
 
     const MAX_PARAMETERS: i32 = 100000;
     if param_max - param_min > MAX_PARAMETERS {
-        return Err(ParameterRangeError::TooLarge);
+        return Err(ParameterScanError::TooLarge);
     }
 
     if param_max < param_min {
-        return Err(ParameterRangeError::EmptyRange);
+        return Err(ParameterScanError::EmptyRange);
     }
 
     return Ok((param_name, param_min..(param_max + 1)));
@@ -163,9 +163,9 @@ fn main() {
                 .help("Ignore non-zero exit codes."),
         )
         .arg(
-            Arg::with_name("parameter-range")
+            Arg::with_name("parameter-scan")
-                .long("parameter-range")
+                .long("parameter-scan")
-                .short("r")
+                .short("P")
                 .help(
                     "Perform benchmark runs for each value in the range MIN..MAX. Replaces the \
                      string '{VAR}' in each command by the current parameter value.",
@@ -249,8 +249,8 @@ fn main() {
 
     let command_strings = matches.values_of("command").unwrap();
 
-    let commands = if let Some(args) = matches.values_of("parameter-range") {
+    let commands = if let Some(args) = matches.values_of("parameter-scan") {
-        match parse_parameter_range_args(args) {
+        match parse_parameter_scan_args(args) {
             Ok((param_name, param_range)) => {
                 let mut commands = vec![];
                 let command_strings = command_strings.collect::<Vec<&str>>();