vsndrg/hyperfine
1
0 Fork 0
mirror of https://github.com/sharkdp/hyperfine.git synced 2026-11-01 08:50:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor Markdown table contents generation to generic Markup function

Browse Source
This commit is contained in:
Philipp Paulweber authored and David Peter committed 2022-05-15 21:37:40 +02:00
1 parent 23d9fe2595
commit 3b1fc32626
2 files changed
+50 -42
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

src/export/markdown.rs
+3 -42
View File
@@ -5,7 +5,7 @@ use crate::export::markup::markup_results_unit;
use crate::export::markup::markup_table_data;
use crate::export::markup::markup_table_line;
use crate::export::markup::MarkupType;
use crate::output::format::format_duration_value;
use crate::export::markup::markup_results;
use crate::util::units::Unit;
use anyhow::{anyhow, Result};
@@ -24,49 +24,10 @@ impl Exporter for MarkdownExporter {
));
}
// prepare table header strings
let notation = format!("[{}]", unit.short_name());
let mut data: Vec<Vec<_>> = vec![vec![
format!("Command"),
format!("Mean {}", notation),
format!("Min {}", notation),
format!("Max {}", notation),
format!("Relative"),
]];
for entry in entries.unwrap() {
let measurement = &entry.result;
// prepare data row strings
let cmd_str = measurement.command.replace("|", "\\|");
let mean_str = format_duration_value(measurement.mean, Some(unit)).0;
let stddev_str = if let Some(stddev) = measurement.stddev {
format!(" ± {}", format_duration_value(stddev, Some(unit)).0)
} else {
"".into()
};
let min_str = format_duration_value(measurement.min, Some(unit)).0;
let max_str = format_duration_value(measurement.max, Some(unit)).0;
let rel_str = format!("{:.2}", entry.relative_speed);
let rel_stddev_str = if entry.is_fastest {
"".into()
} else if let Some(stddev) = entry.relative_speed_stddev {
format!(" ± {:.2}", stddev)
} else {
"".into()
};
// prepare table row entries
data.push(vec![
format!("`{}`", cmd_str),
format!("{}{}", mean_str, stddev_str),
format!("{}", min_str),
format!("{}", max_str),
format!("{}{}", rel_str, rel_stddev_str),
])
}
let kind = MarkupType::Markdown;
let data = markup_results( &kind, &entries.unwrap(), unit );
let head: &Vec<String> = data.first().unwrap();
let tail: &[Vec<String>] = &data[1..];
let kind = MarkupType::Markdown;
// emit header
let mut table = markup_table_data(&kind, head);
src/export/markup.rs
+47
View File
@@ -1,6 +1,7 @@
use crate::benchmark::benchmark_result::BenchmarkResult;
use crate::output::format::format_duration_value;
use crate::util::units::Unit;
use crate::benchmark::relative_speed::BenchmarkResultWithRelativeSpeed;
#[derive(Clone)]
pub enum MarkupType {
@@ -20,6 +21,52 @@ pub fn markup_table_line(kind: &MarkupType, size: usize) -> String {
};
}
pub fn markup_results(kind: &MarkupType, entries: &[BenchmarkResultWithRelativeSpeed], unit: Unit) -> Vec<Vec<String>> {
// prepare table header strings
let notation = format!("[{}]", unit.short_name());
let mut data: Vec<Vec<_>> = vec![vec![
format!("Command"),
format!("Mean {}", notation),
format!("Min {}", notation),
format!("Max {}", notation),
format!("Relative"),
]];
for entry in entries {
let measurement = &entry.result;
// prepare data row strings
let cmd_str = measurement.command.replace("|", "\\|");
let mean_str = format_duration_value(measurement.mean, Some(unit)).0;
let stddev_str = if let Some(stddev) = measurement.stddev {
format!(" ± {}", format_duration_value(stddev, Some(unit)).0)
} else {
"".into()
};
let min_str = format_duration_value(measurement.min, Some(unit)).0;
let max_str = format_duration_value(measurement.max, Some(unit)).0;
let rel_str = format!("{:.2}", entry.relative_speed);
let rel_stddev_str = if entry.is_fastest {
"".into()
} else if let Some(stddev) = entry.relative_speed_stddev {
format!(" ± {:.2}", stddev)
} else {
"".into()
};
// prepare table row entries
data.push(vec![
match kind {
MarkupType::Markdown => format!( "`{}`", cmd_str ),
},
format!("{}{}", mean_str, stddev_str),
format!("{}", min_str),
format!("{}", max_str),
format!("{}{}", rel_str, rel_stddev_str),
])
}
return data;
}
pub fn markup_results_unit(results: &[BenchmarkResult], unit: Option<Unit>) -> Unit {
return if let Some(unit) = unit {
// Use the given unit for all entries.