rust/tantivy
1
0
Fork 0
mirror of https://github.com/quickwit-oss/tantivy.git synced 2026-05-21 10:40:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Automatic Travis documentation build

Browse Source
This commit is contained in:
Travis CI User
2018-03-31 04:42:51 +00:00
parent 39e5c50326
commit e5aad126e0
6866 changed files with 47881 additions and 90970 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
master/regex_syntax/ast/parse/struct.Parser.html
View File

@@ -14,7 +14,7 @@
id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../../dark.css">
<link rel="stylesheet" type="text/css" href="../../../main.css" id="themeStyle">
<link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle">
<script src="../../../storage.js"></script>
@@ -55,13 +55,11 @@
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>regex_syntax</a>::<wbr><a href='../index.html'>ast</a>::<wbr><a href='index.html'>parse</a>::<wbr><a class="struct" href=''>Parser</a></span><span class='out-of-band'><span id='render-detail'>
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>regex_syntax</a>::<wbr><a href='../index.html'>ast</a>::<wbr><a href='index.html'>parse</a>::<wbr><a class="struct" href=''>Parser</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#233-264' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Parser { /* fields omitted */ }</pre><div class='docblock'><p>A regular expression parser.</p>
</span><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#233-264' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Parser { /* fields omitted */ }</pre></div><div class='docblock'><p>A regular expression parser.</p>
<p>This parses a string representation of a regular expression into an
abstract syntax tree. The size of the tree is proportional to the length
of the regular expression pattern.</p>
@@ -71,39 +69,28 @@ of the regular expression pattern.</p>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../../../regex_syntax/ast/parse/struct.Parser.html" title="struct regex_syntax::ast::parse::Parser">Parser</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#331-371' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class="struct" href="../../../regex_syntax/ast/parse/struct.Parser.html" title="struct regex_syntax::ast::parse::Parser">Parser</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#339-341' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Create a new parser with a default configuration.</p>
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../../regex_syntax/ast/parse/struct.Parser.html" title="struct regex_syntax::ast::parse::Parser">Parser</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#331-371' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class="struct" href="../../../regex_syntax/ast/parse/struct.Parser.html" title="struct regex_syntax::ast::parse::Parser">Parser</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#339-341' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new parser with a default configuration.</p>
<p>The parser can be run with either the <code>parse</code> or <code>parse_with_comments</code>
methods. The parse methods return an abstract syntax tree.</p>
<p>To set configuration options on the parser, use
<a href="struct.ParserBuilder.html"><code>ParserBuilder</code></a>.</p>
</div><h4 id='method.parse' class="method"><span id='parse.v' class='invisible'><code>pub fn <a href='#method.parse' class='fnname'>parse</a>(&amp;mut self, pattern: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="../../../regex_syntax/ast/enum.Ast.html" title="enum regex_syntax::ast::Ast">Ast</a>, <a class="struct" href="../../../regex_syntax/ast/struct.Error.html" title="struct regex_syntax::ast::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#344-346' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Parse the regular expression into an abstract syntax tree.</p>
</div><h4 id='method.parse_with_comments' class="method"><span id='parse_with_comments.v' class='invisible'><code>pub fn <a href='#method.parse_with_comments' class='fnname'>parse_with_comments</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;pattern: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../../../regex_syntax/ast/struct.WithComments.html" title="struct regex_syntax::ast::WithComments">WithComments</a>, <a class="struct" href="../../../regex_syntax/ast/struct.Error.html" title="struct regex_syntax::ast::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#350-355' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Parse the regular expression and return an abstract syntax tree with
</div><h4 id='method.parse' class="method"><span id='parse.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.parse' class='fnname'>parse</a>(&amp;mut self, pattern: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="../../../regex_syntax/ast/enum.Ast.html" title="enum regex_syntax::ast::Ast">Ast</a>, <a class="struct" href="../../../regex_syntax/ast/struct.Error.html" title="struct regex_syntax::ast::Error">Error</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#344-346' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Parse the regular expression into an abstract syntax tree.</p>
</div><h4 id='method.parse_with_comments' class="method"><span id='parse_with_comments.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.parse_with_comments' class='fnname'>parse_with_comments</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;pattern: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../../../regex_syntax/ast/struct.WithComments.html" title="struct regex_syntax::ast::WithComments">WithComments</a>, <a class="struct" href="../../../regex_syntax/ast/struct.Error.html" title="struct regex_syntax::ast::Error">Error</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#350-355' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Parse the regular expression and return an abstract syntax tree with
all of the comments found in the pattern.</p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'>
<h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../../regex_syntax/ast/parse/struct.Parser.html" title="struct regex_syntax::ast::parse::Parser">Parser</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#232' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../../regex_syntax/ast/parse/struct.Parser.html" title="struct regex_syntax::ast::parse::Parser">Parser</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#232' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#117-119' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../../regex_syntax/ast/parse/struct.Parser.html" title="struct regex_syntax::ast::parse::Parser">Parser</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#232' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#232' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
<h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../../regex_syntax/ast/parse/struct.Parser.html" title="struct regex_syntax::ast::parse::Parser">Parser</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#232' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../../regex_syntax/ast/parse/struct.Parser.html" title="struct regex_syntax::ast::parse::Parser">Parser</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#232' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#117-119' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../../regex_syntax/ast/parse/struct.Parser.html" title="struct regex_syntax::ast::parse::Parser">Parser</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#232' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/regex_syntax/ast/parse.rs.html#232' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div></div>
<h2 id='synthetic-implementations' class='small-section-header'>
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
</h2>
<div id='synthetic-implementations-list'>
<h3 id='impl-Send' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../../regex_syntax/ast/parse/struct.Parser.html" title="struct regex_syntax::ast::parse::Parser">Parser</a></code><a href='#impl-Send' class='anchor'></a></span><span class='out-of-band'></span></h3>
<div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../../regex_syntax/ast/parse/struct.Parser.html" title="struct regex_syntax::ast::parse::Parser">Parser</a></code><a href='#impl-Sync' class='anchor'></a></span><span class='out-of-band'></span></h3>
<div class='impl-items'></div></div></section>
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../../regex_syntax/ast/parse/struct.Parser.html" title="struct regex_syntax::ast::parse::Parser">Parser</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../../regex_syntax/ast/parse/struct.Parser.html" title="struct regex_syntax::ast::parse::Parser">Parser</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>