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
|
<!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_syntax` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, regex_syntax">
<title>regex_syntax - Rust</title>
<link rel="stylesheet" type="text/css" href="../main.css">
</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">
<p class='location'></p><script>window.sidebarCurrent = {name: 'regex_syntax', 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_syntax</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_syntax/lib.rs.html#11-1184' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>This crate provides a regular expression parser and an abstract syntax for
regular expressions. The abstract syntax is defined by the <code>Expr</code> type. The
concrete syntax is enumerated in the
<a href="../regex/index.html#syntax"><code>regex</code></a>
crate documentation.</p>
<p>Note that since this crate is first and foremost an implementation detail for
the <code>regex</code> crate, it may experience more frequent breaking changes. It is
exposed as a separate crate so that others may use it to do analysis on regular
expressions or even build their own matching engine.</p>
<h1 id="example:-parsing-an-expression" class='section-header'><a
href="#example:-parsing-an-expression">Example: parsing an expression</a></h1>
<p>Parsing a regular expression can be done with the <code>Expr::parse</code> function.</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>regex_syntax</span>::<span class='ident'>Expr</span>;
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>Expr</span>::<span class='ident'>parse</span>(<span class='string'>r"ab|yz"</span>).<span class='ident'>unwrap</span>(), <span class='ident'>Expr</span>::<span class='ident'>Alternate</span>(<span class='macro'>vec</span><span class='macro'>!</span>[
<span class='ident'>Expr</span>::<span class='ident'>Literal</span> { <span class='ident'>chars</span>: <span class='macro'>vec</span><span class='macro'>!</span>[<span class='string'>'a'</span>, <span class='string'>'b'</span>], <span class='ident'>casei</span>: <span class='boolval'>false</span> },
<span class='ident'>Expr</span>::<span class='ident'>Literal</span> { <span class='ident'>chars</span>: <span class='macro'>vec</span><span class='macro'>!</span>[<span class='string'>'y'</span>, <span class='string'>'z'</span>], <span class='ident'>casei</span>: <span class='boolval'>false</span> },
]));
</pre>
<h1 id="example:-inspecting-an-error" class='section-header'><a
href="#example:-inspecting-an-error">Example: inspecting an error</a></h1>
<p>The parser in this crate provides very detailed error values. For example,
if an invalid character class range is given:</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>regex_syntax</span>::{<span class='ident'>Expr</span>, <span class='ident'>ErrorKind</span>};
<span class='kw'>let</span> <span class='ident'>err</span> <span class='op'>=</span> <span class='ident'>Expr</span>::<span class='ident'>parse</span>(<span class='string'>r"[z-a]"</span>).<span class='ident'>unwrap_err</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>err</span>.<span class='ident'>position</span>(), <span class='number'>4</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>err</span>.<span class='ident'>kind</span>(), <span class='kw-2'>&</span><span class='ident'>ErrorKind</span>::<span class='ident'>InvalidClassRange</span> {
<span class='ident'>start</span>: <span class='string'>'z'</span>,
<span class='ident'>end</span>: <span class='string'>'a'</span>,
});
</pre>
<p>Or unbalanced parentheses:</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>regex_syntax</span>::{<span class='ident'>Expr</span>, <span class='ident'>ErrorKind</span>};
<span class='kw'>let</span> <span class='ident'>err</span> <span class='op'>=</span> <span class='ident'>Expr</span>::<span class='ident'>parse</span>(<span class='string'>r"ab(cd"</span>).<span class='ident'>unwrap_err</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>err</span>.<span class='ident'>position</span>(), <span class='number'>2</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>err</span>.<span class='ident'>kind</span>(), <span class='kw-2'>&</span><span class='ident'>ErrorKind</span>::<span class='ident'>UnclosedParen</span>);
</pre>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class='struct' href='struct.CharClass.html'
title='regex_syntax::CharClass'>CharClass</a></td>
<td class='docblock short'>
<p>A character class.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.ClassRange.html'
title='regex_syntax::ClassRange'>ClassRange</a></td>
<td class='docblock short'>
<p>A single inclusive range in a character class.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.Error.html'
title='regex_syntax::Error'>Error</a></td>
<td class='docblock short'>
<p>A parse error.</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.ErrorKind.html'
title='regex_syntax::ErrorKind'>ErrorKind</a></td>
<td class='docblock short'>
<p>The specific type of parse error that can occur.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='enum' href='enum.Expr.html'
title='regex_syntax::Expr'>Expr</a></td>
<td class='docblock short'>
<p>A regular expression abstract syntax tree.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='enum' href='enum.Repeater.html'
title='regex_syntax::Repeater'>Repeater</a></td>
<td class='docblock short'>
<p>The type of a repeat operator expression.</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.quote.html'
title='regex_syntax::quote'>quote</a></td>
<td class='docblock short'>
<p>Escapes all regular expression meta characters in <code>text</code>.</p>
</td>
</tr>
</table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class=' module-item'>
<td><a class='type' href='type.Result.html'
title='regex_syntax::Result'>Result</a></td>
<td class='docblock short'>
<p>An alias for computations that can return a <code>Error</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_syntax";
window.playgroundUrl = "";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script async src="../search-index.js"></script>
</body>
</html>
|