aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 4d1736a45dd88fa8ecb118e6e83949b8ac35fe8d (plain)
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
55
56
57
58
59
60
61
62
63
# bird-machine

Compile your regular expressions at compile time.

**Almost none of this has actually been implemented yet. Do not use this yet.**

## Example: find a date

```rust
use bird_machine::{bird_machine, Machine};

#[bird_machine(r"^\d{4}-\d{2}-\d{2}$")]
struct Date;

assert!(Date::is_match("2014-01-01"));
```

## Example: iterating over capture groups

```rust
use bird_machine::{bird_machine, Machine};

#[bird_machine(r"(\d{4})-(\d{2})-(\d{2})")]
struct Date<'a>(&'a str, &'a str, &'a str);
let input = "2012-03-14, 2013-01-01 and 2014-07-05";
let match_info = Date::captures_iter(input)
    .map(|x: Date| format!("Month: {} Day: {} Year: {}", x.1, x.2, x.0));
let expected = [
    "Month: 03 Day: 14 Year: 2012",
    "Month: 01 Day: 01 Year: 2013",
    "Month: 07 Day: 05 Year: 2014",
];
for (actual, expected) in match_info.zip(expected) {
    assert_eq!(actual, expected);
}
```

## Example: replacement with named capture groups

```rust
use bird_machine::{bird_machine, Machine};

#[bird_machine(r"(?P<y>\d{4})-(?P<m>\d{2})-(?P<d>\d{2})")]
struct Date<'a> {
    y: &'a str,
    m: &'a str,
    d: &'a str,
}
let before = "2012-03-14, 2013-01-01 and 2014-07-05";
let after = Date::replace_all(before, "$m/$d/$y");
assert_eq!(after, "03/14/2012, 01/01/2013 and 07/05/2014");
```

## Example: compile-time rejection of invalid regular expressions

```rust
use bird_machine::bird_machine;

// this will not compile
#[bird_machine(r"(oops i left this group open")]
struct Bad;
```