killercup / killercup/convey

Create benchmarks to measure overhead of this against `println!`

Open
#20 2 comments 0 reactions 0 assignees View on GitHub
good first issue help wanted
Dominant language
Rust
Stars
38
Forks
6
PR merge metrics
No merged PRs in 30d

Description

This crate does some stuff on top of just writing to some output. We should write some benchmarks to figure out the performance cost of that.

- Write bechmark to measure time to print _n_ lines of example text (`output.print("lorem ipsum")` vs `println!("lorem ipsum")`)
- [ ] to stdout using the "human" target
- [ ] to stdout using the "human" target's test helper
- [ ] to a file using the "json target
- [ ] print to stdout using `println!`
- [ ] print to stdout using `writeln!` on a locked stdout
- [ ] print to stdout using `writeln!` on a buffered stdout

Contributor guide

Open the contributing guide

Research direction

Start by locating the crate's output.print API, the human and json targets, and any existing benchmark setup. Add measurements for the listed stdout, test-helper, file, println!, locked-stdout, and buffered-stdout cases, and confirm the benchmarks report comparable timings for printing n lines of example text.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
performance, testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.