iter-index 1.0.0

More flexible alternative to Iterator's enumerate() method
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

[![crate](https://img.shields.io/crates/v/iter_index.svg)](https://crates.io/crates/iter-index)
[![documentation](https://docs.rs/iter-index/badge.svg)](https://docs.rs/iter-index)
[![license](https://img.shields.io/badge/License-MIT%202.0-blue.svg)](https://github.com/blueglyph/iter_index/blob/master/LICENSE-MIT)
[![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/blueglyph/iter_index/blob/master/LICENSE-APACHE)

# `iter-index` crate


This is a simple extension trait that provides a more flexible alternative to the iterator's method `enumerate()`. It allows to:
 * use a custom type for the index with `index::<T>()`
 * define a custom start value with `index_start::<T>(start: T)`
 * define a custom step value with `index_step::<T>(start: T, step: T)`.

## Examples


```rust
use iter_index::IndexerIterator;

let mut map = HashMap::<u8, &str>::new();
for (k, v) in vec!["a", "b", "c"].into_iter().index() {
    map.insert(k, v);
}
assert_eq!(map, HashMap::from([(0_u8, "a"), (1_u8, "b"), (2_u8, "c")]));
```

```rust
let items = vec!["a", "b", "c"];
let mut result = items.into_iter().index_start::<u8>(97);

assert_eq!(result.next(), Some((97_u8, "a")));
assert_eq!(result.next(), Some((98_u8, "b")));
assert_eq!(result.next(), Some((99_u8, "c")));
assert_eq!(result.next(), None);
```

```rust
let items = vec!["a", "b", "c"];
let mut result = items.into_iter().index_step::<u32>(100, 10);

assert_eq!(result.next(), Some((100_u32, "a")));
assert_eq!(result.next(), Some((110_u32, "b")));
assert_eq!(result.next(), Some((120_u32, "c")));
assert_eq!(result.next(), None);
```

# License


This code is licensed under either [MIT License](https://choosealicense.com/licenses/mit/) or [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/).