Google Git
Sign in
eclipse / gerrit / www.eclipse.org / paho / dc881a9de844d35976bf5c14f7d1accf43728f5a / . / contents / files / rustdoc / src / regex / re_builder.rs.html
blob: 9343a4e25407a2a564fbd51213b11903c247d945 [file] [log] [blame]
<!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="Source to the Rust file `/home/fmp/.cargo/registry/src/github.com-1ecc6299db9ec823/regex-0.1.80/src/re_builder.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>re_builder.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
<link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<a href='../../regex/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
</nav>
<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"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
</pre><pre class="rust ">
<span class="comment">// Copyright 2014-2015 The Rust Project Developers. See the COPYRIGHT</span>
<span class="comment">// file at the top-level directory of this distribution and at</span>
<span class="comment">// http://rust-lang.org/COPYRIGHT.</span>
<span class="comment">//</span>
<span class="comment">// Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0&gt; or the MIT license</span>
<span class="comment">// &lt;LICENSE-MIT or http://opensource.org/licenses/MIT&gt;, at your</span>
<span class="comment">// option. This file may not be copied, modified, or distributed</span>
<span class="comment">// except according to those terms.</span>
<span class="doccomment">/// The set of user configurable options for compiling zero or more regexes.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">RegexOptions</span> {
<span class="kw">pub</span> <span class="ident">pats</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span>,
<span class="kw">pub</span> <span class="ident">size_limit</span>: <span class="ident">usize</span>,
<span class="kw">pub</span> <span class="ident">dfa_size_limit</span>: <span class="ident">usize</span>,
<span class="kw">pub</span> <span class="ident">case_insensitive</span>: <span class="ident">bool</span>,
<span class="kw">pub</span> <span class="ident">multi_line</span>: <span class="ident">bool</span>,
<span class="kw">pub</span> <span class="ident">dot_matches_new_line</span>: <span class="ident">bool</span>,
<span class="kw">pub</span> <span class="ident">swap_greed</span>: <span class="ident">bool</span>,
<span class="kw">pub</span> <span class="ident">ignore_whitespace</span>: <span class="ident">bool</span>,
<span class="kw">pub</span> <span class="ident">unicode</span>: <span class="ident">bool</span>,
}
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">RegexOptions</span> {
<span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-&gt;</span> <span class="self">Self</span> {
<span class="ident">RegexOptions</span> {
<span class="ident">pats</span>: <span class="macro">vec</span><span class="macro">!</span>[],
<span class="ident">size_limit</span>: <span class="number">10</span> <span class="op">*</span> (<span class="number">1</span><span class="op">&lt;&lt;</span><span class="number">20</span>),
<span class="ident">dfa_size_limit</span>: <span class="number">2</span> <span class="op">*</span> (<span class="number">1</span><span class="op">&lt;&lt;</span><span class="number">20</span>),
<span class="ident">case_insensitive</span>: <span class="bool-val">false</span>,
<span class="ident">multi_line</span>: <span class="bool-val">false</span>,
<span class="ident">dot_matches_new_line</span>: <span class="bool-val">false</span>,
<span class="ident">swap_greed</span>: <span class="bool-val">false</span>,
<span class="ident">ignore_whitespace</span>: <span class="bool-val">false</span>,
<span class="ident">unicode</span>: <span class="bool-val">true</span>,
}
}
}
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">define_builder</span> {
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">regex_mod</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">unicode</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">only_utf8</span>:<span class="ident">expr</span>) <span class="op">=&gt;</span> {
<span class="kw">pub</span> <span class="kw">mod</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span> {
<span class="kw">use</span> <span class="ident">error</span>::<span class="ident">Error</span>;
<span class="kw">use</span> <span class="ident">exec</span>::<span class="ident">ExecBuilder</span>;
<span class="kw">use</span> <span class="kw">super</span>::<span class="ident">RegexOptions</span>;
<span class="kw">use</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">regex_mod</span>::<span class="ident">Regex</span>;
<span class="doccomment">/// A configurable builder for a regular expression.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// A builder can be used to configure how the regex is built, for example, by</span>
<span class="doccomment">/// setting the default flags (which can be overridden in the expression</span>
<span class="doccomment">/// itself) or setting various limits.</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">RegexBuilder</span>(<span class="ident">RegexOptions</span>);
<span class="kw">impl</span> <span class="ident">RegexBuilder</span> {
<span class="doccomment">/// Create a new regular expression builder with the given pattern.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If the pattern is invalid, then an error will be returned when</span>
<span class="doccomment">/// `compile` is called.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">pattern</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>) <span class="op">-&gt;</span> <span class="ident">RegexBuilder</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">RegexBuilder</span>(<span class="ident">RegexOptions</span>::<span class="ident">default</span>());
<span class="ident">builder</span>.<span class="number">0</span>.<span class="ident">pats</span>.<span class="ident">push</span>(<span class="ident">pattern</span>.<span class="ident">to_owned</span>());
<span class="ident">builder</span>.<span class="number">0</span>.<span class="ident">unicode</span> <span class="op">=</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">unicode</span>;
<span class="ident">builder</span>
}
<span class="doccomment">/// Consume the builder and compile the regular expression.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that calling `as_str` on the resulting `Regex` will produce the</span>
<span class="doccomment">/// pattern given to `new` verbatim. Notably, it will not incorporate any</span>
<span class="doccomment">/// of the flags set on this builder.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">compile</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">Regex</span>, <span class="ident">Error</span><span class="op">&gt;</span> {
<span class="ident">ExecBuilder</span>::<span class="ident">new_options</span>(<span class="self">self</span>.<span class="number">0</span>)
.<span class="ident">only_utf8</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">only_utf8</span>)
.<span class="ident">build</span>()
.<span class="ident">map</span>(<span class="ident">Regex</span>::<span class="ident">from</span>)
}
<span class="doccomment">/// Set the value for the case insensitive (`i`) flag.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">case_insensitive</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">yes</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="ident">RegexBuilder</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">case_insensitive</span> <span class="op">=</span> <span class="ident">yes</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Set the value for the multi-line matching (`m`) flag.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">multi_line</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">yes</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="ident">RegexBuilder</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">multi_line</span> <span class="op">=</span> <span class="ident">yes</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Set the value for the any character (`s`) flag, where in `.` matches</span>
<span class="doccomment">/// anything when `s` is set and matches anything except for new line when</span>
<span class="doccomment">/// it is not set (the default).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// N.B. &quot;matches anything&quot; means &quot;any byte&quot; for `regex::bytes::Regex`</span>
<span class="doccomment">/// expressions and means &quot;any Unicode codepoint&quot; for `regex::Regex`</span>
<span class="doccomment">/// expressions.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">dot_matches_new_line</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">yes</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="ident">RegexBuilder</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">dot_matches_new_line</span> <span class="op">=</span> <span class="ident">yes</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Set the value for the greedy swap (`U`) flag.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">swap_greed</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">yes</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="ident">RegexBuilder</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">swap_greed</span> <span class="op">=</span> <span class="ident">yes</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Set the value for the ignore whitespace (`x`) flag.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">ignore_whitespace</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">yes</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="ident">RegexBuilder</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">ignore_whitespace</span> <span class="op">=</span> <span class="ident">yes</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Set the value for the Unicode (`u`) flag.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For byte based regular expressions, this is disabled by default.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">unicode</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">yes</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="ident">RegexBuilder</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">unicode</span> <span class="op">=</span> <span class="ident">yes</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Set the approximate size limit of the compiled regular expression.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This roughly corresponds to the number of bytes occupied by a single</span>
<span class="doccomment">/// compiled program. If the program exceeds this number, then a</span>
<span class="doccomment">/// compilation error is returned.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">size_limit</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">limit</span>: <span class="ident">usize</span>) <span class="op">-&gt;</span> <span class="ident">RegexBuilder</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">size_limit</span> <span class="op">=</span> <span class="ident">limit</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Set the approximate size of the cache used by the DFA.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This roughly corresponds to the number of bytes that the DFA will</span>
<span class="doccomment">/// use while searching.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this is a *per thread* limit. There is no way to set a global</span>
<span class="doccomment">/// limit. In particular, if a regex is used from multiple threads</span>
<span class="doccomment">/// simulanteously, then each thread may use up to the number of bytes</span>
<span class="doccomment">/// specified here.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">dfa_size_limit</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">limit</span>: <span class="ident">usize</span>) <span class="op">-&gt;</span> <span class="ident">RegexBuilder</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">dfa_size_limit</span> <span class="op">=</span> <span class="ident">limit</span>;
<span class="self">self</span>
}
}
}
}
}
<span class="macro">define_builder</span><span class="macro">!</span>(<span class="ident">bytes</span>, <span class="ident">re_bytes</span>, <span class="bool-val">false</span>, <span class="bool-val">false</span>);
<span class="macro">define_builder</span><span class="macro">!</span>(<span class="ident">unicode</span>, <span class="ident">re_unicode</span>, <span class="bool-val">true</span>, <span class="bool-val">true</span>);
</pre>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<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>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "regex";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>