mirror of
https://github.com/edg-l/edlang.git
synced 2024-10-18 15:08:17 +00:00
113 lines
19 KiB
HTML
113 lines
19 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="Recognize the longest (m <= len <= n) input slice that matches a set of tokens"><title>take_while in winnow::token - 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.1 (7cf61ebde 2024-03-27)" data-channel="1.77.1" 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::token</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">token</a>::<wbr><a class="fn" href="#">take_while</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/token/mod.rs.html#478-517">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn take_while<Set, Input, Error>(
|
||
occurrences: impl <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../stream/struct.Range.html" title="struct winnow::stream::Range">Range</a>>,
|
||
set: Set
|
||
) -> impl <a class="trait" href="../trait.Parser.html" title="trait winnow::Parser">Parser</a><Input, <Input as <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>>::<a class="associatedtype" href="../stream/trait.Stream.html#associatedtype.Slice" title="type winnow::stream::Stream::Slice">Slice</a>, Error><div class="where">where
|
||
Input: <a class="trait" href="../stream/trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a> + <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>,
|
||
Set: <a class="trait" href="../stream/trait.ContainsToken.html" title="trait winnow::stream::ContainsToken">ContainsToken</a><<Input as <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>>::<a class="associatedtype" href="../stream/trait.Stream.html#associatedtype.Token" title="type winnow::stream::Stream::Token">Token</a>>,
|
||
Error: <a class="trait" href="../error/trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a><Input>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Recognize the longest (m <= len <= n) input slice that matches a <a href="../stream/trait.ContainsToken.html" title="trait winnow::stream::ContainsToken">set of tokens</a></p>
|
||
<p>It will return an <code>ErrMode::Backtrack(InputError::new(_, ErrorKind::Slice))</code> if the set of tokens wasn’t met or is out
|
||
of range (m <= len <= n).</p>
|
||
<p><em>[Partial version][crate::_topic::partial]</em> will return a <code>ErrMode::Incomplete(Needed::new(1))</code> if a member of the set of tokens reaches the end of the input or is too short.</p>
|
||
<p>To recognize a series of tokens, use <a href="../combinator/fn.repeat.html" title="fn winnow::combinator::repeat"><code>repeat</code></a> to <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>
|
||
<h2 id="effective-signature"><a class="doc-anchor" href="#effective-signature">§</a>Effective Signature</h2>
|
||
<p>Assuming you are parsing a <code>&str</code> <a href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a> with <code>0..</code> or <code>1..</code> <a href="../stream/struct.Range.html" title="struct winnow::stream::Range">ranges</a>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">pub fn </span>take_while<<span class="lifetime">'i</span>>(occurrences: RangeFrom<usize>, set: <span class="kw">impl </span>ContainsToken<char>) -> <span class="kw">impl </span>Parser<<span class="kw-2">&</span><span class="lifetime">'i </span>str, <span class="kw-2">&</span><span class="lifetime">'i </span>str, ContextError></code></pre></div>
|
||
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
||
<p>Zero or more tokens:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::token::take_while;
|
||
<span class="kw">use </span>winnow::stream::AsChar;
|
||
|
||
<span class="kw">fn </span>alpha(s: <span class="kw-2">&</span>[u8]) -> IResult<<span class="kw-2">&</span>[u8], <span class="kw-2">&</span>[u8]> {
|
||
take_while(<span class="number">0</span>.., AsChar::is_alpha).parse_peek(s)
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(alpha(<span class="string">b"latin123"</span>), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"123"</span>[..], <span class="kw-2">&</span><span class="string">b"latin"</span>[..])));
|
||
<span class="macro">assert_eq!</span>(alpha(<span class="string">b"12345"</span>), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"12345"</span>[..], <span class="kw-2">&</span><span class="string">b""</span>[..])));
|
||
<span class="macro">assert_eq!</span>(alpha(<span class="string">b"latin"</span>), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b""</span>[..], <span class="kw-2">&</span><span class="string">b"latin"</span>[..])));
|
||
<span class="macro">assert_eq!</span>(alpha(<span class="string">b""</span>), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b""</span>[..], <span class="kw-2">&</span><span class="string">b""</span>[..])));</code></pre></div>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::token::take_while;
|
||
<span class="kw">use </span>winnow::stream::AsChar;
|
||
|
||
<span class="kw">fn </span>alpha(s: Partial<<span class="kw-2">&</span>[u8]>) -> IResult<Partial<<span class="kw-2">&</span>[u8]>, <span class="kw-2">&</span>[u8]> {
|
||
take_while(<span class="number">0</span>.., AsChar::is_alpha).parse_peek(s)
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(alpha(Partial::new(<span class="string">b"latin123"</span>)), <span class="prelude-val">Ok</span>((Partial::new(<span class="kw-2">&</span><span class="string">b"123"</span>[..]), <span class="kw-2">&</span><span class="string">b"latin"</span>[..])));
|
||
<span class="macro">assert_eq!</span>(alpha(Partial::new(<span class="string">b"12345"</span>)), <span class="prelude-val">Ok</span>((Partial::new(<span class="kw-2">&</span><span class="string">b"12345"</span>[..]), <span class="kw-2">&</span><span class="string">b""</span>[..])));
|
||
<span class="macro">assert_eq!</span>(alpha(Partial::new(<span class="string">b"latin"</span>)), <span class="prelude-val">Err</span>(ErrMode::Incomplete(Needed::new(<span class="number">1</span>))));
|
||
<span class="macro">assert_eq!</span>(alpha(Partial::new(<span class="string">b""</span>)), <span class="prelude-val">Err</span>(ErrMode::Incomplete(Needed::new(<span class="number">1</span>))));</code></pre></div>
|
||
<p>One or more tokens:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::token::take_while;
|
||
<span class="kw">use </span>winnow::stream::AsChar;
|
||
|
||
<span class="kw">fn </span>alpha(s: <span class="kw-2">&</span>[u8]) -> IResult<<span class="kw-2">&</span>[u8], <span class="kw-2">&</span>[u8]> {
|
||
take_while(<span class="number">1</span>.., AsChar::is_alpha).parse_peek(s)
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(alpha(<span class="string">b"latin123"</span>), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"123"</span>[..], <span class="kw-2">&</span><span class="string">b"latin"</span>[..])));
|
||
<span class="macro">assert_eq!</span>(alpha(<span class="string">b"latin"</span>), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b""</span>[..], <span class="kw-2">&</span><span class="string">b"latin"</span>[..])));
|
||
<span class="macro">assert_eq!</span>(alpha(<span class="string">b"12345"</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="kw-2">&</span><span class="string">b"12345"</span>[..], ErrorKind::Slice))));
|
||
|
||
<span class="kw">fn </span>hex(s: <span class="kw-2">&</span>str) -> IResult<<span class="kw-2">&</span>str, <span class="kw-2">&</span>str> {
|
||
take_while(<span class="number">1</span>.., (<span class="string">'0'</span>..=<span class="string">'9'</span>, <span class="string">'A'</span>..=<span class="string">'F'</span>)).parse_peek(s)
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(hex(<span class="string">"123 and voila"</span>), <span class="prelude-val">Ok</span>((<span class="string">" and voila"</span>, <span class="string">"123"</span>)));
|
||
<span class="macro">assert_eq!</span>(hex(<span class="string">"DEADBEEF and others"</span>), <span class="prelude-val">Ok</span>((<span class="string">" and others"</span>, <span class="string">"DEADBEEF"</span>)));
|
||
<span class="macro">assert_eq!</span>(hex(<span class="string">"BADBABEsomething"</span>), <span class="prelude-val">Ok</span>((<span class="string">"something"</span>, <span class="string">"BADBABE"</span>)));
|
||
<span class="macro">assert_eq!</span>(hex(<span class="string">"D15EA5E"</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="string">"D15EA5E"</span>)));
|
||
<span class="macro">assert_eq!</span>(hex(<span class="string">""</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">""</span>, ErrorKind::Slice))));</code></pre></div>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::token::take_while;
|
||
<span class="kw">use </span>winnow::stream::AsChar;
|
||
|
||
<span class="kw">fn </span>alpha(s: Partial<<span class="kw-2">&</span>[u8]>) -> IResult<Partial<<span class="kw-2">&</span>[u8]>, <span class="kw-2">&</span>[u8]> {
|
||
take_while(<span class="number">1</span>.., AsChar::is_alpha).parse_peek(s)
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(alpha(Partial::new(<span class="string">b"latin123"</span>)), <span class="prelude-val">Ok</span>((Partial::new(<span class="kw-2">&</span><span class="string">b"123"</span>[..]), <span class="kw-2">&</span><span class="string">b"latin"</span>[..])));
|
||
<span class="macro">assert_eq!</span>(alpha(Partial::new(<span class="string">b"latin"</span>)), <span class="prelude-val">Err</span>(ErrMode::Incomplete(Needed::new(<span class="number">1</span>))));
|
||
<span class="macro">assert_eq!</span>(alpha(Partial::new(<span class="string">b"12345"</span>)), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(Partial::new(<span class="kw-2">&</span><span class="string">b"12345"</span>[..]), ErrorKind::Slice))));
|
||
|
||
<span class="kw">fn </span>hex(s: Partial<<span class="kw-2">&</span>str>) -> IResult<Partial<<span class="kw-2">&</span>str>, <span class="kw-2">&</span>str> {
|
||
take_while(<span class="number">1</span>.., (<span class="string">'0'</span>..=<span class="string">'9'</span>, <span class="string">'A'</span>..=<span class="string">'F'</span>)).parse_peek(s)
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(hex(Partial::new(<span class="string">"123 and voila"</span>)), <span class="prelude-val">Ok</span>((Partial::new(<span class="string">" and voila"</span>), <span class="string">"123"</span>)));
|
||
<span class="macro">assert_eq!</span>(hex(Partial::new(<span class="string">"DEADBEEF and others"</span>)), <span class="prelude-val">Ok</span>((Partial::new(<span class="string">" and others"</span>), <span class="string">"DEADBEEF"</span>)));
|
||
<span class="macro">assert_eq!</span>(hex(Partial::new(<span class="string">"BADBABEsomething"</span>)), <span class="prelude-val">Ok</span>((Partial::new(<span class="string">"something"</span>), <span class="string">"BADBABE"</span>)));
|
||
<span class="macro">assert_eq!</span>(hex(Partial::new(<span class="string">"D15EA5E"</span>)), <span class="prelude-val">Err</span>(ErrMode::Incomplete(Needed::new(<span class="number">1</span>))));
|
||
<span class="macro">assert_eq!</span>(hex(Partial::new(<span class="string">""</span>)), <span class="prelude-val">Err</span>(ErrMode::Incomplete(Needed::new(<span class="number">1</span>))));</code></pre></div>
|
||
<p>Arbitrary amount of tokens:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::token::take_while;
|
||
<span class="kw">use </span>winnow::stream::AsChar;
|
||
|
||
<span class="kw">fn </span>short_alpha(s: <span class="kw-2">&</span>[u8]) -> IResult<<span class="kw-2">&</span>[u8], <span class="kw-2">&</span>[u8]> {
|
||
take_while(<span class="number">3</span>..=<span class="number">6</span>, AsChar::is_alpha).parse_peek(s)
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(short_alpha(<span class="string">b"latin123"</span>), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"123"</span>[..], <span class="kw-2">&</span><span class="string">b"latin"</span>[..])));
|
||
<span class="macro">assert_eq!</span>(short_alpha(<span class="string">b"lengthy"</span>), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"y"</span>[..], <span class="kw-2">&</span><span class="string">b"length"</span>[..])));
|
||
<span class="macro">assert_eq!</span>(short_alpha(<span class="string">b"latin"</span>), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b""</span>[..], <span class="kw-2">&</span><span class="string">b"latin"</span>[..])));
|
||
<span class="macro">assert_eq!</span>(short_alpha(<span class="string">b"ed"</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="kw-2">&</span><span class="string">b"ed"</span>[..], ErrorKind::Slice))));
|
||
<span class="macro">assert_eq!</span>(short_alpha(<span class="string">b"12345"</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="kw-2">&</span><span class="string">b"12345"</span>[..], ErrorKind::Slice))));</code></pre></div>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::token::take_while;
|
||
<span class="kw">use </span>winnow::stream::AsChar;
|
||
|
||
<span class="kw">fn </span>short_alpha(s: Partial<<span class="kw-2">&</span>[u8]>) -> IResult<Partial<<span class="kw-2">&</span>[u8]>, <span class="kw-2">&</span>[u8]> {
|
||
take_while(<span class="number">3</span>..=<span class="number">6</span>, AsChar::is_alpha).parse_peek(s)
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(short_alpha(Partial::new(<span class="string">b"latin123"</span>)), <span class="prelude-val">Ok</span>((Partial::new(<span class="kw-2">&</span><span class="string">b"123"</span>[..]), <span class="kw-2">&</span><span class="string">b"latin"</span>[..])));
|
||
<span class="macro">assert_eq!</span>(short_alpha(Partial::new(<span class="string">b"lengthy"</span>)), <span class="prelude-val">Ok</span>((Partial::new(<span class="kw-2">&</span><span class="string">b"y"</span>[..]), <span class="kw-2">&</span><span class="string">b"length"</span>[..])));
|
||
<span class="macro">assert_eq!</span>(short_alpha(Partial::new(<span class="string">b"latin"</span>)), <span class="prelude-val">Err</span>(ErrMode::Incomplete(Needed::new(<span class="number">1</span>))));
|
||
<span class="macro">assert_eq!</span>(short_alpha(Partial::new(<span class="string">b"ed"</span>)), <span class="prelude-val">Err</span>(ErrMode::Incomplete(Needed::new(<span class="number">1</span>))));
|
||
<span class="macro">assert_eq!</span>(short_alpha(Partial::new(<span class="string">b"12345"</span>)), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(Partial::new(<span class="kw-2">&</span><span class="string">b"12345"</span>[..]), ErrorKind::Slice))));</code></pre></div>
|
||
</div></details></section></div></main></body></html> |