1 | /*! |
2 | A collection of modules that provide APIs that are useful across many regex |
3 | engines. |
4 | |
5 | While one should explore the sub-modules directly to get a sense of what's |
6 | there, here are some highlights that tie the sub-modules to higher level |
7 | use cases: |
8 | |
9 | * `alphabet` contains APIs that are useful if you're doing low level things |
10 | with the DFAs in this crate. For example, implementing determinization or |
11 | walking its state graph directly. |
12 | * `captures` contains APIs for dealing with capture group matches and their |
13 | mapping to "slots" used inside an NFA graph. This is also where you can find |
14 | iterators over capture group names. |
15 | * `escape` contains types for pretty-printing raw byte slices as strings. |
16 | * `iter` contains API helpers for writing regex iterators. |
17 | * `lazy` contains a no-std and no-alloc variant of `lazy_static!` and |
18 | `once_cell`. |
19 | * `look` contains APIs for matching and configuring look-around assertions. |
20 | * `pool` provides a way to reuse mutable memory allocated in a thread safe |
21 | manner. |
22 | * `prefilter` provides APIs for building prefilters and using them in searches. |
23 | * `primitives` are what you might use if you're doing lower level work on |
24 | automata, such as walking an NFA state graph. |
25 | * `syntax` provides some higher level convenience functions for interacting |
26 | with the `regex-syntax` crate. |
27 | * `wire` is useful if you're working with DFA serialization. |
28 | */ |
29 | |
30 | pub mod alphabet; |
31 | #[cfg (feature = "alloc" )] |
32 | pub mod captures; |
33 | pub mod escape; |
34 | #[cfg (feature = "alloc" )] |
35 | pub mod interpolate; |
36 | pub mod iter; |
37 | pub mod lazy; |
38 | pub mod look; |
39 | #[cfg (feature = "alloc" )] |
40 | pub mod pool; |
41 | pub mod prefilter; |
42 | pub mod primitives; |
43 | pub mod start; |
44 | #[cfg (feature = "syntax" )] |
45 | pub mod syntax; |
46 | pub mod wire; |
47 | |
48 | #[cfg (any(feature = "dfa-build" , feature = "hybrid" ))] |
49 | pub(crate) mod determinize; |
50 | pub(crate) mod empty; |
51 | pub(crate) mod int; |
52 | pub(crate) mod memchr; |
53 | pub(crate) mod search; |
54 | #[cfg (feature = "alloc" )] |
55 | pub(crate) mod sparse_set; |
56 | pub(crate) mod unicode_data; |
57 | pub(crate) mod utf8; |
58 | |