rustbench 0.1.0

A lightweight Rust procedural macro for benchmarking function execution time.
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

# Rustbench

`rustbench` is a lightweight Rust procedural macro for benchmarking function execution time.

## Installation

To use `rustbench`, add it to your `Cargo.toml`:

```toml
[dependencies]
rustbench = "0.1.0"
```

Then, add the macro as a procedural macro dependency:

```toml
[lib]
proc-macro = true
```

## Usage

Simply annotate any function with `#[benchmark]` to measure its execution time.

```rust
use rustbench::benchmark;

#[benchmark]
fn sum() {
    let sum: u64 = (1..=1_000_000).sum();
    println!("Sum: {}", sum);
}

fn main() {
    sum();
}
```

### Output

When `sum` runs, it prints the execution time:

```
Function sum executed in 12.3ms
```

## Features (Planned)
- **Custom Iterations**: Run the function multiple times for better measurement.
- **Comparison Mode**: Compare execution time of two functions.
- **Output Formats**: JSON, CSV, or plain text.
- **Memory Profiling**: Measure memory usage during execution.
- **Integration with Logging**: Store benchmark results in logs.