gitui/scopetime/README.md
Stephan Dilly 7c74cba839 more docs
2020-03-24 21:30:25 +01:00

26 lines
523 B
Markdown

# scopetime
*log runtime of arbitrary scope*
This crate is part of the [gitui](http://gitui.org) project and can be used to annotate arbitrary scopes to `trace` their execution times via `log`:
in your crate:
```
[dependencies]
scopetime = "0.1"
```
in your code:
```rust
fn foo(){
scope_time!("foo");
// ... do something u wanna measure
}
```
the resulting log looks someting like this:
```
19:45:00 [TRACE] (7) scopetime: [scopetime/src/lib.rs:34] scopetime: 2 ms [my_crate::foo] @my_crate/src/bar.rs:5
```