18 lines
5.2 KiB
HTML
18 lines
5.2 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="Combines several streams, all producing the same `Item` type, into one stream. This is similar to `select_all` but does not require the streams to all be the same type. It also keeps the streams inline, and does not require `Box<dyn Stream>`s to be allocated. Streams passed to this macro must be `Unpin`."><title>stream_select in futures_util - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.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.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">stream_select</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../futures_util/index.html">futures_<wbr>util</a><span class="version">0.3.32</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">stream_<wbr>select</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 class="in-crate"><a href="index.html">In crate futures_<wbr>util</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">futures_util</a></div><h1>Macro <span class="macro">stream_<wbr>select</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/async_await/stream_select_mod.rs.html#32-39">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! stream_select {
|
|
($($tokens:tt)*) => { ... };
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Combines several streams, all producing the same <code>Item</code> type, into one stream.
|
|
This is similar to <code>select_all</code> but does not require the streams to all be the same type.
|
|
It also keeps the streams inline, and does not require <code>Box<dyn Stream></code>s to be allocated.
|
|
Streams passed to this macro must be <code>Unpin</code>.</p>
|
|
<p>If multiple streams are ready, one will be pseudo randomly selected at runtime.</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, StreamExt, stream_select};
|
|
<span class="kw">let </span>endless_ints = |i| stream::iter(<span class="macro">vec!</span>[i].into_iter().cycle()).fuse();
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>endless_numbers = <span class="macro">stream_select!</span>(endless_ints(<span class="number">1i32</span>), endless_ints(<span class="number">2</span>), endless_ints(<span class="number">3</span>));
|
|
<span class="kw">match </span>endless_numbers.next().<span class="kw">await </span>{
|
|
<span class="prelude-val">Some</span>(<span class="number">1</span>) => <span class="macro">println!</span>(<span class="string">"Got a 1"</span>),
|
|
<span class="prelude-val">Some</span>(<span class="number">2</span>) => <span class="macro">println!</span>(<span class="string">"Got a 2"</span>),
|
|
<span class="prelude-val">Some</span>(<span class="number">3</span>) => <span class="macro">println!</span>(<span class="string">"Got a 3"</span>),
|
|
<span class="kw">_ </span>=> <span class="macro">unreachable!</span>(),
|
|
}</code></pre></div></div></details></section></div></main></body></html> |