substr-iterator 0.1.3

Substring extractor based on characters without allocation
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

# Substr iterator

This library is made to iterate over a `&str` by a number of characters without allocating.

## Usage

```bash
cargo add substr-iterator
```

```rust
use substr_iterator::{Trigram, TrigramIter};

let mut iter = TrigramIter::from("whatever");
assert_eq!(iter.next(), Some(['w', 'h', 'a']));
let mut iter = TrigramIter::from("今天我吃饭");
assert_eq!(iter.next(), Some(['今', '天', '我']));
```

It's also possible to handle bigger windows.

```rust
use substr_iterator::{Substr, SubstrIter};

let mut iter = SubstrIter::<2>::from("whatever");
assert_eq!(iter.next(), Some(['w', 'h']));
let mut iter = SubstrIter::<2>::from("今天我吃饭");
assert_eq!(iter.next(), Some(['今', '天']));
```

When the `std` feature is enabled, the `SubstrWrapper` allows to display `Substr` as a `String`.

```rust
use substr_iterator::{SubstrWrapper, Trigram, TrigramIter};

let mut iter = TrigramIter::from("whatever");
let item = SubstrWrapper(iter.next().unwrap());
assert_eq!(item.to_string(), "wha");
```

When the `serde` feature is enabled, the `SubstrWrapper` allows to serialize and deserialize.

```rust
use substr_iterator::{SubstrWrapper, Trigram, TrigramIter};

let data: Vec<SubstrWrapper<3>> = vec![
    SubstrWrapper(['a', 'b', 'c']),
    SubstrWrapper(['今', '天', '我']),
];
assert_eq!(
    serde_json::to_string(&data).unwrap(),
    "[\"abc\",\"今天我\"]",
);
```