fuzzy-regex 0.1.0

High-performance fuzzy regular expression engine combining regex with Damerau-Levenshtein distance
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

# API Reference

Overview of the main API types and methods.

## Main Types

| Type | Description |
|------|-------------|
| `FuzzyRegex` | Compiled regex pattern |
| `FuzzyRegexBuilder` | Builder for customizing regex |
| `Match` | A single match result |
| `Captures` | Match with capture groups |
| `StreamingMatcher` | Stateful matcher for streaming |
| `StreamingMatch` | Match from streaming search |

## Quick Method Reference

```rust
use fuzzy_regex::FuzzyRegex;

// Construction
let re = FuzzyRegex::new("pattern").unwrap();

// Searching
re.is_match(text)           // bool - does it match?
re.find(text)               // Option<Match>
re.find_iter(text)          // Iterator<Match>
re.find_rev(text)           // Option<Match> - rightmost
re.captures(text)           // Option<Captures>

// Replacing
re.replace(text, "x")       // String
re.replace_all(text, "x")   // String
re.split(text)              // Split

// Streaming
re.stream()                 // StreamingMatcher
re.find_bytes(bytes)        // Option<StreamingMatch>
```