15 lines
9.9 KiB
HTML
15 lines
9.9 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="API documentation for the Rust `AtEof` trait in crate `nom`."><meta name="keywords" content="rust, rustlang, rust-lang, AtEof"><title>nom::AtEof - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../nom/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait AtEof</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.at_eof">at_eof</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-AtEof-for-%26%27a%20%5BT%5D">&'a [T]</a><a href="#impl-AtEof-for-%26%27a%20str">&'a str</a><a href="#impl-AtEof-for-(I%2C%20T)">(I, T)</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>nom</a></p><script>window.sidebarCurrent = {name: 'AtEof', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/nom/traits.rs.html#961-963' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>nom</a>::<wbr><a class="trait" href=''>AtEof</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait AtEof {
|
||
fn <a href='#tymethod.at_eof' class='fnname'>at_eof</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
||
}</pre></div><div class='docblock'><p>indicates whether more data can come later in input</p>
|
||
<p>When working with complete data, like a file that was entirely loaded
|
||
in memory, you should use input types like <code>CompleteByteSlice</code> and
|
||
<code>CompleteStr</code> to wrap the data. The <code>at_eof</code> method of those types
|
||
always returns true, thus indicating to nom that it should not handle
|
||
partial data cases.</p>
|
||
<p>When working will partial data, like data coming from the network in
|
||
buffers, the <code>at_eof</code> method can indicate if we expect more data to come,
|
||
and let nom know that some parsers could still handle more data</p>
|
||
</div>
|
||
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.at_eof' class='method'><code id='at_eof.v'>fn <a href='#tymethod.at_eof' class='fnname'>at_eof</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-AtEof-for-(I%2C%20T)' class='impl'><code class='in-band'>impl<I: <a class="trait" href="../nom/trait.AtEof.html" title="trait nom::AtEof">AtEof</a>, T> <a class="trait" href="../nom/trait.AtEof.html" title="trait nom::AtEof">AtEof</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>I, T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a href='#impl-AtEof-for-(I%2C%20T)' class='anchor'></a><a class='srclink' href='../src/nom/traits.rs.html#982-986' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.at_eof' class="method hidden"><code id='at_eof.v-1'>fn <a href='#method.at_eof' class='fnname'>at_eof</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/nom/traits.rs.html#983-985' title='goto source code'>[src]</a></h4></div><h3 id='impl-AtEof-for-%26%27a%20%5BT%5D' class='impl'><code class='in-band'>impl<'a, T> <a class="trait" href="../nom/trait.AtEof.html" title="trait nom::AtEof">AtEof</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [T]</a></code><a href='#impl-AtEof-for-%26%27a%20%5BT%5D' class='anchor'></a><a class='srclink' href='../src/nom/traits.rs.html#988-992' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.at_eof-1' class="method hidden"><code id='at_eof.v-2'>fn <a href='#method.at_eof' class='fnname'>at_eof</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/nom/traits.rs.html#989-991' title='goto source code'>[src]</a></h4></div><h3 id='impl-AtEof-for-%26%27a%20str' class='impl'><code class='in-band'>impl<'a> <a class="trait" href="../nom/trait.AtEof.html" title="trait nom::AtEof">AtEof</a> for &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code><a href='#impl-AtEof-for-%26%27a%20str' class='anchor'></a><a class='srclink' href='../src/nom/traits.rs.html#994-998' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.at_eof-2' class="method hidden"><code id='at_eof.v-3'>fn <a href='#method.at_eof' class='fnname'>at_eof</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/nom/traits.rs.html#995-997' title='goto source code'>[src]</a></h4></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-AtEof' class='impl'><code class='in-band'>impl<'a> AtEof for <a class="struct" href="../nom/types/struct.CompleteByteSlice.html" title="struct nom::types::CompleteByteSlice">CompleteByteSlice</a><'a></code><a href='#impl-AtEof' class='anchor'></a><a class='srclink' href='../src/nom/types.rs.html#227-232' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.at_eof-3' class="method hidden"><code id='at_eof.v-4'>fn <a href='#method.at_eof-3' class='fnname'>at_eof</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/nom/types.rs.html#229-231' title='goto source code'>[src]</a></h4></div><h3 id='impl-AtEof-1' class='impl'><code class='in-band'>impl<'a> AtEof for <a class="struct" href="../nom/types/struct.CompleteStr.html" title="struct nom::types::CompleteStr">CompleteStr</a><'a></code><a href='#impl-AtEof-1' class='anchor'></a><a class='srclink' href='../src/nom/types.rs.html#58-63' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.at_eof-4' class="method hidden"><code id='at_eof.v-5'>fn <a href='#method.at_eof-4' class='fnname'>at_eof</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/nom/types.rs.html#60-62' title='goto source code'>[src]</a></h4></div><h3 id='impl-AtEof-2' class='impl'><code class='in-band'>impl<T> AtEof for <a class="struct" href="../nom/types/struct.Input.html" title="struct nom::types::Input">Input</a><T></code><a href='#impl-AtEof-2' class='anchor'></a><a class='srclink' href='../src/nom/types.rs.html#385-389' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.at_eof-5' class="method hidden"><code id='at_eof.v-6'>fn <a href='#method.at_eof-5' class='fnname'>at_eof</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/nom/types.rs.html#386-388' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript" src="../implementors/nom/trait.AtEof.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "nom";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |