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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `regex` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, regex">
<title>regex - Rust</title>
<link rel="stylesheet" type="text/css" href="../main.css">
<link rel="shortcut icon" href="http://www.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<section class="sidebar">
<a href='../regex/index.html'><img src='http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='' width='100'></a>
<p class='location'></p><script>window.sidebarCurrent = {name: 'regex', ty: 'mod', relpath: '../'};</script>
</section>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press 'S' to search, '?' for more options..."
type="search">
</div>
</form>
</nav>
<section id='main' class="content mod">
<h1 class='fqn'><span class='in-band'>Crate <a class='mod' href=''>regex</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>−</span>]
</a>
</span><a id='src-0' class='srclink' href='../src/regex/lib.rs.html#11-431' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>This crate provides a native implementation of regular expressions that is
heavily based on RE2 both in syntax and in implementation. Notably,
backreferences and arbitrary lookahead/lookbehind assertions are not
provided. In return, regular expression searching provided by this package
has excellent worst-case performance. The specific syntax supported is
documented further down.</p>
<p>This crate's documentation provides some simple examples, describes Unicode
support and exhaustively lists the supported syntax. For more specific
details on the API, please see the documentation for the <code>Regex</code> type.</p>
<h1 id="usage" class='section-header'><a
href="#usage">Usage</a></h1>
<p>This crate is <a href="https://crates.io/crates/regex">on crates.io</a> and can be
used by adding <code>regex</code> to your dependencies in your project's <code>Cargo.toml</code>.</p>
<pre><code class="language-toml">[dependencies]
regex = "0.1.8"
</code></pre>
<p>and this to your crate root:</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>regex</span>;
</pre>
<h1 id="first-example:-find-a-date" class='section-header'><a
href="#first-example:-find-a-date">First example: find a date</a></h1>
<p>General use of regular expressions in this package involves compiling an
expression and then using it to search, split or replace text. For example,
to confirm that some text resembles a date:</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>regex</span>::<span class='ident'>Regex</span>;
<span class='kw'>let</span> <span class='ident'>re</span> <span class='op'>=</span> <span class='ident'>Regex</span>::<span class='ident'>new</span>(<span class='string'>r"^\d{4}-\d{2}-\d{2}$"</span>).<span class='ident'>unwrap</span>();
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>re</span>.<span class='ident'>is_match</span>(<span class='string'>"2014-01-01"</span>));
</pre>
<p>Notice the use of the <code>^</code> and <code>$</code> anchors. In this crate, every expression
is executed with an implicit <code>.*?</code> at the beginning and end, which allows
it to match anywhere in the text. Anchors can be used to ensure that the
full text matches an expression.</p>
<p>This example also demonstrates the utility of
<a href="http://doc.rust-lang.org/stable/reference.html#raw-byte-string-literals">raw strings</a>
in Rust, which
are just like regular strings except they are prefixed with an <code>r</code> and do
not process any escape sequences. For example, <code>"\\d"</code> is the same
expression as <code>r"\d"</code>.</p>
<h1 id="the-regex!-macro" class='section-header'><a
href="#the-regex!-macro">The <code>regex!</code> macro</a></h1>
<p>Rust's compile-time meta-programming facilities provide a way to write a
<code>regex!</code> macro which compiles regular expressions <em>when your program
compiles</em>. Said differently, if you only use <code>regex!</code> to build regular
expressions in your program, then your program cannot compile with an
invalid regular expression. Moreover, the <code>regex!</code> macro compiles the
given expression to native Rust code, which ideally makes it faster.
Unfortunately (or fortunately), the dynamic implementation has had a lot
more optimization work put it into it currently, so it is faster than
the <code>regex!</code> macro in most cases.</p>
<p>To use the <code>regex!</code> macro, you must enable the <code>plugin</code> feature and import
the <code>regex_macros</code> crate as a syntax extension:</p>
<pre class='rust rust-example-rendered'>
<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>feature</span>(<span class='ident'>plugin</span>)]</span>
<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>plugin</span>(<span class='ident'>regex_macros</span>)]</span>
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>regex</span>;
<span class='kw'>fn</span> <span class='ident'>main</span>() {
<span class='kw'>let</span> <span class='ident'>re</span> <span class='op'>=</span> <span class='macro'>regex</span><span class='macro'>!</span>(<span class='string'>r"^\d{4}-\d{2}-\d{2}$"</span>);
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>re</span>.<span class='ident'>is_match</span>(<span class='string'>"2014-01-01"</span>));
}
</pre>
<p>There are a few things worth mentioning about using the <code>regex!</code> macro.
Firstly, the <code>regex!</code> macro <em>only</em> accepts string <em>literals</em>.
Secondly, the <code>regex</code> crate <em>must</em> be linked with the name <code>regex</code> since
the generated code depends on finding symbols in the <code>regex</code> crate.</p>
<p>One downside of using the <code>regex!</code> macro is that it can increase the
size of your program's binary since it generates specialized Rust code.
The extra size probably won't be significant for a small number of
expressions, but 100+ calls to <code>regex!</code> will probably result in a
noticeably bigger binary.</p>
<p><strong>NOTE</strong>: This is implemented using a compiler plugin, which is not
available on the Rust 1.0 beta/stable channels. Therefore, you'll only
be able to use <code>regex!</code> on the nightlies.</p>
<h1 id="example:-iterating-over-capture-groups" class='section-header'><a
href="#example:-iterating-over-capture-groups">Example: iterating over capture groups</a></h1>
<p>This crate provides convenient iterators for matching an expression
repeatedly against a search string to find successive non-overlapping
matches. For example, to find all dates in a string and be able to access
them by their component pieces:</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>re</span> <span class='op'>=</span> <span class='ident'>Regex</span>::<span class='ident'>new</span>(<span class='string'>r"(\d{4})-(\d{2})-(\d{2})"</span>).<span class='ident'>unwrap</span>();
<span class='kw'>let</span> <span class='ident'>text</span> <span class='op'>=</span> <span class='string'>"2012-03-14, 2013-01-01 and 2014-07-05"</span>;
<span class='kw'>for</span> <span class='ident'>cap</span> <span class='kw'>in</span> <span class='ident'>re</span>.<span class='ident'>captures_iter</span>(<span class='ident'>text</span>) {
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>"Month: {} Day: {} Year: {}"</span>,
<span class='ident'>cap</span>.<span class='ident'>at</span>(<span class='number'>2</span>).<span class='ident'>unwrap_or</span>(<span class='string'>""</span>), <span class='ident'>cap</span>.<span class='ident'>at</span>(<span class='number'>3</span>).<span class='ident'>unwrap_or</span>(<span class='string'>""</span>),
<span class='ident'>cap</span>.<span class='ident'>at</span>(<span class='number'>1</span>).<span class='ident'>unwrap_or</span>(<span class='string'>""</span>));
}
<span class='comment'>// Output:</span>
<span class='comment'>// Month: 03 Day: 14 Year: 2012</span>
<span class='comment'>// Month: 01 Day: 01 Year: 2013</span>
<span class='comment'>// Month: 07 Day: 05 Year: 2014</span>
</pre>
<p>Notice that the year is in the capture group indexed at <code>1</code>. This is
because the <em>entire match</em> is stored in the capture group at index <code>0</code>.</p>
<h1 id="example:-replacement-with-named-capture-groups" class='section-header'><a
href="#example:-replacement-with-named-capture-groups">Example: replacement with named capture groups</a></h1>
<p>Building on the previous example, perhaps we'd like to rearrange the date
formats. This can be done with text replacement. But to make the code
clearer, we can <em>name</em> our capture groups and use those names as variables
in our replacement text:</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>re</span> <span class='op'>=</span> <span class='ident'>Regex</span>::<span class='ident'>new</span>(<span class='string'>r"(?P<y>\d{4})-(?P<m>\d{2})-(?P<d>\d{2})"</span>).<span class='ident'>unwrap</span>();
<span class='kw'>let</span> <span class='ident'>before</span> <span class='op'>=</span> <span class='string'>"2012-03-14, 2013-01-01 and 2014-07-05"</span>;
<span class='kw'>let</span> <span class='ident'>after</span> <span class='op'>=</span> <span class='ident'>re</span>.<span class='ident'>replace_all</span>(<span class='ident'>before</span>, <span class='string'>"$m/$d/$y"</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>after</span>, <span class='string'>"03/14/2012, 01/01/2013 and 07/05/2014"</span>);
</pre>
<p>The <code>replace</code> methods are actually polymorphic in the replacement, which
provides more flexibility than is seen here. (See the documentation for
<code>Regex::replace</code> for more details.)</p>
<p>Note that if your regex gets complicated, you can use the <code>x</code> flag to
enable insigificant whitespace mode, which also lets you write comments:</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>re</span> <span class='op'>=</span> <span class='ident'>Regex</span>::<span class='ident'>new</span>(<span class='string'>r"(?x)
(?P<y>\d{4}) # the year
-
(?P<m>\d{2}) # the month
-
(?P<d>\d{2}) # the day
"</span>).<span class='ident'>unwrap</span>();
<span class='kw'>let</span> <span class='ident'>before</span> <span class='op'>=</span> <span class='string'>"2012-03-14, 2013-01-01 and 2014-07-05"</span>;
<span class='kw'>let</span> <span class='ident'>after</span> <span class='op'>=</span> <span class='ident'>re</span>.<span class='ident'>replace_all</span>(<span class='ident'>before</span>, <span class='string'>"$m/$d/$y"</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>after</span>, <span class='string'>"03/14/2012, 01/01/2013 and 07/05/2014"</span>);
</pre>
<h1 id="pay-for-what-you-use" class='section-header'><a
href="#pay-for-what-you-use">Pay for what you use</a></h1>
<p>With respect to searching text with a regular expression, there are three
questions that can be asked:</p>
<ol>
<li>Does the text match this expression?</li>
<li>If so, where does it match?</li>
<li>Where are the submatches?</li>
</ol>
<p>Generally speaking, this crate could provide a function to answer only #3,
which would subsume #1 and #2 automatically. However, it can be
significantly more expensive to compute the location of submatches, so it's
best not to do it if you don't need to.</p>
<p>Therefore, only use what you need. For example, don't use <code>find</code> if you
only need to test if an expression matches a string. (Use <code>is_match</code>
instead.)</p>
<h1 id="unicode" class='section-header'><a
href="#unicode">Unicode</a></h1>
<p>This implementation executes regular expressions <strong>only</strong> on sequences of
Unicode scalar values while exposing match locations as byte indices into
the search string.</p>
<p>Currently, only simple case folding is supported. Namely, when matching
case-insensitively, the characters are first mapped using the
<a href="ftp://ftp.unicode.org/Public/UNIDATA/CaseFolding.txt">simple case folding</a>
mapping.</p>
<p>Regular expressions themselves are also <strong>only</strong> interpreted as a sequence
of Unicode scalar values. This means you can use Unicode characters
directly in your expression:</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>re</span> <span class='op'>=</span> <span class='ident'>Regex</span>::<span class='ident'>new</span>(<span class='string'>r"(?i)Δ+"</span>).<span class='ident'>unwrap</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>re</span>.<span class='ident'>find</span>(<span class='string'>"ΔδΔ"</span>), <span class='prelude-val'>Some</span>((<span class='number'>0</span>, <span class='number'>6</span>)));
</pre>
<p>Finally, Unicode general categories and scripts are available as character
classes. For example, you can match a sequence of numerals, Greek or
Cherokee letters:</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>re</span> <span class='op'>=</span> <span class='ident'>Regex</span>::<span class='ident'>new</span>(<span class='string'>r"[\pN\p{Greek}\p{Cherokee}]+"</span>).<span class='ident'>unwrap</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>re</span>.<span class='ident'>find</span>(<span class='string'>"abcΔᎠβⅠᏴγδⅡxyz"</span>), <span class='prelude-val'>Some</span>((<span class='number'>3</span>, <span class='number'>23</span>)));
</pre>
<h1 id="syntax" class='section-header'><a
href="#syntax">Syntax</a></h1>
<p>The syntax supported in this crate is almost in an exact correspondence
with the syntax supported by RE2. It is documented below.</p>
<p>Note that the regular expression parser and abstract syntax are exposed in
a separate crate,
<a href="../regex_syntax/index.html"><code>regex-syntax</code></a>.</p>
<h2 id="matching-one-character" class='section-header'><a
href="#matching-one-character">Matching one character</a></h2>
<pre class="rust">
. any character except new line (includes new line with s flag)
[xyz] A character class matching either x, y or z.
[^xyz] A character class matching any character except x, y and z.
[a-z] A character class matching any character in range a-z.
\d digit (\p{Nd})
\D not digit
[:alpha:] ASCII character class ([A-Za-z])
[:^alpha:] Negated ASCII character class ([^A-Za-z])
\pN One-letter name Unicode character class
\p{Greek} Unicode character class (general category or script)
\PN Negated one-letter name Unicode character class
\P{Greek} negated Unicode character class (general category or script)
</pre>
<p>Any named character class may appear inside a bracketed <code>[...]</code> character
class. For example, <code>[\p{Greek}\pN]</code> matches any Greek or numeral
character.</p>
<h2 id="composites" class='section-header'><a
href="#composites">Composites</a></h2>
<pre class="rust">
xy concatenation (x followed by y)
x|y alternation (x or y, prefer x)
</pre>
<h2 id="repetitions" class='section-header'><a
href="#repetitions">Repetitions</a></h2>
<pre class="rust">
x* zero or more of x (greedy)
x+ one or more of x (greedy)
x? zero or one of x (greedy)
x*? zero or more of x (ungreedy)
x+? one or more of x (ungreedy)
x?? zero or one of x (ungreedy)
x{n,m} at least n x and at most m x (greedy)
x{n,} at least n x (greedy)
x{n} exactly n x
x{n,m}? at least n x and at most m x (ungreedy)
x{n,}? at least n x (ungreedy)
x{n}? exactly n x
</pre>
<h2 id="empty-matches" class='section-header'><a
href="#empty-matches">Empty matches</a></h2>
<pre class="rust">
^ the beginning of text (or start-of-line with multi-line mode)
$ the end of text (or end-of-line with multi-line mode)
\A only the beginning of text (even with multi-line mode enabled)
\z only the end of text (even with multi-line mode enabled)
\b a Unicode word boundary (\w on one side and \W, \A, or \z on other)
\B not a Unicode word boundary
</pre>
<h2 id="grouping-and-flags" class='section-header'><a
href="#grouping-and-flags">Grouping and flags</a></h2>
<pre class="rust">
(exp) numbered capture group (indexed by opening parenthesis)
(?P<name>exp) named (also numbered) capture group (allowed chars: [_0-9a-zA-Z])
(?:exp) non-capturing group
(?flags) set flags within current group
(?flags:exp) set flags for exp (non-capturing)
</pre>
<p>Flags are each a single character. For example, <code>(?x)</code> sets the flag <code>x</code>
and <code>(?-x)</code> clears the flag <code>x</code>. Multiple flags can be set or cleared at
the same time: <code>(?xy)</code> sets both the <code>x</code> and <code>y</code> flags and <code>(?x-y)</code> sets
the <code>x</code> flag and clears the <code>y</code> flag.</p>
<p>All flags are by default disabled. They are:</p>
<pre class="rust">
i case-insensitive
m multi-line mode: ^ and $ match begin/end of line
s allow . to match \n
U swap the meaning of x* and x*?
x ignore whitespace and allow line comments (starting with `#`)
</pre>
<p>Here's an example that matches case-insensitively for only part of the
expression:</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>re</span> <span class='op'>=</span> <span class='ident'>Regex</span>::<span class='ident'>new</span>(<span class='string'>r"(?i)a+(?-i)b+"</span>).<span class='ident'>unwrap</span>();
<span class='kw'>let</span> <span class='ident'>cap</span> <span class='op'>=</span> <span class='ident'>re</span>.<span class='ident'>captures</span>(<span class='string'>"AaAaAbbBBBb"</span>).<span class='ident'>unwrap</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>cap</span>.<span class='ident'>at</span>(<span class='number'>0</span>), <span class='prelude-val'>Some</span>(<span class='string'>"AaAaAbb"</span>));
</pre>
<p>Notice that the <code>a+</code> matches either <code>a</code> or <code>A</code>, but the <code>b+</code> only matches
<code>b</code>.</p>
<h2 id="escape-sequences" class='section-header'><a
href="#escape-sequences">Escape sequences</a></h2>
<pre class="rust">
\* literal *, works for any punctuation character: \.+*?()|[]{}^$
\a bell (\x07)
\f form feed (\x0C)
\t horizontal tab
\n new line
\r carriage return
\v vertical tab (\x0B)
\123 octal character code (up to three digits)
\x7F hex character code (exactly two digits)
\x{10FFFF} any hex character code corresponding to a Unicode code point
</pre>
<h2 id="perl-character-classes-(unicode-friendly)" class='section-header'><a
href="#perl-character-classes-(unicode-friendly)">Perl character classes (Unicode friendly)</a></h2>
<p>These classes are based on the definitions provided in
<a href="http://www.unicode.org/reports/tr18/#Compatibility_Properties">UTS#18</a>:</p>
<pre class="rust">
\d digit (\p{Nd})
\D not digit
\s whitespace (\p{White_Space})
\S not whitespace
\w word character (\p{Alphabetic} + \p{M} + \d + \p{Pc} + \p{Join_Control})
\W not word character
</pre>
<h2 id="ascii-character-classes" class='section-header'><a
href="#ascii-character-classes">ASCII character classes</a></h2>
<pre class="rust">
[:alnum:] alphanumeric ([0-9A-Za-z])
[:alpha:] alphabetic ([A-Za-z])
[:ascii:] ASCII ([\x00-\x7F])
[:blank:] blank ([\t ])
[:cntrl:] control ([\x00-\x1F\x7F])
[:digit:] digits ([0-9])
[:graph:] graphical ([!-~])
[:lower:] lower case ([a-z])
[:print:] printable ([ -~])
[:punct:] punctuation ([!-/:-@[-`{-~])
[:space:] whitespace ([\t\n\v\f\r ])
[:upper:] upper case ([A-Z])
[:word:] word characters ([0-9A-Za-z_])
[:xdigit:] hex digit ([0-9A-Fa-f])
</pre>
<h1 id="untrusted-input" class='section-header'><a
href="#untrusted-input">Untrusted input</a></h1>
<p>This crate can handle both untrusted regular expressions and untrusted
search text.</p>
<p>Untrusted regular expressions are handled by capping the size of a compiled
regular expression. (See <code>Regex::with_size_limit</code>.) Without this, it would
be trivial for an attacker to exhaust your system's memory with expressions
like <code>a{100}{100}{100}</code>.</p>
<p>Untrusted search text is allowed because the matching engine(s) in this
crate have time complexity <code>O(mn)</code> (with <code>m ~ regex</code> and <code>n ~ search text</code>), which means there's no way to cause exponential blow-up like with
some other regular expression engines. (We pay for this by disallowing
features like arbitrary look-ahead and back-references.)</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class='struct' href='struct.Captures.html'
title='regex::Captures'>Captures</a></td>
<td class='docblock short'>
<p>Captures represents a group of captured strings for a single match.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.FindCaptures.html'
title='regex::FindCaptures'>FindCaptures</a></td>
<td class='docblock short'>
<p>An iterator that yields all non-overlapping capture groups matching a
particular regular expression.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.FindMatches.html'
title='regex::FindMatches'>FindMatches</a></td>
<td class='docblock short'>
<p>An iterator over all non-overlapping matches for a particular string.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.NoExpand.html'
title='regex::NoExpand'>NoExpand</a></td>
<td class='docblock short'>
<p>NoExpand indicates literal string replacement.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.RegexSplits.html'
title='regex::RegexSplits'>RegexSplits</a></td>
<td class='docblock short'>
<p>Yields all substrings delimited by a regular expression match.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.RegexSplitsN.html'
title='regex::RegexSplitsN'>RegexSplitsN</a></td>
<td class='docblock short'>
<p>Yields at most <code>N</code> substrings delimited by a regular expression match.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.SubCaptures.html'
title='regex::SubCaptures'>SubCaptures</a></td>
<td class='docblock short'>
<p>An iterator over capture groups for a particular match of a regular
expression.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.SubCapturesNamed.html'
title='regex::SubCapturesNamed'>SubCapturesNamed</a></td>
<td class='docblock short'>
<p>An Iterator over named capture groups as a tuple with the group
name and the value.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.SubCapturesPos.html'
title='regex::SubCapturesPos'>SubCapturesPos</a></td>
<td class='docblock short'>
<p>An iterator over capture group positions for a particular match of a
regular expression.</p>
</td>
</tr>
</table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class='enum' href='enum.Error.html'
title='regex::Error'>Error</a></td>
<td class='docblock short'>
<p>An error that occurred during parsing or compiling a regular expression.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='enum' href='enum.Regex.html'
title='regex::Regex'>Regex</a></td>
<td class='docblock short'>
<p>A compiled regular expression</p>
</td>
</tr>
</table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class='trait' href='trait.Replacer.html'
title='regex::Replacer'>Replacer</a></td>
<td class='docblock short'>
<p>Replacer describes types that can be used to replace matches in a string.</p>
</td>
</tr>
</table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class='fn' href='fn.is_match.html'
title='regex::is_match'>is_match</a></td>
<td class='docblock short'>
<p>Tests if the given regular expression matches somewhere in the text given.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='fn' href='fn.quote.html'
title='regex::quote'>quote</a></td>
<td class='docblock short'>
<p>Escapes all regular expression meta characters in <code>text</code>.</p>
</td>
</tr>
</table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<div id="help" class="hidden">
<div class="shortcuts">
<h1>Keyboard shortcuts</h1>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
</dl>
</div>
<div class="infos">
<h1>Search tricks</h1>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>typedef</code> (or
<code>tdef</code>).
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code>)
</p>
</div>
</div>
<script>
window.rootPath = "../";
window.currentCrate = "regex";
window.playgroundUrl = "";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script async src="../search-index.js"></script>
</body>
</html>
|