edlang/winnow/ascii/fn.digit0.html
2024-08-01 07:04:26 +00:00

28 lines
7.6 KiB
HTML
Raw Permalink 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 zero or more ASCII numerical characters: `&#x27;0&#x27;..=&#x27;9&#x27;`"><title>digit0 in winnow::ascii - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.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.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><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.18</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"><rustdoc-search></rustdoc-search><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="#">digit0</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/winnow/ascii/mod.rs.html#506-513">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 digit0&lt;Input, Error&gt;(
input: <a class="primitive" href="https://doc.rust-lang.org/1.80.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>,
&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>,
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 zero or more ASCII numerical characters: <code>'0'..='9'</code></p>
<p><em>Complete version</em>: Will return an error if theres not enough input data,
or the whole input if no terminating token is found (a non digit character).</p>
<p><em>[Partial version][crate::_topic::partial]</em>: Will return <code>Err(winnow::error::ErrMode::Incomplete(_))</code> if theres not enough input data,
or if no terminating token is found (a non digit character).</p>
<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>:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">pub fn </span>digit0&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 class="doc-anchor" href="#example">§</a>Example</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; {
digit0.parse_next(input)
}
<span class="macro">assert_eq!</span>(parser.parse_peek(<span class="string">"21c"</span>), <span class="prelude-val">Ok</span>((<span class="string">"c"</span>, <span class="string">"21"</span>)));
<span class="macro">assert_eq!</span>(parser.parse_peek(<span class="string">"21"</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="string">"21"</span>)));
<span class="macro">assert_eq!</span>(parser.parse_peek(<span class="string">"a21c"</span>), <span class="prelude-val">Ok</span>((<span class="string">"a21c"</span>, <span class="string">""</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>)));</code></pre></div>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(digit0::&lt;<span class="kw">_</span>, InputError&lt;<span class="kw">_</span>&gt;&gt;.parse_peek(Partial::new(<span class="string">"21c"</span>)), <span class="prelude-val">Ok</span>((Partial::new(<span class="string">"c"</span>), <span class="string">"21"</span>)));
<span class="macro">assert_eq!</span>(digit0::&lt;<span class="kw">_</span>, InputError&lt;<span class="kw">_</span>&gt;&gt;.parse_peek(Partial::new(<span class="string">"a21c"</span>)), <span class="prelude-val">Ok</span>((Partial::new(<span class="string">"a21c"</span>), <span class="string">""</span>)));
<span class="macro">assert_eq!</span>(digit0::&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::new(<span class="number">1</span>))));</code></pre></div>
</div></details></section></div></main></body></html>