mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-21 18:50:42 +00:00
11 lines
8.6 KiB
HTML
11 lines
8.6 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 `ParseResult` type in crate `combine`."><meta name="keywords" content="rust, rustlang, rust-lang, ParseResult"><title>combine::ParseResult - 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 type"><!--[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><p class='location'>Type Definition ParseResult</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Into%3CParseResult%3CO%2C%20I%3E%3E">Into<ParseResult<O, I>></a><a href="#impl-From%3CParseResult%3CO%2C%20I%3E%3E">From<ParseResult<O, I>></a></div></div><p class='location'><a href='index.html'>combine</a></p><script>window.sidebarCurrent = {name: 'ParseResult', ty: 'type', 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"><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='in-band'>Type Definition <a href='index.html'>combine</a>::<wbr><a class="type" href=''>ParseResult</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'>−</span>]</a></span><a class='srclink' href='../src/combine/primitives.rs.html#734' title='goto source code'>[src]</a></span></h1><pre class='rust typedef'>type ParseResult<O, I> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>O, <a class="enum" href="../combine/primitives/enum.Consumed.html" title="enum combine::primitives::Consumed">Consumed</a><I><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../combine/primitives/enum.Consumed.html" title="enum combine::primitives::Consumed">Consumed</a><<a class="struct" href="../combine/primitives/struct.ParseError.html" title="struct combine::primitives::ParseError">ParseError</a><I>>>;</pre><div class='docblock'><p>A type alias over the specific <code>Result</code> type used by parsers to indicate wether they were
|
||
successful or not.
|
||
<code>O</code> is the type that is output on success.
|
||
<code>I</code> is the specific stream type used in the parser.</p>
|
||
</div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<div id='implementations-list'><h3 id='impl-Into%3CParseResult%3CO%2C%20I%3E%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<O, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="type" href="../combine/type.ParseResult.html" title="type combine::ParseResult">ParseResult</a><O, I>> for <a class="type" href="../combine/type.ConsumedResult.html" title="type combine::ConsumedResult">ConsumedResult</a><O, I> <span class="where fmt-newline">where<br> I: <a class="trait" href="../combine/trait.StreamOnce.html" title="trait combine::StreamOnce">StreamOnce</a>, </span></code><a href='#impl-Into%3CParseResult%3CO%2C%20I%3E%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/combine/primitives.rs.html#1341-1354' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.into' class="method"><span id='into.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> <a class="type" href="../combine/type.ParseResult.html" title="type combine::ParseResult">ParseResult</a><O, I></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/combine/primitives.rs.html#1345-1353' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-From%3CParseResult%3CO%2C%20I%3E%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<O, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="type" href="../combine/type.ParseResult.html" title="type combine::ParseResult">ParseResult</a><O, I>> for <a class="type" href="../combine/type.ConsumedResult.html" title="type combine::ConsumedResult">ConsumedResult</a><O, I> <span class="where fmt-newline">where<br> I: <a class="trait" href="../combine/trait.StreamOnce.html" title="trait combine::StreamOnce">StreamOnce</a>, </span></code><a href='#impl-From%3CParseResult%3CO%2C%20I%3E%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/combine/primitives.rs.html#1356-1369' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(result: <a class="type" href="../combine/type.ParseResult.html" title="type combine::ParseResult">ParseResult</a><O, I>) -> <a class="type" href="../combine/type.ConsumedResult.html" title="type combine::ConsumedResult">ConsumedResult</a><O, I></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/combine/primitives.rs.html#1360-1368' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></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> |