function_benchmarker 0.1.0

A proc macro for benchmarking Rust code
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

# benchmarker

A simple and efficient benchmarking tool for Rust functions.

[![Crates.io](https://img.shields.io/crates/v/benchmarker.svg)](https://crates.io/crates/benchmarker)
[![Documentation](https://docs.rs/benchmarker/badge.svg)](https://docs.rs/benchmarker)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Features

- Easy-to-use macro for benchmarking functions
- Measures execution time and calculates statistics
- Supports multiple iterations for accurate results
- Customizable number of warmup rounds

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
benchmarker = "*"
```

Then, you can use the `bench` macro to benchmark your functions:

```rust
use function_benchmarker::benchmark;

use core::time;
use std::thread;

#[benchmark]
fn log_function() {
    for num in 0..10 {
        thread::sleep(time::Duration::from_secs(1));
        println!("{}", num);
    }
}

fn main() {
    log_function();
}

output:
Entering function: log_function
0
1
2
3
4
5
6
7
8
9
Exiting function: log_function (took 10038 ms)
```

This will print the average time taken to execute the function and other statistics.
## License

This project is licensed under the MIT License. See the `LICENSE` file for more details.