mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-26 13:10:41 +00:00
19 lines
7.5 KiB
HTML
19 lines
7.5 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 `error` mod in crate `combine`."><meta name="keywords" content="rust, rustlang, rust-lang, error"><title>combine::error - 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 mod"><!--[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><p class='location'>Module error</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>combine</a></p><script>window.sidebarCurrent = {name: 'error', ty: 'mod', 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/error.rs.html#1-777' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>combine</a>::<wbr><a class="mod" href=''>error</a></span></h1><div class='docblock'><p>Error types and traits which define what kind of errors combine parsers may emit</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Tracked.html" title='combine::error::Tracked struct'>Tracked</a></td><td class='docblock-short'><p>Error wrapper which lets parsers track which parser in a sequence of sub-parsers has emitted
|
||
the error. <code>Tracked::from</code> can be used to construct this and it should otherwise be
|
||
ignored outside of combine.</p>
|
||
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table><tr class='module-item'><td><a class="enum" href="enum.Consumed.html" title='combine::error::Consumed enum'>Consumed</a></td><td class='docblock-short'><p>Enum used to indicate if a parser consumed any items of the stream it was given as an input.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.FastResult.html" title='combine::error::FastResult enum'>FastResult</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.Info.html" title='combine::error::Info enum'>Info</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.StringStreamError.html" title='combine::error::StringStreamError enum'>StringStreamError</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.UnexpectedParse.html" title='combine::error::UnexpectedParse enum'>UnexpectedParse</a></td><td class='docblock-short'></td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table><tr class='module-item'><td><a class="trait" href="trait.ParseError.html" title='combine::error::ParseError trait'>ParseError</a></td><td class='docblock-short'><p>Trait which defines a combine parse error.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.StreamError.html" title='combine::error::StreamError trait'>StreamError</a></td><td class='docblock-short'><p><code>StreamError</code> represents a single error returned from a <code>Stream</code> or a <code>Parser</code>.</p>
|
||
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
||
<table><tr class='module-item'><td><a class="type" href="type.ConsumedResult.html" title='combine::error::ConsumedResult type'>ConsumedResult</a></td><td class='docblock-short'><p>A <code>Result</code> type which has the consumed status flattened into the result.
|
||
Conversions to and from <code>std::result::Result</code> can be done using <code>result.into()</code> or
|
||
<code>From::from(result)</code></p>
|
||
</td></tr><tr class='module-item'><td><a class="type" href="type.ParseResult.html" title='combine::error::ParseResult type'>ParseResult</a></td><td class='docblock-short'><p>A type alias over the specific <code>Result</code> type used by parsers to indicate whether 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>
|
||
</td></tr><tr class='module-item'><td><a class="type" href="type.ParseResult2.html" title='combine::error::ParseResult2 type'>ParseResult2</a></td><td class='docblock-short'></td></tr></table></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> |