mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 08:28:24 +00:00
16 lines
5.1 KiB
HTML
16 lines
5.1 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="Match the end of the `Stream`"><title>eof in winnow::combinator - 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.16</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"><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">combinator</a>::<wbr><a class="fn" href="#">eof</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/combinator/core.rs.html#220-233">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn eof<Input, Error>(
|
|
input: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&mut Input</a>,
|
|
) -> <a class="type" href="../error/type.PResult.html" title="type winnow::error::PResult">PResult</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.Slice" title="type winnow::stream::Stream::Slice">Slice</a>, Error><div class="where">where
|
|
Input: <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</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>Match the end of the <a href="../stream/trait.Stream.html" title="trait winnow::stream::Stream"><code>Stream</code></a></p>
|
|
<p>Otherwise, it will error.</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>:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">pub fn </span>eof<<span class="lifetime">'i</span>>(input: <span class="kw-2">&mut &</span><span class="lifetime">'i </span>str) -> PResult<<span class="kw-2">&</span><span class="lifetime">'i </span>str></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">let </span><span class="kw-2">mut </span>parser = eof;
|
|
<span class="macro">assert_eq!</span>(parser.parse_peek(<span class="string">"abc"</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">"abc"</span>, ErrorKind::Eof))));
|
|
<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></details></section></div></main></body></html> |