31 lines
5.9 KiB
HTML
31 lines
5.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 `stream` mod in crate `tokio`."><meta name="keywords" content="rust, rustlang, rust-lang, stream"><title>tokio::stream - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
|||
|
|
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
|||
|
|
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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='../../tokio/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module stream</p><div class="sidebar-elems"><p class="location"><a href="../index.html">tokio</a></p><script>window.sidebarCurrent = {name: "stream", ty: "mod", relpath: "../"};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></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><span class="help-button">?</span>
|
|||
|
|
<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/tokio/lib.rs.html#444" title="goto source code">[src]</a></span><span class="in-band">Module <a href="../index.html">tokio</a>::<wbr><a class="mod" href="">stream</a></span></h1><div class="docblock"><p>Due to the <code>Stream</code> trait's inclusion in <code>std</code> landing later than Tokio's 1.0
|
|||
|
|
release, most of the Tokio stream utilities have been moved into the <a href="https://docs.rs/tokio-stream"><code>tokio-stream</code></a>
|
|||
|
|
crate.</p>
|
|||
|
|
<h1 id="why-was-stream-not-included-in-tokio-10" class="section-header"><a href="#why-was-stream-not-included-in-tokio-10">Why was <code>Stream</code> not included in Tokio 1.0?</a></h1>
|
|||
|
|
<p>Originally, we had planned to ship Tokio 1.0 with a stable <code>Stream</code> type
|
|||
|
|
but unfortunetly the <a href="https://github.com/rust-lang/rfcs/pull/2996">RFC</a> had not been merged in time for <code>Stream</code> to
|
|||
|
|
reach <code>std</code> on a stable compiler in time for the 1.0 release of Tokio. For
|
|||
|
|
this reason, the team has decided to move all <code>Stream</code> based utilities to
|
|||
|
|
the <a href="https://docs.rs/tokio-stream"><code>tokio-stream</code></a> crate. While this is not ideal, once <code>Stream</code> has made
|
|||
|
|
it into the standard library and the MSRV period has passed, we will implement
|
|||
|
|
stream for our different types.</p>
|
|||
|
|
<p>While this may seem unfortunate, not all is lost as you can get much of the
|
|||
|
|
<code>Stream</code> support with <code>async/await</code> and <code>while let</code> loops. It is also possible
|
|||
|
|
to create a <code>impl Stream</code> from <code>async fn</code> using the <a href="https://docs.rs/async-stream"><code>async-stream</code></a> crate.</p>
|
|||
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|||
|
|
<p>Convert a [<code>sync::mpsc::Receiver</code>] to an <code>impl Stream</code>.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">sync</span>::<span class="ident">mpsc</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> (<span class="ident">tx</span>, <span class="kw-2">mut</span> <span class="ident">rx</span>) <span class="op">=</span> <span class="ident">mpsc</span>::<span class="ident">channel</span>::<span class="op"><</span><span class="ident">usize</span><span class="op">></span>(<span class="number">16</span>);
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">stream</span> <span class="op">=</span> <span class="ident">async_stream</span>::<span class="macro">stream</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">while</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">item</span>) <span class="op">=</span> <span class="ident">rx</span>.<span class="ident">recv</span>().<span class="ident">await</span> {
|
|||
|
|
<span class="kw">yield</span> <span class="ident">item</span>;
|
|||
|
|
}
|
|||
|
|
};</pre></div>
|
|||
|
|
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "tokio";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|