| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/tokio-stream-0.1.14/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../tokio_stream/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../tokio_stream/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| </pre><pre class="rust"><code><span class="attribute">#![allow( |
| clippy::cognitive_complexity, |
| clippy::large_enum_variant, |
| clippy::needless_doctest_main |
| )] |
| #![warn( |
| missing_debug_implementations, |
| missing_docs, |
| rust_2018_idioms, |
| unreachable_pub |
| )] |
| #![cfg_attr(docsrs, feature(doc_cfg))] |
| #![doc(test( |
| no_crate_inject, |
| attr(deny(warnings, rust_2018_idioms), allow(dead_code, unused_variables)) |
| ))] |
| |
| </span><span class="doccomment">//! Stream utilities for Tokio. |
| //! |
| //! A `Stream` is an asynchronous sequence of values. It can be thought of as |
| //! an asynchronous version of the standard library's `Iterator` trait. |
| //! |
| //! This crate provides helpers to work with them. For examples of usage and a more in-depth |
| //! description of streams you can also refer to the [streams |
| //! tutorial](https://tokio.rs/tokio/tutorial/streams) on the tokio website. |
| //! |
| //! # Iterating over a Stream |
| //! |
| //! Due to similarities with the standard library's `Iterator` trait, some new |
| //! users may assume that they can use `for in` syntax to iterate over a |
| //! `Stream`, but this is unfortunately not possible. Instead, you can use a |
| //! `while let` loop as follows: |
| //! |
| //! ```rust |
| //! use tokio_stream::{self as stream, StreamExt}; |
| //! |
| //! #[tokio::main] |
| //! async fn main() { |
| //! let mut stream = stream::iter(vec![0, 1, 2]); |
| //! |
| //! while let Some(value) = stream.next().await { |
| //! println!("Got {}", value); |
| //! } |
| //! } |
| //! ``` |
| //! |
| //! # Returning a Stream from a function |
| //! |
| //! A common way to stream values from a function is to pass in the sender |
| //! half of a channel and use the receiver as the stream. This requires awaiting |
| //! both futures to ensure progress is made. Another alternative is the |
| //! [async-stream] crate, which contains macros that provide a `yield` keyword |
| //! and allow you to return an `impl Stream`. |
| //! |
| //! [async-stream]: https://docs.rs/async-stream |
| //! |
| //! # Conversion to and from AsyncRead/AsyncWrite |
| //! |
| //! It is often desirable to convert a `Stream` into an [`AsyncRead`], |
| //! especially when dealing with plaintext formats streamed over the network. |
| //! The opposite conversion from an [`AsyncRead`] into a `Stream` is also |
| //! another commonly required feature. To enable these conversions, |
| //! [`tokio-util`] provides the [`StreamReader`] and [`ReaderStream`] |
| //! types when the io feature is enabled. |
| //! |
| //! [`tokio-util`]: https://docs.rs/tokio-util/0.4/tokio_util/codec/index.html |
| //! [`tokio::io`]: https://docs.rs/tokio/1.0/tokio/io/index.html |
| //! [`AsyncRead`]: https://docs.rs/tokio/1.0/tokio/io/trait.AsyncRead.html |
| //! [`AsyncWrite`]: https://docs.rs/tokio/1.0/tokio/io/trait.AsyncWrite.html |
| //! [`ReaderStream`]: https://docs.rs/tokio-util/0.4/tokio_util/io/struct.ReaderStream.html |
| //! [`StreamReader`]: https://docs.rs/tokio-util/0.4/tokio_util/io/struct.StreamReader.html |
| |
| </span><span class="attribute">#[macro_use] |
| </span><span class="kw">mod </span>macros; |
| |
| <span class="kw">pub mod </span>wrappers; |
| |
| <span class="kw">mod </span>stream_ext; |
| <span class="kw">pub use </span>stream_ext::{collect::FromStream, StreamExt}; |
| <span class="macro">cfg_time! </span>{ |
| <span class="kw">pub use </span>stream_ext::timeout::{Elapsed, Timeout}; |
| } |
| |
| <span class="kw">mod </span>empty; |
| <span class="kw">pub use </span>empty::{empty, Empty}; |
| |
| <span class="kw">mod </span>iter; |
| <span class="kw">pub use </span>iter::{iter, Iter}; |
| |
| <span class="kw">mod </span>once; |
| <span class="kw">pub use </span>once::{once, Once}; |
| |
| <span class="kw">mod </span>pending; |
| <span class="kw">pub use </span>pending::{pending, Pending}; |
| |
| <span class="kw">mod </span>stream_map; |
| <span class="kw">pub use </span>stream_map::StreamMap; |
| |
| <span class="kw">mod </span>stream_close; |
| <span class="kw">pub use </span>stream_close::StreamNotifyClose; |
| |
| <span class="attribute">#[doc(no_inline)] |
| </span><span class="kw">pub use </span>futures_core::Stream; |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio_stream" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
