https://github.com/cfsamson/print-perf
Provides helper methods for measuring and printing out a nicely formatted measured time between two code points.
https://github.com/cfsamson/print-perf
Last synced: 3 months ago
JSON representation
Provides helper methods for measuring and printing out a nicely formatted measured time between two code points.
- Host: GitHub
- URL: https://github.com/cfsamson/print-perf
- Owner: cfsamson
- License: mit
- Created: 2019-02-25T23:15:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-04-28T22:40:37.000Z (about 6 years ago)
- Last Synced: 2025-02-28T05:56:27.457Z (4 months ago)
- Language: Rust
- Size: 20.5 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Easier print-optimization for Rust
[](https://crates.io/crates/print_perf)
[![Chrono on docs.rs][docsrs-image]][docsrs]
[docsrs-image]: https://docs.rs/print_perf/badge.svg
[docsrs]: https://docs.rs/print_perf
You've probably heard of print debugging, but maybe not the lesser known
member of the print family: print-optimization.
Sometimes it's interesting to measure the time some part of your code uses,
but you won't set up everything you need for profiling your entire program
(or you don't have that option in the environment you're working in).
Doing this in Rust requires some boilerplate at the moment, especially if
you want to print out an easily readable output that you can navigate
directly to the relevant lines of code from. This crate aims to make this
easier to do:
You can use two methods to measure the elapsed time:
1. Lap: measures elapsed time from the last lap (or the starting point if it's the first lap)
2. Split: measures elapsed time from the starting point where you call it in your code
Here's two examples:
```rust
use print_perf::*;
// or explicit print_perf::{perf, Perf};
use std::time::Duration;
use std::thread::sleep;
fn add(a: i32, b: i32) -> i32 {
sleep(Duration::from_millis(100));
a + b
}
fn main() {
let add_p = perf!("add fn");
let result = add(4, 4);
add_p.end();
// ^-- prints: 0.100140446 (add fn) @ [src/main.rs:9]
assert_eq!(result, 8);
}
```
You can also add split times like this:
```rust
use print_perf::*;
# use std::time::Duration;
# use std::thread::sleep;
fn add(a: i32, b: i32) -> i32 {
sleep(Duration::from_millis(100));
a + b
}
fn main() {
let p = perf!("add fn");
let _result = add(4, 4);
p.split("add");
let _div = _result / 2;
p.split("div");
p.end();
}
```
# Dependecies
I don't think super-small convenience code bits like this should pull inn any dependencies so I try to avoid them. This crate currently depends on no other crates.
# Known bugs
The coloring will not output correctly on all windows terminals. The coloring is deactivated on windows release builds.
# Stability
The exact output printed by this macro should not be relied upon
and is subject to future changes.
# Panics
Panics if writing to `io::stderr` fails.
[stderr]: https://en.wikipedia.org/wiki/Standard_streams#Standard_error_(stderr)