mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-30 23:20:40 +00:00
40 lines
9.4 KiB
HTML
40 lines
9.4 KiB
HTML
<!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 `opaque` fn in crate `combine`."><meta name="keywords" content="rust, rustlang, rust-lang, opaque"><title>combine::parser::combinator::opaque - 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'>combinator</a></p><script>window.sidebarCurrent = {name: 'opaque', 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/combinator.rs.html#1265-1272' 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'>combinator</a>::<wbr><a class="fn" href=''>opaque</a></span></h1><pre class='rust fn'>pub fn opaque<F, I, O, S>(f: F) -> <a class="struct" href="../../../combine/parser/combinator/struct.Opaque.html" title="struct combine::parser::combinator::Opaque">Opaque</a><F, I, O, S> <span class="where fmt-newline">where<br> I: <a class="trait" href="../../../combine/trait.Stream.html" title="trait combine::Stream">Stream</a>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&mut dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&mut dyn <a class="trait" href="../../../combine/trait.Parser.html" title="trait combine::Parser">Parser</a><Input = I, Output = O, PartialState = S>)), </span></pre><div class='docblock'><p>Creates a parser from a function which takes a function that are given the actual parser.
|
||
Though convoluted this makes it possible to hide the concrete parser type without <code>Box</code> or
|
||
losing the full information about the parser as is the case of <a href="../function/fn.parser.html"><code>parser</code></a>.</p>
|
||
<p>Since this hides the type this can also be useful for writing mutually recursive <code>impl Parser</code>
|
||
parsers to break the otherwise arbitrarily large type that rustc creates internally.</p>
|
||
<p>If you need a more general version (that does not need trait objects) try the <a href="../../macro.parser.html"><code>parser!</code></a>
|
||
macro.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">PartialEq</span>, <span class="ident">Debug</span>)]</span>
|
||
<span class="kw">enum</span> <span class="ident">Expr</span> {
|
||
<span class="ident">Number</span>(<span class="ident">i64</span>),
|
||
<span class="ident">Pair</span>(<span class="ident">Box</span><span class="op"><</span><span class="ident">Expr</span><span class="op">></span>, <span class="ident">Box</span><span class="op"><</span><span class="ident">Expr</span><span class="op">></span>),
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">expr</span><span class="op"><</span><span class="ident">I</span><span class="op">></span>() <span class="op">-></span> <span class="ident">FnOpaque</span><span class="op"><</span><span class="ident">I</span>, <span class="ident">Expr</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="macro">opaque</span><span class="macro">!</span>(
|
||
<span class="comment">// `no_partial` disables partial parsing and replaces the partial state with `()`,</span>
|
||
<span class="comment">// letting us avoid naming that type</span>
|
||
<span class="ident">no_partial</span>(<span class="ident">choice</span>((
|
||
<span class="ident">from_str</span>(<span class="ident">many1</span>::<span class="op"><</span><span class="ident">String</span>, <span class="kw">_</span><span class="op">></span>(<span class="ident">digit</span>()))
|
||
.<span class="ident">map</span>(<span class="ident">Expr</span>::<span class="ident">Number</span>),
|
||
(<span class="ident">char</span>(<span class="string">'('</span>), <span class="ident">expr</span>(), <span class="ident">char</span>(<span class="string">','</span>), <span class="ident">expr</span>(), <span class="ident">char</span>(<span class="string">')'</span>))
|
||
.<span class="ident">map</span>(<span class="op">|</span>(<span class="kw">_</span>, <span class="ident">l</span>, <span class="kw">_</span>, <span class="ident">r</span>, <span class="kw">_</span>)<span class="op">|</span> <span class="ident">Expr</span>::<span class="ident">Pair</span>(<span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">l</span>), <span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">r</span>)))
|
||
))),
|
||
)
|
||
}
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
||
<span class="ident">expr</span>().<span class="ident">easy_parse</span>(<span class="string">"123"</span>),
|
||
<span class="prelude-val">Ok</span>((<span class="ident">Expr</span>::<span class="ident">Number</span>(<span class="number">123</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> |