edlang/winnow/token/fn.take_till.html
2024-03-27 11:12:16 +00:00

43 lines
10 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="Recognize the longest input slice (if any) till a member of a set of tokens is found."><title>take_till 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.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::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_till</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#739-778">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 take_till&lt;Set, Input, Error&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;,
set: Set
) -&gt; impl <a class="trait" href="../trait.Parser.html" title="trait winnow::Parser">Parser</a>&lt;Input, &lt;Input as <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>&gt;::<a class="associatedtype" href="../stream/trait.Stream.html#associatedtype.Slice" title="type winnow::stream::Stream::Slice">Slice</a>, Error&gt;<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>&lt;&lt;Input as <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>&gt;::<a class="associatedtype" href="../stream/trait.Stream.html#associatedtype.Token" title="type winnow::stream::Stream::Token">Token</a>&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>Recognize the longest input slice (if any) till a member of a <a href="../stream/trait.ContainsToken.html" title="trait winnow::stream::ContainsToken">set of tokens</a> is found.</p>
<p>It doesnt consume the terminating token from the set.</p>
<p><em>[Partial version][crate::_topic::partial]</em> will return a <code>ErrMode::Incomplete(Needed::new(1))</code> if the match reaches the
end of input or if there was not match.</p>
<p>See also</p>
<ul>
<li><a href="fn.take_until.html" title="fn winnow::token::take_until"><code>take_until</code></a> for recognizing up-to a <a href="fn.literal.html" title="fn winnow::token::literal"><code>literal</code></a> (w/ optional simd optimizations)</li>
<li><a href="../combinator/fn.repeat_till.html" title="fn winnow::combinator::repeat_till"><code>repeat_till</code></a> with <a href="../trait.Parser.html#method.recognize" title="method winnow::Parser::recognize"><code>Parser::recognize</code></a> for recognizing up to a <a href="../trait.Parser.html" title="trait winnow::Parser"><code>Parser</code></a></li>
</ul>
<h2 id="effective-signature"><a class="doc-anchor" href="#effective-signature">§</a>Effective Signature</h2>
<p>Assuming you are parsing a <code>&amp;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_till&lt;<span class="lifetime">'i</span>&gt;(occurrences: RangeFrom&lt;usize&gt;, set: <span class="kw">impl </span>ContainsToken&lt;char&gt;) -&gt; <span class="kw">impl </span>Parser&lt;<span class="kw-2">&amp;</span><span class="lifetime">'i </span>str, <span class="kw-2">&amp;</span><span class="lifetime">'i </span>str, ContextError&gt;</code></pre></div>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::token::take_till;
<span class="kw">fn </span>till_colon(s: <span class="kw-2">&amp;</span>str) -&gt; IResult&lt;<span class="kw-2">&amp;</span>str, <span class="kw-2">&amp;</span>str&gt; {
take_till(<span class="number">0</span>.., |c| c == <span class="string">':'</span>).parse_peek(s)
}
<span class="macro">assert_eq!</span>(till_colon(<span class="string">"latin:123"</span>), <span class="prelude-val">Ok</span>((<span class="string">":123"</span>, <span class="string">"latin"</span>)));
<span class="macro">assert_eq!</span>(till_colon(<span class="string">":empty matched"</span>), <span class="prelude-val">Ok</span>((<span class="string">":empty matched"</span>, <span class="string">""</span>))); <span class="comment">//allowed
</span><span class="macro">assert_eq!</span>(till_colon(<span class="string">"12345"</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="string">"12345"</span>)));
<span class="macro">assert_eq!</span>(till_colon(<span class="string">""</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="string">""</span>)));</code></pre></div>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::token::take_till;
<span class="kw">fn </span>till_colon(s: Partial&lt;<span class="kw-2">&amp;</span>str&gt;) -&gt; IResult&lt;Partial&lt;<span class="kw-2">&amp;</span>str&gt;, <span class="kw-2">&amp;</span>str&gt; {
take_till(<span class="number">0</span>.., |c| c == <span class="string">':'</span>).parse_peek(s)
}
<span class="macro">assert_eq!</span>(till_colon(Partial::new(<span class="string">"latin:123"</span>)), <span class="prelude-val">Ok</span>((Partial::new(<span class="string">":123"</span>), <span class="string">"latin"</span>)));
<span class="macro">assert_eq!</span>(till_colon(Partial::new(<span class="string">":empty matched"</span>)), <span class="prelude-val">Ok</span>((Partial::new(<span class="string">":empty matched"</span>), <span class="string">""</span>))); <span class="comment">//allowed
</span><span class="macro">assert_eq!</span>(till_colon(Partial::new(<span class="string">"12345"</span>)), <span class="prelude-val">Err</span>(ErrMode::Incomplete(Needed::new(<span class="number">1</span>))));
<span class="macro">assert_eq!</span>(till_colon(Partial::new(<span class="string">""</span>)), <span class="prelude-val">Err</span>(ErrMode::Incomplete(Needed::new(<span class="number">1</span>))));</code></pre></div>
</div></details></section></div></main></body></html>