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: Here's an example:
```rust use printperf::*; // or explicit printperf::{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 addp = perf!("add fn"); let result = add(4, 4); addp.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::*;
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(); } ```
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.
The coloring will not output correctly on all windows terminals. The coloring is deactivated on windows release builds.
The exact output printed by this macro should not be relied upon and is subject to future changes.
Panics if writing to io::stderr fails.