huncholaneA rust macro that allows regular expression creation through independent files. Allows fully typed named groups.
update readme
huncholane1 file changed, +2 -2
+2-2README.md
| @@ -13,14 +13,14 @@ Allows for named groups in regular expressions to be generated from special file | ||
| 13 | 13 | - `m` (multiline): `^` and `$` match the start and end of lines, not just the entire input. |
| 14 | 14 | - `x` (extended): allows whitespace and comments starting with `#` inside the regex. |
| 15 | 15 | |
| 16 | -### Each regex file is a class with 4 main functions | |
| 16 | +### Each regex file is a structure with 4 main implementations | |
| 17 | 17 | |
| 18 | 18 | 1. `from_str(text: &str)` Finds a single match within the given string. |
| 19 | 19 | 2. `from_file(filename: &str)` Finds a single match after opening the given filename. |
| 20 | 20 | 3. `vec_from_str(text: &str)` Extracts all the matches in a given string. |
| 21 | 21 | 4. `vec_from_file(filename: &str)` Extracts all the matches after opening the given filename. |
| 22 | 22 | |
| 23 | -The abstract struct for matches within the regex_macro library contains `start_pos`, `end_pos`, and public fields for each named group inside of the `.re` file. Each field then contains a `start_pos`, `end_pos`, and `val` field. | |
| 23 | +The abstract structure for matches within the regex_macro library contains `start_pos`, `end_pos`, and public fields for each named group inside of the `.re` file. Each field then contains a `start_pos`, `end_pos`, and `val` field. | |
| 24 | 24 | |
| 25 | 25 | ### Tips |
| 26 | 26 |