mentat/docs/apis/rust/combine/combinator/fn.recognize.html

137 lines
7.4 KiB
HTML
Raw Normal View History

2018-06-21 14:44:35 +00:00
<!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 `recognize` fn in crate `combine`.">
<meta name="keywords" content="rust, rustlang, rust-lang, recognize">
<title>combine::combinator::recognize - 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>
</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">&#9776;</div>
<div class="sidebar-elems"><p class='location'><a href='../index.html'>combine</a>::<wbr><a href='index.html'>combinator</a></p><script>window.sidebarCurrent = {name: 'recognize', 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">
<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"><h1 class='fqn'><span class='in-band'>Function <a href='../index.html'>combine</a>::<wbr><a href='index.html'>combinator</a>::<wbr><a class="fn" href=''>recognize</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/combine/combinator.rs.html#2504-2510' title='goto source code'>[src]</a></span></h1><pre class='rust fn'>pub fn recognize&lt;F, P&gt;(parser: P) -&gt; <a class="struct" href="../../combine/combinator/struct.Recognize.html" title="struct combine::combinator::Recognize">Recognize</a>&lt;F, P&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;P: <a class="trait" href="../../combine/trait.Parser.html" title="trait combine::Parser">Parser</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.FromIterator.html" title="trait core::iter::traits::FromIterator">FromIterator</a>&lt;&lt;P::<a class="type" href="../../combine/trait.Parser.html#associatedtype.Input" title="type combine::Parser::Input">Input</a> as <a class="trait" href="../../combine/trait.StreamOnce.html" title="trait combine::StreamOnce">StreamOnce</a>&gt;::<a class="type" href="../../combine/trait.StreamOnce.html#associatedtype.Item" title="type combine::StreamOnce::Item">Item</a>&gt;,&nbsp;</span></pre><div class='docblock'><p>Constructs a parser which returns the tokens parsed by <code>parser</code> accumulated in
<code>F: FromIterator&lt;P::Input::Item&gt;</code> instead of <code>P::Output</code>.</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">combine</span>::<span class="ident">Parser</span>;
<span class="kw">use</span> <span class="ident">combine</span>::<span class="ident">combinator</span>::{<span class="ident">skip_many1</span>, <span class="ident">token</span>, <span class="ident">recognize</span>};
<span class="kw">use</span> <span class="ident">combine</span>::<span class="ident">char</span>::<span class="ident">digit</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">parser</span> <span class="op">=</span> <span class="ident">recognize</span>((<span class="ident">skip_many1</span>(<span class="ident">digit</span>()), <span class="ident">token</span>(<span class="string">&#39;.&#39;</span>), <span class="ident">skip_many1</span>(<span class="ident">digit</span>())));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">parser</span>.<span class="ident">parse</span>(<span class="string">&quot;123.45&quot;</span>), <span class="prelude-val">Ok</span>((<span class="string">&quot;123.45&quot;</span>.<span class="ident">to_string</span>(), <span class="string">&quot;&quot;</span>)));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">parser</span>.<span class="ident">parse</span>(<span class="string">&quot;123.45&quot;</span>), <span class="prelude-val">Ok</span>((<span class="string">&quot;123.45&quot;</span>.<span class="ident">to_string</span>(), <span class="string">&quot;&quot;</span>)));</pre>
</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>&#9166;</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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "combine";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>