-
Notifications
You must be signed in to change notification settings - Fork 258
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added benchmarks for the list widget (render and render half scrolled)
- Loading branch information
1 parent
6ad4bd4
commit 664fb4c
Showing
2 changed files
with
77 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
use criterion::{criterion_group, criterion_main, BatchSize, Bencher, BenchmarkId, Criterion}; | ||
use ratatui::{ | ||
buffer::Buffer, | ||
layout::Rect, | ||
widgets::{List, ListItem, ListState, StatefulWidget, Widget}, | ||
}; | ||
|
||
/// Benchmark for rendering a list. | ||
/// It only benchmarks the render with a different amount of items. | ||
pub fn list(c: &mut Criterion) { | ||
let mut group = c.benchmark_group("list"); | ||
|
||
for line_count in [64, 2048, 16384] { | ||
let lines: Vec<ListItem> = (0..line_count) | ||
.map(|_| ListItem::new(fakeit::words::sentence(10))) | ||
.collect(); | ||
|
||
// Render default list | ||
group.bench_with_input( | ||
BenchmarkId::new("render", line_count), | ||
&List::new(lines.clone()), | ||
render, | ||
); | ||
|
||
// Render with an offset to the middle of the list and a selected item | ||
group.bench_with_input( | ||
BenchmarkId::new("render_scroll_half", line_count), | ||
&List::new(lines.clone()).highlight_symbol(">>"), | ||
|b, list| { | ||
render_stateful( | ||
b, | ||
list, | ||
ListState::default() | ||
.with_offset(line_count / 2) | ||
.with_selected(Some(line_count / 2)), | ||
) | ||
}, | ||
); | ||
} | ||
|
||
group.finish(); | ||
} | ||
|
||
/// render the list into a common size buffer | ||
fn render(bencher: &mut Bencher, list: &List) { | ||
let mut buffer = Buffer::empty(Rect::new(0, 0, 200, 50)); | ||
// We use `iter_batched` to clone the value in the setup function. | ||
// See https://github.com/ratatui-org/ratatui/pull/377. | ||
bencher.iter_batched( | ||
|| list.to_owned(), | ||
|bench_list| { | ||
Widget::render(bench_list, buffer.area, &mut buffer); | ||
}, | ||
BatchSize::LargeInput, | ||
) | ||
} | ||
|
||
/// render the list into a common size buffer with a state | ||
fn render_stateful(bencher: &mut Bencher, list: &List, mut state: ListState) { | ||
let mut buffer = Buffer::empty(Rect::new(0, 0, 200, 50)); | ||
// We use `iter_batched` to clone the value in the setup function. | ||
// See https://github.com/ratatui-org/ratatui/pull/377. | ||
bencher.iter_batched( | ||
|| list.to_owned(), | ||
|bench_list| { | ||
StatefulWidget::render(bench_list, buffer.area, &mut buffer, &mut state); | ||
}, | ||
BatchSize::LargeInput, | ||
) | ||
} | ||
|
||
criterion_group!(benches, list); | ||
criterion_main!(benches); |