mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-27 13:40:49 +00:00
Automatic Travis documentation build
This commit is contained in:
Travis CI User
30
master/combine/parser/function/fn.env_parser.html
Normal file
30
master/combine/parser/function/fn.env_parser.html
Normal file
@@ -0,0 +1,30 @@
|
||||
<!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 `env_parser` fn in crate `combine`."><meta name="keywords" content="rust, rustlang, rust-lang, env_parser"><title>combine::parser::function::env_parser - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../combine/index.html'><img src='../../../rust-logo.png' alt='logo' width='100'></a><div class="sidebar-elems"><p class='location'><a href='../../index.html'>combine</a>::<wbr><a href='../index.html'>parser</a>::<wbr><a href='index.html'>function</a></p><script>window.sidebarCurrent = {name: 'env_parser', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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 class='srclink' href='../../../src/combine/parser/function.rs.html#171-180' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../../index.html'>combine</a>::<wbr><a href='../index.html'>parser</a>::<wbr><a href='index.html'>function</a>::<wbr><a class="fn" href=''>env_parser</a></span></h1><pre class='rust fn'>pub fn env_parser<E, I, O>(<br> env: E, <br> parser: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.fn.html">fn</a>(_: E, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>I) -> <a class="type" href="../../../combine/type.ParseResult.html" title="type combine::ParseResult">ParseResult</a><O, I><br>) -> <a class="struct" href="../../../combine/parser/function/struct.EnvParser.html" title="struct combine::parser::function::EnvParser">EnvParser</a><E, I, O> <span class="where fmt-newline">where<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> I: <a class="trait" href="../../../combine/trait.Stream.html" title="trait combine::Stream">Stream</a>, </span></pre><div class='docblock'><p>Constructs a parser out of an environment and a function which needs the given environment to
|
||||
do the parsing. This is commonly useful to allow multiple parsers to share some environment
|
||||
while still allowing the parsers to be written in separate functions.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">struct</span> <span class="ident">Interner</span>(<span class="ident">HashMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">u32</span><span class="op">></span>);
|
||||
<span class="kw">impl</span> <span class="ident">Interner</span> {
|
||||
<span class="kw">fn</span> <span class="ident">string</span><span class="op"><</span><span class="ident">I</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">input</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">I</span>) <span class="op">-></span> <span class="ident">ParseResult</span><span class="op"><</span><span class="ident">u32</span>, <span class="ident">I</span><span class="op">></span>
|
||||
<span class="kw">where</span> <span class="ident">I</span>: <span class="ident">Stream</span><span class="op"><</span><span class="ident">Item</span><span class="op">=</span><span class="ident">char</span><span class="op">></span>,
|
||||
<span class="ident">I</span>::<span class="ident">Error</span>: <span class="ident">ParseError</span><span class="op"><</span><span class="ident">I</span>::<span class="ident">Item</span>, <span class="ident">I</span>::<span class="ident">Range</span>, <span class="ident">I</span>::<span class="ident">Position</span><span class="op">></span>,
|
||||
{
|
||||
<span class="ident">many</span>(<span class="ident">letter</span>())
|
||||
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">s</span>: <span class="ident">String</span><span class="op">|</span> <span class="self">self</span>.<span class="number">0</span>.<span class="ident">get</span>(<span class="kw-2">&</span><span class="ident">s</span>).<span class="ident">cloned</span>().<span class="ident">unwrap_or</span>(<span class="number">0</span>))
|
||||
.<span class="ident">parse_stream</span>(<span class="ident">input</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">HashMap</span>::<span class="ident">new</span>();
|
||||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">"hello"</span>.<span class="ident">into</span>(), <span class="number">1</span>);
|
||||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">"test"</span>.<span class="ident">into</span>(), <span class="number">2</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">env</span> <span class="op">=</span> <span class="ident">Interner</span>(<span class="ident">map</span>);
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">parser</span> <span class="op">=</span> <span class="ident">env_parser</span>(<span class="kw-2">&</span><span class="ident">env</span>, <span class="ident">Interner</span>::<span class="ident">string</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">parser</span>.<span class="ident">parse</span>(<span class="string">"hello"</span>);
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>, <span class="prelude-val">Ok</span>((<span class="number">1</span>, <span class="string">""</span>)));
|
||||
|
||||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">parser</span>.<span class="ident">parse</span>(<span class="string">"world"</span>);
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>, <span class="prelude-val">Ok</span>((<span class="number">0</span>, <span class="string">""</span>)));</pre></div>
|
||||
</div></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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse 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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "combine";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
|
||||
Reference in New Issue
Block a user