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
use crate::{ColumnInfo, Comparison, Formatter, TimeUnit};
use flexstr::{flex_fmt, FlexStr, IntoFlex, ToCase, ToFlexStr};
const CT_URL: &str = "https://github.com/nu11ptr/criterion-table";
const FIRST_COL_EXTRA_WIDTH: usize = "**``**".len();
const USED_EXTRA_WIDTH: usize = "() ``****XX".len();
pub struct GFMFormatter;
impl GFMFormatter {
fn pad(buffer: &mut String, ch: char, max_width: usize, written: usize) {
let remaining = max_width - written;
for _ in 0..=remaining {
buffer.push(ch);
}
}
#[inline]
fn encode_link(s: &FlexStr) -> FlexStr {
s.replace(' ', "-").into_flex().to_lower()
}
}
impl Formatter for GFMFormatter {
fn start(&mut self, buffer: &mut String, comment: Option<&FlexStr>, tables: &[&FlexStr]) {
buffer.push_str("# Benchmarks\n\n");
if let Some(comments) = comment {
buffer.push_str(comments);
buffer.push('\n');
}
for &table in tables {
buffer.push_str("- [");
buffer.push_str(table);
buffer.push_str("](#");
buffer.push_str(&Self::encode_link(table));
buffer.push_str(")\n");
}
buffer.push('\n');
}
fn end(&mut self, buffer: &mut String) {
buffer.push_str("Made with [criterion-table](");
buffer.push_str(CT_URL);
buffer.push_str(")\n");
}
fn start_table(
&mut self,
buffer: &mut String,
name: &FlexStr,
comment: Option<&FlexStr>,
columns: &[ColumnInfo],
) {
buffer.push_str("## ");
buffer.push_str(name);
buffer.push_str("\n\n");
if let Some(comments) = comment {
buffer.push_str(comments);
buffer.push('\n');
}
buffer.push_str("| ");
let first_col_max_width = columns[0].max_width + FIRST_COL_EXTRA_WIDTH;
Self::pad(buffer, ' ', first_col_max_width, 0);
for column in &columns[1..] {
let max_width = column.max_width + USED_EXTRA_WIDTH;
buffer.push_str("| `");
buffer.push_str(&column.name);
buffer.push('`');
Self::pad(buffer, ' ', max_width, column.name.chars().count() + 2);
}
buffer.push_str(" |\n");
buffer.push_str("|:");
Self::pad(buffer, '-', first_col_max_width, 0);
for column in &columns[1..] {
let max_width = column.max_width + USED_EXTRA_WIDTH;
buffer.push_str("|:");
Self::pad(buffer, '-', max_width, 0);
}
buffer.push_str(" |\n");
}
fn end_table(&mut self, buffer: &mut String) {
buffer.push('\n');
}
fn start_row(&mut self, buffer: &mut String, name: &FlexStr, max_width: usize) {
let written = if !name.is_empty() {
buffer.push_str("| **`");
buffer.push_str(name);
buffer.push_str("`**");
name.chars().count() + FIRST_COL_EXTRA_WIDTH
} else {
buffer.push_str("| ");
0
};
Self::pad(buffer, ' ', max_width + FIRST_COL_EXTRA_WIDTH, written);
}
fn end_row(&mut self, buffer: &mut String) {
buffer.push_str(" |\n");
}
fn used_column(
&mut self,
buffer: &mut String,
time: TimeUnit,
compare: Comparison,
max_width: usize,
) {
let (time_str, speedup_str) = (time.to_flex_str(), compare.to_flex_str());
let data = if speedup_str.contains("faster") {
flex_fmt!("`{time_str}` (✅ **{speedup_str}**)")
} else if speedup_str.contains("slower") {
flex_fmt!("`{time_str}` (❌ *{speedup_str}*)")
} else {
flex_fmt!("`{time_str}` ({speedup_str})")
};
buffer.push_str("| ");
buffer.push_str(&data);
let max_width = max_width + USED_EXTRA_WIDTH;
Self::pad(buffer, ' ', max_width, data.chars().count());
}
fn unused_column(&mut self, buffer: &mut String, max_width: usize) {
buffer.push_str("| ");
let data = "`N/A`";
buffer.push_str(data);
Self::pad(
buffer,
' ',
max_width + USED_EXTRA_WIDTH,
data.chars().count(),
);
}
}