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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
use crate::;
use TokenStream;
use quote;
use parse_macro_input;
/// The macro creates a function which returns `true` if the argument matches the regex.
///
/// If the first argument is an identifier (name), then this is the name of the function, which
/// would be generated. Example:
/// ```rust
/// use proc_macro_regex::regex;
///
/// regex!(the_name_of_the_function "the regex to check");
/// ```
///
/// Alternative, if the first argument is a visibility keyword, then this is the visibility of the
/// function. Otherwise, the function is private. Example:
/// ```rust
/// # use proc_macro_regex::regex;
/// regex!(pub public_function "the function is public");
/// regex!(private_function "the function is private");
/// ```
///
/// The next argument is a string of the regex, which the function should check. Alternative, a
/// byte string can be given, if the input should be a byte array (`&[u8]`). otherwise a string is
/// taken.
/// ```rust
/// # use proc_macro_regex::regex;
/// regex!(string_function "This function takes a string");
/// regex!(bytes_function "This function takes a byte array");
/// ```
///
/// At the end, a positive number can be given to set the limit of the lookup table
/// (see `README.md`).
/// ```rust
/// # use proc_macro_regex::regex;
/// regex!(limit_function "The limit is set to 100 bytes" 100);
/// ```
///
/// # Syntax
/// The given regex works the same as in the [regex](https://crates.io/crates/regex) crate.
/// * If the `^` is at the beginning of the regex, then it is checked if the input is match at the
/// beginning of the text.
/// * If the `$` is at the end, then it is checked if the input is match at the end of the text.
/// * If both are present then the whole input is checked.
/// * Otherwise, is check if the string contains the regex.