edlang/winnow/ascii/fn.till_line_ending.html
2024-03-11 08:39:13 +00:00

31 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="Recognizes a string of any char except `&quot;\r\n&quot;` or `&quot;\n&quot;`."><title>till_line_ending in winnow::ascii - 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-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.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">&#9776;</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::ascii</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">ascii</a>::<wbr><a class="fn" href="#">till_line_ending</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/ascii/mod.rs.html#155-169">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 till_line_ending&lt;Input, Error&gt;(
input: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&amp;mut Input</a>
) -&gt; <a class="type" href="../error/type.PResult.html" title="type winnow::error::PResult">PResult</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.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> + <a class="trait" href="../stream/trait.Compare.html" title="trait winnow::stream::Compare">Compare</a>&lt;&amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>&gt; + <a class="trait" href="../stream/trait.FindSlice.html" title="trait winnow::stream::FindSlice">FindSlice</a>&lt;(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.char.html">char</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.char.html">char</a>)&gt;,
&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>: <a class="trait" href="../stream/trait.AsChar.html" title="trait winnow::stream::AsChar">AsChar</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
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>Recognizes a string of any char except <code>&quot;\r\n&quot;</code> or <code>&quot;\n&quot;</code>.</p>
<p><em>Complete version</em>: Will return an error if theres not enough input data.</p>
<p><em>[Partial version][crate::_topic::partial]</em>: Will return <code>Err(winnow::error::ErrMode::Incomplete(_))</code> if theres not enough input data.</p>
<h2 id="effective-signature"><a href="#effective-signature">Effective Signature</a></h2>
<p>Assuming you are parsing a <code>&amp;str</code> <a href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">pub fn </span>till_line_ending&lt;<span class="lifetime">'i</span>&gt;(input: <span class="kw-2">&amp;mut &amp;</span><span class="lifetime">'i </span>str) -&gt; PResult&lt;<span class="kw-2">&amp;</span><span class="lifetime">'i </span>str&gt;</code></pre></div>
<h2 id="example"><a href="#example">Example</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">fn </span>parser&lt;<span class="lifetime">'s</span>&gt;(input: <span class="kw-2">&amp;mut &amp;</span><span class="lifetime">'s </span>str) -&gt; PResult&lt;<span class="kw-2">&amp;</span><span class="lifetime">'s </span>str, InputError&lt;<span class="kw-2">&amp;</span><span class="lifetime">'s </span>str&gt;&gt; {
till_line_ending.parse_next(input)
}
<span class="macro">assert_eq!</span>(parser.parse_peek(<span class="string">"ab\r\nc"</span>), <span class="prelude-val">Ok</span>((<span class="string">"\r\nc"</span>, <span class="string">"ab"</span>)));
<span class="macro">assert_eq!</span>(parser.parse_peek(<span class="string">"ab\nc"</span>), <span class="prelude-val">Ok</span>((<span class="string">"\nc"</span>, <span class="string">"ab"</span>)));
<span class="macro">assert_eq!</span>(parser.parse_peek(<span class="string">"abc"</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="string">"abc"</span>)));
<span class="macro">assert_eq!</span>(parser.parse_peek(<span class="string">""</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="string">""</span>)));
<span class="macro">assert_eq!</span>(parser.parse_peek(<span class="string">"a\rb\nc"</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">"\rb\nc"</span>, ErrorKind::Tag ))));
<span class="macro">assert_eq!</span>(parser.parse_peek(<span class="string">"a\rbc"</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">"\rbc"</span>, ErrorKind::Tag ))));</code></pre></div>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(till_line_ending::&lt;<span class="kw">_</span>, InputError&lt;<span class="kw">_</span>&gt;&gt;.parse_peek(Partial::new(<span class="string">"ab\r\nc"</span>)), <span class="prelude-val">Ok</span>((Partial::new(<span class="string">"\r\nc"</span>), <span class="string">"ab"</span>)));
<span class="macro">assert_eq!</span>(till_line_ending::&lt;<span class="kw">_</span>, InputError&lt;<span class="kw">_</span>&gt;&gt;.parse_peek(Partial::new(<span class="string">"abc"</span>)), <span class="prelude-val">Err</span>(ErrMode::Incomplete(Needed::Unknown)));
<span class="macro">assert_eq!</span>(till_line_ending::&lt;<span class="kw">_</span>, InputError&lt;<span class="kw">_</span>&gt;&gt;.parse_peek(Partial::new(<span class="string">""</span>)), <span class="prelude-val">Err</span>(ErrMode::Incomplete(Needed::Unknown)));
<span class="macro">assert_eq!</span>(till_line_ending::&lt;<span class="kw">_</span>, InputError&lt;<span class="kw">_</span>&gt;&gt;.parse_peek(Partial::new(<span class="string">"a\rb\nc"</span>)), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(Partial::new(<span class="string">"\rb\nc"</span>), ErrorKind::Tag ))));
<span class="macro">assert_eq!</span>(till_line_ending::&lt;<span class="kw">_</span>, InputError&lt;<span class="kw">_</span>&gt;&gt;.parse_peek(Partial::new(<span class="string">"a\rbc"</span>)), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(Partial::new(<span class="string">"\rbc"</span>), ErrorKind::Tag ))));</code></pre></div>
</div></details></section></div></main></body></html>