mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-26 11:59:33 +01:00
19 lines
No EOL
5.4 KiB
HTML
19 lines
No EOL
5.4 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="Creates a new stream that always immediately returns Poll::Ready when awaiting it."><title>poll_immediate in futures_util::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-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="futures_util" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-0111fcff984fae8f.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="../../futures_util/index.html">futures_<wbr>util</a><span class="version">0.3.31</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">poll_<wbr>immediate</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In futures_<wbr>util::<wbr>stream</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">futures_util</a>::<wbr><a href="index.html">stream</a></span><h1>Function <span class="fn">poll_immediate</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/futures_util/stream/poll_immediate.rs.html#78-80">source</a> </span></div><pre class="rust item-decl"><code>pub fn poll_immediate<S: <a class="trait" href="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a>>(s: S) -> <a class="struct" href="struct.PollImmediate.html" title="struct futures_util::stream::PollImmediate">PollImmediate</a><S></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a new stream that always immediately returns <a href="https://doc.rust-lang.org/1.83.0/core/task/poll/enum.Poll.html#variant.Ready" title="variant core::task::poll::Poll::Ready">Poll::Ready</a> when awaiting it.</p>
|
|
<p>This is useful when immediacy is more important than waiting for the next item to be ready.</p>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>futures::stream::{<span class="self">self</span>, StreamExt};
|
|
<span class="kw">use </span>futures::task::Poll;
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>r = stream::poll_immediate(Box::pin(stream::iter(<span class="number">1_u32</span>..<span class="number">3</span>)));
|
|
<span class="macro">assert_eq!</span>(r.next().<span class="kw">await</span>, <span class="prelude-val">Some</span>(Poll::Ready(<span class="number">1</span>)));
|
|
<span class="macro">assert_eq!</span>(r.next().<span class="kw">await</span>, <span class="prelude-val">Some</span>(Poll::Ready(<span class="number">2</span>)));
|
|
<span class="macro">assert_eq!</span>(r.next().<span class="kw">await</span>, <span class="prelude-val">None</span>);
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>p = stream::poll_immediate(Box::pin(stream::once(<span class="kw">async </span>{
|
|
<span class="macro">futures::pending!</span>();
|
|
<span class="number">42_u8
|
|
</span>})));
|
|
<span class="macro">assert_eq!</span>(p.next().<span class="kw">await</span>, <span class="prelude-val">Some</span>(Poll::Pending));
|
|
<span class="macro">assert_eq!</span>(p.next().<span class="kw">await</span>, <span class="prelude-val">Some</span>(Poll::Ready(<span class="number">42</span>)));
|
|
<span class="macro">assert_eq!</span>(p.next().<span class="kw">await</span>, <span class="prelude-val">None</span>);</code></pre></div>
|
|
</div></details></section></div></main></body></html> |