iter-log 0.2.0

Logs the progress of iterations, both for sequential and parallel (Rayon) iterators
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

# Rust Iterator Logging

This project provides a library for logging the progress of iterations in Rust, both for sequential and parallel iterations.

## Installation

Add the following line to your `Cargo.toml` file to include the library as a dependency:

```toml
[dependencies]
iter-log = "0.1"
```

## Usage

To enable, logging, set the environment variable `ENABLE_ITER_LOG`.

### Sequential Iteration

Use the log_progress method to log the progress of a sequential iteration:

```rust
use iter_log::LogProgressExt;

let x: Vec<u32> = (1..=100).collect();
let _y: Vec<_> = x.iter().log_progress(20).map(|&xi| xi * 2).collect();
```

### Parallel Iteration

Use the log_progress method to log the progress of a parallel iteration:

```rust
use iter_log::LogProgressParExt;
use rayon::prelude::*;

let x: Vec<u32> = (1..=100).collect();
let _z: Vec<_> = x.par_iter().log_progress(20).map(|&xi| xi * 2).collect();
```

### More examples

See the `main.rs` file for a complete example of how to use the library for both sequential and parallel iterations, including performance testing with and without logging.

### License

This project is licensed under the MIT License.