exec_time 0.1.7

Attribute macro for timing sync and async Rust functions with labels, units, and slow-call thresholds
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# `exec_time`

Attribute macro for printing sync and async function execution time.

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Crates.io](https://img.shields.io/crates/v/exec_time)](https://crates.io/crates/exec_time)
[![Build Status](https://travis-ci.org/AbrarNitk/exec_time.svg?branch=master)](https://travis-ci.org/AbrarNitk/exec_time)

## Install

```toml
[dependencies]
exec_time = "0.1.7"
```

MSRV: Rust `1.88`.

## Default

```rust
use exec_time::exec_time;

#[exec_time]
fn login() {
    std::thread::sleep(std::time::Duration::from_millis(100));
}
```

```text
[exec_time] login took 102 ms
```

## Slow Calls

```rust
use exec_time::exec_time;

#[exec_time(name = "cache.lookup", unit = "us", log_over = "500us")]
fn lookup() {}

#[exec_time(name = "db.query", warn_over = "250ms")]
fn query_db() {}
```

```text
[exec_time] cache.lookup took 734 us
```

```text
[exec_time][warn] db.query took 312 ms
```

## Options

- `print = "always" | "debug" | "never"`: controls whether timing is emitted. Default: `always`.
- `name = "..."`: replaces the generated label.
- `prefix = "..."`, `suffix = "..."`: build the label as `<prefix>::<function>::<suffix>`. Ignored when `name` is set.
- `unit = "ns" | "us" | "ms" | "s"`: output unit. Default: `ms`.
- `log_over = "..."`: print only when execution time meets or exceeds the threshold.
- `warn_over = "..."`: write a warning to `stderr` only when execution time meets or exceeds the threshold.

Threshold values support `ns`, `us`, `ms`, and `s`, for example `500us`, `5ms`, or `0.5s`.

## Rules

- Default output format: `[exec_time] <label> took <value> <unit>`
- `warn_over` takes precedence over `log_over` when both thresholds match
- `print = "never"` disables all output