rust/tantivy
1
0
Fork 0
mirror of https://github.com/quickwit-oss/tantivy.git synced 2026-06-01 08:00:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
63a070c83236ffc691830bf40bb4701e07e2b4ac
tantivy/master/combine/parser/item/index.html
Travis CI User 63a070c832 Automatic Travis documentation build
2019-06-16 03:00:46 +00:00

18 lines
9.2 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `item` mod in crate `combine`."><meta name="keywords" content="rust, rustlang, rust-lang, item"><title>combine::parser::item - 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">&#9776;</div><a href='../../../combine/index.html'><img src='../../../rust-logo.png' alt='logo' width='100'></a><p class='location'>Module item</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../../index.html'>combine</a>::<wbr><a href='../index.html'>parser</a></p><script>window.sidebarCurrent = {name: 'item', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../../src/combine/parser/item.rs.html#1-686' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>combine</a>::<wbr><a href='../index.html'>parser</a>::<wbr><a class="mod" href=''>item</a></span></h1><div class='docblock'><p>Parsers working with single stream items.</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.Any.html" title='combine::parser::item::Any struct'>Any</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Eof.html" title='combine::parser::item::Eof struct'>Eof</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.NoneOf.html" title='combine::parser::item::NoneOf struct'>NoneOf</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.OneOf.html" title='combine::parser::item::OneOf struct'>OneOf</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Position.html" title='combine::parser::item::Position struct'>Position</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Satisfy.html" title='combine::parser::item::Satisfy struct'>Satisfy</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SatisfyMap.html" title='combine::parser::item::SatisfyMap struct'>SatisfyMap</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Token.html" title='combine::parser::item::Token struct'>Token</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Tokens.html" title='combine::parser::item::Tokens struct'>Tokens</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Tokens2.html" title='combine::parser::item::Tokens2 struct'>Tokens2</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Value.html" title='combine::parser::item::Value struct'>Value</a></td><td class='docblock-short'></td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table><tr class='module-item'><td><a class="fn" href="fn.any.html" title='combine::parser::item::any fn'>any</a></td><td class='docblock-short'><p>Parses any token.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.eof.html" title='combine::parser::item::eof fn'>eof</a></td><td class='docblock-short'><p>Succeeds only if the stream is at end of input, fails otherwise.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.item.html" title='combine::parser::item::item fn'>item</a></td><td class='docblock-short'><p>Parses a character and succeeds if the character is equal to <code>c</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.none_of.html" title='combine::parser::item::none_of fn'>none_of</a></td><td class='docblock-short'><p>Extract one token and succeeds if it is not part of <code>tokens</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.one_of.html" title='combine::parser::item::one_of fn'>one_of</a></td><td class='docblock-short'><p>Extract one token and succeeds if it is part of <code>tokens</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.position.html" title='combine::parser::item::position fn'>position</a></td><td class='docblock-short'><p>Parser which just returns the current position in the stream.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.satisfy.html" title='combine::parser::item::satisfy fn'>satisfy</a></td><td class='docblock-short'><p>Parses a token and succeeds depending on the result of <code>predicate</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.satisfy_map.html" title='combine::parser::item::satisfy_map fn'>satisfy_map</a></td><td class='docblock-short'><p>Parses a token and passes it to <code>predicate</code>. If <code>predicate</code> returns <code>Some</code> the parser succeeds
and returns the value inside the <code>Option</code>. If <code>predicate</code> returns <code>None</code> the parser fails
without consuming any input.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.token.html" title='combine::parser::item::token fn'>token</a></td><td class='docblock-short'><p>Parses a character and succeeds if the character is equal to <code>c</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.tokens.html" title='combine::parser::item::tokens fn'>tokens</a></td><td class='docblock-short'><p>Parses multiple tokens.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.tokens2.html" title='combine::parser::item::tokens2 fn'>tokens2</a></td><td class='docblock-short'><p>Parses multiple tokens.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.value.html" title='combine::parser::item::value fn'>value</a></td><td class='docblock-short'><p>Always returns the value <code>v</code> without consuming any input.</p>
</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>&#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><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 View Git Blame Copy Permalink