Files
tantivy/master/combine/parser/repeat/index.html
2019-06-16 03:00:46 +00:00

34 lines
13 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 `repeat` mod in crate `combine`."><meta name="keywords" content="rust, rustlang, rust-lang, repeat"><title>combine::parser::repeat - 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 repeat</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: 'repeat', 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/repeat.rs.html#1-1326' 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=''>repeat</a></span></h1><div class='docblock'><p>Combinators which take one or more parsers and applies them repeatedly.</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.Chainl1.html" title='combine::parser::repeat::Chainl1 struct'>Chainl1</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Chainr1.html" title='combine::parser::repeat::Chainr1 struct'>Chainr1</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Count.html" title='combine::parser::repeat::Count struct'>Count</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.CountMinMax.html" title='combine::parser::repeat::CountMinMax struct'>CountMinMax</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Escaped.html" title='combine::parser::repeat::Escaped struct'>Escaped</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.EscapedState.html" title='combine::parser::repeat::EscapedState struct'>EscapedState</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Iter.html" title='combine::parser::repeat::Iter struct'>Iter</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Many.html" title='combine::parser::repeat::Many struct'>Many</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Many1.html" title='combine::parser::repeat::Many1 struct'>Many1</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SepBy.html" title='combine::parser::repeat::SepBy struct'>SepBy</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SepBy1.html" title='combine::parser::repeat::SepBy1 struct'>SepBy1</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SepEndBy.html" title='combine::parser::repeat::SepEndBy struct'>SepEndBy</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SepEndBy1.html" title='combine::parser::repeat::SepEndBy1 struct'>SepEndBy1</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SkipCount.html" title='combine::parser::repeat::SkipCount struct'>SkipCount</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SkipCountMinMax.html" title='combine::parser::repeat::SkipCountMinMax struct'>SkipCountMinMax</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SkipMany.html" title='combine::parser::repeat::SkipMany struct'>SkipMany</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SkipMany1.html" title='combine::parser::repeat::SkipMany1 struct'>SkipMany1</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SkipUntil.html" title='combine::parser::repeat::SkipUntil struct'>SkipUntil</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.TakeUntil.html" title='combine::parser::repeat::TakeUntil struct'>TakeUntil</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.chainl1.html" title='combine::parser::repeat::chainl1 fn'>chainl1</a></td><td class='docblock-short'><p>Parses <code>p</code> 1 or more times separated by <code>op</code>. The value returned is the one produced by the
left associative application of the function returned by the parser <code>op</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.chainr1.html" title='combine::parser::repeat::chainr1 fn'>chainr1</a></td><td class='docblock-short'><p>Parses <code>p</code> one or more times separated by <code>op</code>. The value returned is the one produced by the
right associative application of the function returned by <code>op</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.count.html" title='combine::parser::repeat::count fn'>count</a></td><td class='docblock-short'><p>Parses <code>parser</code> from zero up to <code>count</code> times.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.count_min_max.html" title='combine::parser::repeat::count_min_max fn'>count_min_max</a></td><td class='docblock-short'><p>Parses <code>parser</code> from <code>min</code> to <code>max</code> times (including <code>min</code> and <code>max</code>).</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.escaped.html" title='combine::parser::repeat::escaped fn'>escaped</a></td><td class='docblock-short'><p>Parses an escaped string by first applying <code>parser</code> which accept the normal characters which do
not need escaping. Once <code>parser</code> can not consume any more input it checks if the next item
is <code>escape</code>. If it is then <code>escape_parser</code> is used to parse the escaped character and then
resumes parsing using <code>parser</code>. If <code>escape</code> was not found then the parser finishes
successfully.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.many.html" title='combine::parser::repeat::many fn'>many</a></td><td class='docblock-short'><p>Parses <code>p</code> zero or more times returning a collection with the values from <code>p</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.many1.html" title='combine::parser::repeat::many1 fn'>many1</a></td><td class='docblock-short'><p>Parses <code>p</code> one or more times returning a collection with the values from <code>p</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.sep_by.html" title='combine::parser::repeat::sep_by fn'>sep_by</a></td><td class='docblock-short'><p>Parses <code>parser</code> zero or more time separated by <code>separator</code>, returning a collection with the
values from <code>p</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.sep_by1.html" title='combine::parser::repeat::sep_by1 fn'>sep_by1</a></td><td class='docblock-short'><p>Parses <code>parser</code> one or more time separated by <code>separator</code>, returning a collection with the
values from <code>p</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.sep_end_by.html" title='combine::parser::repeat::sep_end_by fn'>sep_end_by</a></td><td class='docblock-short'><p>Parses <code>parser</code> zero or more times separated and ended by <code>separator</code>, returning a collection
with the values from <code>p</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.sep_end_by1.html" title='combine::parser::repeat::sep_end_by1 fn'>sep_end_by1</a></td><td class='docblock-short'><p>Parses <code>parser</code> one or more times separated and ended by <code>separator</code>, returning a collection
with the values from <code>p</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.skip_count.html" title='combine::parser::repeat::skip_count fn'>skip_count</a></td><td class='docblock-short'><p>Parses <code>parser</code> from zero up to <code>count</code> times skipping the output of <code>parser</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.skip_count_min_max.html" title='combine::parser::repeat::skip_count_min_max fn'>skip_count_min_max</a></td><td class='docblock-short'><p>Parses <code>parser</code> from <code>min</code> to <code>max</code> times (including <code>min</code> and <code>max</code>)
skipping the output of <code>parser</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.skip_many.html" title='combine::parser::repeat::skip_many fn'>skip_many</a></td><td class='docblock-short'><p>Parses <code>p</code> zero or more times ignoring the result.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.skip_many1.html" title='combine::parser::repeat::skip_many1 fn'>skip_many1</a></td><td class='docblock-short'><p>Parses <code>p</code> one or more times ignoring the result.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.skip_until.html" title='combine::parser::repeat::skip_until fn'>skip_until</a></td><td class='docblock-short'><p>Skips input until <code>end</code> is encountered or <code>end</code> indicates that it has consumed input before
failing (<code>attempt</code> can be used to make it look like it has not consumed any input)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.take_until.html" title='combine::parser::repeat::take_until fn'>take_until</a></td><td class='docblock-short'><p>Takes input until <code>end</code> is encountered or <code>end</code> indicates that it has consumed input before
failing (<code>attempt</code> can be used to make it look like it has not consumed 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>