edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-09-20 09:34:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/winnow/combinator/fn.repeat.html
edg-l 99e2ddd36f deploy: 39fc7f2b9f
2024-03-27 11:12:16 +00:00

67 lines
12 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="`Accumulate` the output of a parser into a container, like `Vec`"><title>repeat in winnow::combinator - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-5bc39a1768837dd0.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="winnow" data-themes="" data-resource-suffix="" data-rustdoc-version="1.77.0 (aedd173a2 2024-03-17)" data-channel="1.77.0" data-search-js="search-dd67cee4cfa65049.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-48f368f3872407c8.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../winnow/index.html">winnow</a><span class="version">0.6.5</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In winnow::combinator</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../winnow/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">winnow</a>::<wbr><a href="index.html">combinator</a>::<wbr><a class="fn" href="#">repeat</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/winnow/combinator/multi.rs.html#109-127">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn repeat&lt;Input, Output, Accumulator, Error, ParseNext&gt;(
occurrences: impl <a class="trait" href="https://doc.rust-lang.org/1.77.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="../stream/struct.Range.html" title="struct winnow::stream::Range">Range</a>&gt;,
parser: ParseNext
) -&gt; <a class="struct" href="struct.Repeat.html" title="struct winnow::combinator::Repeat">Repeat</a>&lt;ParseNext, Input, Output, Accumulator, Error&gt;<div class="where">where
Input: <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>,
Accumulator: <a class="trait" href="../stream/trait.Accumulate.html" title="trait winnow::stream::Accumulate">Accumulate</a>&lt;Output&gt;,
ParseNext: <a class="trait" href="../trait.Parser.html" title="trait winnow::Parser">Parser</a>&lt;Input, Output, Error&gt;,
Error: <a class="trait" href="../error/trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a>&lt;Input&gt;,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><a href="../stream/trait.Accumulate.html" title="trait winnow::stream::Accumulate"><code>Accumulate</code></a> the output of a parser into a container, like <code>Vec</code></p>
<p>This stops before <code>n</code> when the parser returns <a href="../error/enum.ErrMode.html#variant.Backtrack" title="variant winnow::error::ErrMode::Backtrack"><code>ErrMode::Backtrack</code></a>. To instead chain an error up, see
<a href="fn.cut_err.html" title="fn winnow::combinator::cut_err"><code>cut_err</code></a>.</p>
<p>To recognize a series of tokens, <a href="../stream/trait.Accumulate.html" title="trait winnow::stream::Accumulate"><code>Accumulate</code></a> into a <code>()</code> and then <a href="../trait.Parser.html#method.recognize" title="method winnow::Parser::recognize"><code>Parser::recognize</code></a>.</p>
<p><strong>Warning:</strong> If the parser passed to <code>repeat</code> accepts empty inputs
(like <code>alpha0</code> or <code>digit0</code>), <code>repeat</code> will return an error,
to prevent going into an infinite loop.</p>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<p>Zero or more repetitions:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::combinator::repeat;
<span class="kw">fn </span>parser(s: <span class="kw-2">&amp;</span>str) -&gt; IResult&lt;<span class="kw-2">&amp;</span>str, Vec&lt;<span class="kw-2">&amp;</span>str&gt;&gt; {
repeat(<span class="number">0</span>.., <span class="string">"abc"</span>).parse_peek(s)
}
<span class="macro">assert_eq!</span>(parser(<span class="string">"abcabc"</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="macro">vec!</span>[<span class="string">"abc"</span>, <span class="string">"abc"</span>])));
<span class="macro">assert_eq!</span>(parser(<span class="string">"abc123"</span>), <span class="prelude-val">Ok</span>((<span class="string">"123"</span>, <span class="macro">vec!</span>[<span class="string">"abc"</span>])));
<span class="macro">assert_eq!</span>(parser(<span class="string">"123123"</span>), <span class="prelude-val">Ok</span>((<span class="string">"123123"</span>, <span class="macro">vec!</span>[])));
<span class="macro">assert_eq!</span>(parser(<span class="string">""</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="macro">vec!</span>[])));</code></pre></div>
<p>One or more repetitions:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::combinator::repeat;
<span class="kw">fn </span>parser(s: <span class="kw-2">&amp;</span>str) -&gt; IResult&lt;<span class="kw-2">&amp;</span>str, Vec&lt;<span class="kw-2">&amp;</span>str&gt;&gt; {
repeat(<span class="number">1</span>.., <span class="string">"abc"</span>).parse_peek(s)
}
<span class="macro">assert_eq!</span>(parser(<span class="string">"abcabc"</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="macro">vec!</span>[<span class="string">"abc"</span>, <span class="string">"abc"</span>])));
<span class="macro">assert_eq!</span>(parser(<span class="string">"abc123"</span>), <span class="prelude-val">Ok</span>((<span class="string">"123"</span>, <span class="macro">vec!</span>[<span class="string">"abc"</span>])));
<span class="macro">assert_eq!</span>(parser(<span class="string">"123123"</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">"123123"</span>, ErrorKind::Tag))));
<span class="macro">assert_eq!</span>(parser(<span class="string">""</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">""</span>, ErrorKind::Tag))));</code></pre></div>
<p>Fixed number of repetitions:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::combinator::repeat;
<span class="kw">fn </span>parser(s: <span class="kw-2">&amp;</span>str) -&gt; IResult&lt;<span class="kw-2">&amp;</span>str, Vec&lt;<span class="kw-2">&amp;</span>str&gt;&gt; {
repeat(<span class="number">2</span>, <span class="string">"abc"</span>).parse_peek(s)
}
<span class="macro">assert_eq!</span>(parser(<span class="string">"abcabc"</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="macro">vec!</span>[<span class="string">"abc"</span>, <span class="string">"abc"</span>])));
<span class="macro">assert_eq!</span>(parser(<span class="string">"abc123"</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">"123"</span>, ErrorKind::Tag))));
<span class="macro">assert_eq!</span>(parser(<span class="string">"123123"</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">"123123"</span>, ErrorKind::Tag))));
<span class="macro">assert_eq!</span>(parser(<span class="string">""</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">""</span>, ErrorKind::Tag))));
<span class="macro">assert_eq!</span>(parser(<span class="string">"abcabcabc"</span>), <span class="prelude-val">Ok</span>((<span class="string">"abc"</span>, <span class="macro">vec!</span>[<span class="string">"abc"</span>, <span class="string">"abc"</span>])));</code></pre></div>
<p>Arbitrary repetitions:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::combinator::repeat;
<span class="kw">fn </span>parser(s: <span class="kw-2">&amp;</span>str) -&gt; IResult&lt;<span class="kw-2">&amp;</span>str, Vec&lt;<span class="kw-2">&amp;</span>str&gt;&gt; {
repeat(<span class="number">0</span>..=<span class="number">2</span>, <span class="string">"abc"</span>).parse_peek(s)
}
<span class="macro">assert_eq!</span>(parser(<span class="string">"abcabc"</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="macro">vec!</span>[<span class="string">"abc"</span>, <span class="string">"abc"</span>])));
<span class="macro">assert_eq!</span>(parser(<span class="string">"abc123"</span>), <span class="prelude-val">Ok</span>((<span class="string">"123"</span>, <span class="macro">vec!</span>[<span class="string">"abc"</span>])));
<span class="macro">assert_eq!</span>(parser(<span class="string">"123123"</span>), <span class="prelude-val">Ok</span>((<span class="string">"123123"</span>, <span class="macro">vec!</span>[])));
<span class="macro">assert_eq!</span>(parser(<span class="string">""</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="macro">vec!</span>[])));
<span class="macro">assert_eq!</span>(parser(<span class="string">"abcabcabc"</span>), <span class="prelude-val">Ok</span>((<span class="string">"abc"</span>, <span class="macro">vec!</span>[<span class="string">"abc"</span>, <span class="string">"abc"</span>])));</code></pre></div>
</div></details></section></div></main></body></html>
Reference in a new issue View git blame Copy permalink