mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 00:18:24 +00:00
22 lines
22 KiB
HTML
22 lines
22 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="Marks the input as being the complete buffer or a partial buffer for streaming input"><title>StreamIsPartial in winnow::stream - 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 trait"><!--[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><h2 class="location"><a href="#">StreamIsPartial</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.PartialState">PartialState</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.complete">complete</a></li><li><a href="#tymethod.is_partial_supported">is_partial_supported</a></li><li><a href="#tymethod.restore_partial">restore_partial</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.is_partial">is_partial</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-StreamIsPartial-for-%26%5BT%5D">&'a [T]</a></li><li><a href="#impl-StreamIsPartial-for-%26str">&'a str</a></li><li><a href="#impl-StreamIsPartial-for-(I,+usize)">(I, usize)</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In winnow::stream</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>Trait <a href="../index.html">winnow</a>::<wbr><a href="index.html">stream</a>::<wbr><a class="trait" href="#">StreamIsPartial</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/stream/mod.rs.html#1612-1631">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait StreamIsPartial: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
type <a href="#associatedtype.PartialState" class="associatedtype">PartialState</a>;
|
|
|
|
// Required methods
|
|
fn <a href="#tymethod.complete" class="fn">complete</a>(&mut self) -> Self::<a class="associatedtype" href="trait.StreamIsPartial.html#associatedtype.PartialState" title="type winnow::stream::StreamIsPartial::PartialState">PartialState</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.restore_partial" class="fn">restore_partial</a>(&mut self, state: Self::<a class="associatedtype" href="trait.StreamIsPartial.html#associatedtype.PartialState" title="type winnow::stream::StreamIsPartial::PartialState">PartialState</a>);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.is_partial_supported" class="fn">is_partial_supported</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>;
|
|
|
|
// Provided method
|
|
fn <a href="#method.is_partial" class="fn">is_partial</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Marks the input as being the complete buffer or a partial buffer for streaming input</p>
|
|
<p>See <a href="struct.Partial.html" title="struct winnow::stream::Partial"><code>Partial</code></a> for marking a presumed complete buffer type as a streaming buffer.</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.PartialState" class="method"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1614">source</a><h4 class="code-header">type <a href="#associatedtype.PartialState" class="associatedtype">PartialState</a></h4></section></summary><div class="docblock"><p>Whether the stream is currently partial or complete</p>
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.complete" class="method"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1618">source</a><h4 class="code-header">fn <a href="#tymethod.complete" class="fn">complete</a>(&mut self) -> Self::<a class="associatedtype" href="trait.StreamIsPartial.html#associatedtype.PartialState" title="type winnow::stream::StreamIsPartial::PartialState">PartialState</a></h4></section></summary><div class="docblock"><p>Mark the stream is complete</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.restore_partial" class="method"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1621">source</a><h4 class="code-header">fn <a href="#tymethod.restore_partial" class="fn">restore_partial</a>(&mut self, state: Self::<a class="associatedtype" href="trait.StreamIsPartial.html#associatedtype.PartialState" title="type winnow::stream::StreamIsPartial::PartialState">PartialState</a>)</h4></section></summary><div class="docblock"><p>Restore the stream back to its previous state</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.is_partial_supported" class="method"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1624">source</a><h4 class="code-header">fn <a href="#tymethod.is_partial_supported" class="fn">is_partial_supported</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Report whether the <a href="trait.Stream.html" title="trait winnow::stream::Stream"><code>Stream</code></a> is can ever be incomplete</p>
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.is_partial" class="method"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1628-1630">source</a><h4 class="code-header">fn <a href="#method.is_partial" class="fn">is_partial</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Report whether the <a href="trait.Stream.html" title="trait winnow::stream::Stream"><code>Stream</code></a> is currently incomplete</p>
|
|
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.80.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-StreamIsPartial-for-%26str" class="impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1646-1659">source</a><a href="#impl-StreamIsPartial-for-%26str" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a> for &'a <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a></h3></section></summary><div class="impl-items"><section id="associatedtype.PartialState-1" class="associatedtype trait-impl"><a href="#associatedtype.PartialState-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.PartialState" class="associatedtype">PartialState</a> = <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a></h4></section><section id="method.complete" class="method trait-impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1649-1651">source</a><a href="#method.complete" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.complete" class="fn">complete</a>(&mut self) -> Self::<a class="associatedtype" href="trait.StreamIsPartial.html#associatedtype.PartialState" title="type winnow::stream::StreamIsPartial::PartialState">PartialState</a></h4></section><section id="method.restore_partial" class="method trait-impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1653">source</a><a href="#method.restore_partial" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.restore_partial" class="fn">restore_partial</a>(&mut self, _state: Self::<a class="associatedtype" href="trait.StreamIsPartial.html#associatedtype.PartialState" title="type winnow::stream::StreamIsPartial::PartialState">PartialState</a>)</h4></section><section id="method.is_partial_supported" class="method trait-impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1656-1658">source</a><a href="#method.is_partial_supported" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_partial_supported" class="fn">is_partial_supported</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-StreamIsPartial-for-%26%5BT%5D" class="impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1633-1644">source</a><a href="#impl-StreamIsPartial-for-%26%5BT%5D" class="anchor">§</a><h3 class="code-header">impl<'a, T> <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a> for &'a <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.slice.html">[T]</a></h3></section></summary><div class="impl-items"><section id="associatedtype.PartialState-2" class="associatedtype trait-impl"><a href="#associatedtype.PartialState-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.PartialState" class="associatedtype">PartialState</a> = <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a></h4></section><section id="method.complete-1" class="method trait-impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1636">source</a><a href="#method.complete-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.complete" class="fn">complete</a>(&mut self) -> Self::<a class="associatedtype" href="trait.StreamIsPartial.html#associatedtype.PartialState" title="type winnow::stream::StreamIsPartial::PartialState">PartialState</a></h4></section><section id="method.restore_partial-1" class="method trait-impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1638">source</a><a href="#method.restore_partial-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.restore_partial" class="fn">restore_partial</a>(&mut self, _state: Self::<a class="associatedtype" href="trait.StreamIsPartial.html#associatedtype.PartialState" title="type winnow::stream::StreamIsPartial::PartialState">PartialState</a>)</h4></section><section id="method.is_partial_supported-1" class="method trait-impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1641-1643">source</a><a href="#method.is_partial_supported-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_partial_supported" class="fn">is_partial_supported</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-StreamIsPartial-for-(I,+usize)" class="impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1691-1714">source</a><a href="#impl-StreamIsPartial-for-(I,+usize)" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a> for (I, <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>)<div class="where">where
|
|
I: <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.PartialState-3" class="associatedtype trait-impl"><a href="#associatedtype.PartialState-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.PartialState" class="associatedtype">PartialState</a> = <I as <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a>>::<a class="associatedtype" href="trait.StreamIsPartial.html#associatedtype.PartialState" title="type winnow::stream::StreamIsPartial::PartialState">PartialState</a></h4></section><section id="method.complete-2" class="method trait-impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1697-1699">source</a><a href="#method.complete-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.complete" class="fn">complete</a>(&mut self) -> Self::<a class="associatedtype" href="trait.StreamIsPartial.html#associatedtype.PartialState" title="type winnow::stream::StreamIsPartial::PartialState">PartialState</a></h4></section><section id="method.restore_partial-2" class="method trait-impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1701-1703">source</a><a href="#method.restore_partial-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.restore_partial" class="fn">restore_partial</a>(&mut self, state: Self::<a class="associatedtype" href="trait.StreamIsPartial.html#associatedtype.PartialState" title="type winnow::stream::StreamIsPartial::PartialState">PartialState</a>)</h4></section><section id="method.is_partial_supported-2" class="method trait-impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1706-1708">source</a><a href="#method.is_partial_supported-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_partial_supported" class="fn">is_partial_supported</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section><section id="method.is_partial-1" class="method trait-impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1711-1713">source</a><a href="#method.is_partial-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.is_partial" class="fn">is_partial</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-StreamIsPartial-for-%26BStr" class="impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1676-1689">source</a><a href="#impl-StreamIsPartial-for-%26BStr" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a> for &'a <a class="struct" href="struct.BStr.html" title="struct winnow::stream::BStr">BStr</a></h3></section></summary><div class="impl-items"><section id="associatedtype.PartialState-4" class="associatedtype trait-impl"><a href="#associatedtype.PartialState-4" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.PartialState" class="associatedtype">PartialState</a> = <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-StreamIsPartial-for-%26Bytes" class="impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1661-1674">source</a><a href="#impl-StreamIsPartial-for-%26Bytes" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a> for &'a <a class="struct" href="struct.Bytes.html" title="struct winnow::stream::Bytes">Bytes</a></h3></section></summary><div class="impl-items"><section id="associatedtype.PartialState-5" class="associatedtype trait-impl"><a href="#associatedtype.PartialState-5" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.PartialState" class="associatedtype">PartialState</a> = <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-StreamIsPartial-for-Located%3CI%3E" class="impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1716-1739">source</a><a href="#impl-StreamIsPartial-for-Located%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a> for <a class="struct" href="struct.Located.html" title="struct winnow::stream::Located">Located</a><I><div class="where">where
|
|
I: <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.PartialState-6" class="associatedtype trait-impl"><a href="#associatedtype.PartialState-6" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.PartialState" class="associatedtype">PartialState</a> = <I as <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a>>::<a class="associatedtype" href="trait.StreamIsPartial.html#associatedtype.PartialState" title="type winnow::stream::StreamIsPartial::PartialState">PartialState</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-StreamIsPartial-for-Partial%3CI%3E" class="impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1794-1817">source</a><a href="#impl-StreamIsPartial-for-Partial%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I> <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a> for <a class="struct" href="struct.Partial.html" title="struct winnow::stream::Partial">Partial</a><I><div class="where">where
|
|
I: <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.PartialState-7" class="associatedtype trait-impl"><a href="#associatedtype.PartialState-7" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.PartialState" class="associatedtype">PartialState</a> = <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-StreamIsPartial-for-Stateful%3CI,+S%3E" class="impl"><a class="src rightside" href="../../src/winnow/stream/mod.rs.html#1769-1792">source</a><a href="#impl-StreamIsPartial-for-Stateful%3CI,+S%3E" class="anchor">§</a><h3 class="code-header">impl<I, S> <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a> for <a class="struct" href="struct.Stateful.html" title="struct winnow::stream::Stateful">Stateful</a><I, S><div class="where">where
|
|
I: <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.PartialState-8" class="associatedtype trait-impl"><a href="#associatedtype.PartialState-8" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.PartialState" class="associatedtype">PartialState</a> = <I as <a class="trait" href="trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a>>::<a class="associatedtype" href="trait.StreamIsPartial.html#associatedtype.PartialState" title="type winnow::stream::StreamIsPartial::PartialState">PartialState</a></h4></section></div></details></div><script src="../../trait.impl/winnow/stream/trait.StreamIsPartial.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html> |