patterns 0.3.1

no_std, no alloc pattern scan library using simd
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

# Pattern matching library

Allows you to search for a pattern within data via an iterator interface.
This library uses the core::simd abstraction and is fully no_std, no alloc.
Additionally, all panics are documented and are limited to pattern creation.

## Usage

```rs
use patterns::Pattern;

let data = [0_u8; 1_000_00];
// Allows . and ? as wildcard.
// Any number of wildcard characters between spaces is considered a wildcard byte.
let pattern: Pattern = "01 02 00 ? 59 ff".parse().unwrap();
let mut iterator = pattern.matches(&data);

for _found in iterator {
    // use _found
}
```

More advanced use cases may also specify a target alignment required to
match, or the LANE size with which to search:

```rs
use patterns::Pattern;

static PATTERN: Pattern<4, 64> = Pattern::new("00 01 02 . ff");
```

## Limitations

- The maximum amount of bytes supported inside a pattern are determined by
  the chosen 2nd const parameter (default 64)
- Target alignment of the pattern to search for must be less or equal to
  that 2nd const parameter
- The pointer of data to search through must adhere to these bounds:
    - `data.as_ptr() - 64 > `[`usize::MIN`]
    - `data.as_ptr() + data.len() + 64 < `[`usize::MAX`]

In practice, it's impossible to be outside of these bounds when using an OS.