| <!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/futures-util-0.3.28/src/stream/stream/split.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>split.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="../../../../futures_util/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="../../../../futures_util/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> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>core::fmt; |
| <span class="kw">use </span>core::pin::Pin; |
| <span class="kw">use </span>futures_core::ready; |
| <span class="kw">use </span>futures_core::stream::Stream; |
| <span class="kw">use </span>futures_core::task::{Context, Poll}; |
| <span class="kw">use </span>futures_sink::Sink; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::lock::BiLock; |
| |
| <span class="doccomment">/// A `Stream` part of the split pair |
| </span><span class="attribute">#[derive(Debug)] |
| #[must_use = <span class="string">"streams do nothing unless polled"</span>] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"sink"</span>)))] |
| </span><span class="kw">pub struct </span>SplitStream<S>(BiLock<S>); |
| |
| <span class="kw">impl</span><S> Unpin <span class="kw">for </span>SplitStream<S> {} |
| |
| <span class="kw">impl</span><S: Unpin> SplitStream<S> { |
| <span class="doccomment">/// Attempts to put the two "halves" of a split `Stream + Sink` back |
| /// together. Succeeds only if the `SplitStream<S>` and `SplitSink<S>` are |
| /// a matching pair originating from the same call to `StreamExt::split`. |
| </span><span class="kw">pub fn </span>reunite<Item>(<span class="self">self</span>, other: SplitSink<S, Item>) -> <span class="prelude-ty">Result</span><S, ReuniteError<S, Item>> |
| <span class="kw">where |
| </span>S: Sink<Item>, |
| { |
| other.reunite(<span class="self">self</span>) |
| } |
| } |
| |
| <span class="kw">impl</span><S: Stream> Stream <span class="kw">for </span>SplitStream<S> { |
| <span class="kw">type </span>Item = S::Item; |
| |
| <span class="kw">fn </span>poll_next(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Option</span><S::Item>> { |
| <span class="macro">ready!</span>(<span class="self">self</span>.<span class="number">0</span>.poll_lock(cx)).as_pin_mut().poll_next(cx) |
| } |
| } |
| |
| <span class="attribute">#[allow(non_snake_case)] |
| </span><span class="kw">fn </span>SplitSink<S: Sink<Item>, Item>(lock: BiLock<S>) -> SplitSink<S, Item> { |
| SplitSink { lock, slot: <span class="prelude-val">None </span>} |
| } |
| |
| <span class="doccomment">/// A `Sink` part of the split pair |
| </span><span class="attribute">#[derive(Debug)] |
| #[must_use = <span class="string">"sinks do nothing unless polled"</span>] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"sink"</span>)))] |
| </span><span class="kw">pub struct </span>SplitSink<S, Item> { |
| lock: BiLock<S>, |
| slot: <span class="prelude-ty">Option</span><Item>, |
| } |
| |
| <span class="kw">impl</span><S, Item> Unpin <span class="kw">for </span>SplitSink<S, Item> {} |
| |
| <span class="kw">impl</span><S: Sink<Item> + Unpin, Item> SplitSink<S, Item> { |
| <span class="doccomment">/// Attempts to put the two "halves" of a split `Stream + Sink` back |
| /// together. Succeeds only if the `SplitStream<S>` and `SplitSink<S>` are |
| /// a matching pair originating from the same call to `StreamExt::split`. |
| </span><span class="kw">pub fn </span>reunite(<span class="self">self</span>, other: SplitStream<S>) -> <span class="prelude-ty">Result</span><S, ReuniteError<S, Item>> { |
| <span class="self">self</span>.lock.reunite(other.<span class="number">0</span>).map_err(|err| ReuniteError(SplitSink(err.<span class="number">0</span>), SplitStream(err.<span class="number">1</span>))) |
| } |
| } |
| |
| <span class="kw">impl</span><S: Sink<Item>, Item> SplitSink<S, Item> { |
| <span class="kw">fn </span>poll_flush_slot( |
| <span class="kw-2">mut </span>inner: Pin<<span class="kw-2">&mut </span>S>, |
| slot: <span class="kw-2">&mut </span><span class="prelude-ty">Option</span><Item>, |
| cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| ) -> Poll<<span class="prelude-ty">Result</span><(), S::Error>> { |
| <span class="kw">if </span>slot.is_some() { |
| <span class="macro">ready!</span>(inner.as_mut().poll_ready(cx))<span class="question-mark">?</span>; |
| Poll::Ready(inner.start_send(slot.take().unwrap())) |
| } <span class="kw">else </span>{ |
| Poll::Ready(<span class="prelude-val">Ok</span>(())) |
| } |
| } |
| |
| <span class="kw">fn </span>poll_lock_and_flush_slot( |
| <span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| ) -> Poll<<span class="prelude-ty">Result</span><(), S::Error>> { |
| <span class="kw">let </span>this = <span class="kw-2">&mut *</span><span class="self">self</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>inner = <span class="macro">ready!</span>(this.lock.poll_lock(cx)); |
| <span class="self">Self</span>::poll_flush_slot(inner.as_pin_mut(), <span class="kw-2">&mut </span>this.slot, cx) |
| } |
| } |
| |
| <span class="kw">impl</span><S: Sink<Item>, Item> Sink<Item> <span class="kw">for </span>SplitSink<S, Item> { |
| <span class="kw">type </span>Error = S::Error; |
| |
| <span class="kw">fn </span>poll_ready(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Result</span><(), S::Error>> { |
| <span class="kw">loop </span>{ |
| <span class="kw">if </span><span class="self">self</span>.slot.is_none() { |
| <span class="kw">return </span>Poll::Ready(<span class="prelude-val">Ok</span>(())); |
| } |
| <span class="macro">ready!</span>(<span class="self">self</span>.as_mut().poll_lock_and_flush_slot(cx))<span class="question-mark">?</span>; |
| } |
| } |
| |
| <span class="kw">fn </span>start_send(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, item: Item) -> <span class="prelude-ty">Result</span><(), S::Error> { |
| <span class="self">self</span>.slot = <span class="prelude-val">Some</span>(item); |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="kw">fn </span>poll_flush(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Result</span><(), S::Error>> { |
| <span class="kw">let </span>this = <span class="kw-2">&mut *</span><span class="self">self</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>inner = <span class="macro">ready!</span>(this.lock.poll_lock(cx)); |
| <span class="macro">ready!</span>(<span class="self">Self</span>::poll_flush_slot(inner.as_pin_mut(), <span class="kw-2">&mut </span>this.slot, cx))<span class="question-mark">?</span>; |
| inner.as_pin_mut().poll_flush(cx) |
| } |
| |
| <span class="kw">fn </span>poll_close(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Result</span><(), S::Error>> { |
| <span class="kw">let </span>this = <span class="kw-2">&mut *</span><span class="self">self</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>inner = <span class="macro">ready!</span>(this.lock.poll_lock(cx)); |
| <span class="macro">ready!</span>(<span class="self">Self</span>::poll_flush_slot(inner.as_pin_mut(), <span class="kw-2">&mut </span>this.slot, cx))<span class="question-mark">?</span>; |
| inner.as_pin_mut().poll_close(cx) |
| } |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>split<S: Stream + Sink<Item>, Item>(s: S) -> (SplitSink<S, Item>, SplitStream<S>) { |
| <span class="kw">let </span>(a, b) = BiLock::new(s); |
| <span class="kw">let </span>read = SplitStream(a); |
| <span class="kw">let </span>write = SplitSink(b); |
| (write, read) |
| } |
| |
| <span class="doccomment">/// Error indicating a `SplitSink<S>` and `SplitStream<S>` were not two halves |
| /// of a `Stream + Split`, and thus could not be `reunite`d. |
| </span><span class="attribute">#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"sink"</span>)))] |
| </span><span class="kw">pub struct </span>ReuniteError<T, Item>(<span class="kw">pub </span>SplitSink<T, Item>, <span class="kw">pub </span>SplitStream<T>); |
| |
| <span class="kw">impl</span><T, Item> fmt::Debug <span class="kw">for </span>ReuniteError<T, Item> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| f.debug_tuple(<span class="string">"ReuniteError"</span>).field(<span class="kw-2">&</span><span class="string">"..."</span>).finish() |
| } |
| } |
| |
| <span class="kw">impl</span><T, Item> fmt::Display <span class="kw">for </span>ReuniteError<T, Item> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="macro">write!</span>(f, <span class="string">"tried to reunite a SplitStream and SplitSink that don't form a pair"</span>) |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">impl</span><T: core::any::Any, Item> std::error::Error <span class="kw">for </span>ReuniteError<T, Item> {} |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="futures_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
