blob: 4752141d8374a6be31247ad01036adb509b4346a [file] [log] [blame]
<!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/io/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>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::lock::BiLock;
<span class="kw">use </span>core::fmt;
<span class="kw">use </span>futures_core::ready;
<span class="kw">use </span>futures_core::task::{Context, Poll};
<span class="kw">use </span>futures_io::{AsyncRead, AsyncWrite, IoSlice, IoSliceMut};
<span class="kw">use </span>std::io;
<span class="kw">use </span>std::pin::Pin;
<span class="doccomment">/// The readable half of an object returned from `AsyncRead::split`.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>ReadHalf&lt;T&gt; {
handle: BiLock&lt;T&gt;,
}
<span class="doccomment">/// The writable half of an object returned from `AsyncRead::split`.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>WriteHalf&lt;T&gt; {
handle: BiLock&lt;T&gt;,
}
<span class="kw">fn </span>lock_and_then&lt;T, U, E, F&gt;(lock: <span class="kw-2">&amp;</span>BiLock&lt;T&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;, f: F) -&gt; Poll&lt;<span class="prelude-ty">Result</span>&lt;U, E&gt;&gt;
<span class="kw">where
</span>F: FnOnce(Pin&lt;<span class="kw-2">&amp;mut </span>T&gt;, <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;<span class="prelude-ty">Result</span>&lt;U, E&gt;&gt;,
{
<span class="kw">let </span><span class="kw-2">mut </span>l = <span class="macro">ready!</span>(lock.poll_lock(cx));
f(l.as_pin_mut(), cx)
}
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>split&lt;T: AsyncRead + AsyncWrite&gt;(t: T) -&gt; (ReadHalf&lt;T&gt;, WriteHalf&lt;T&gt;) {
<span class="kw">let </span>(a, b) = BiLock::new(t);
(ReadHalf { handle: a }, WriteHalf { handle: b })
}
<span class="kw">impl</span>&lt;T: Unpin&gt; ReadHalf&lt;T&gt; {
<span class="doccomment">/// Attempts to put the two &quot;halves&quot; of a split `AsyncRead + AsyncWrite` back
/// together. Succeeds only if the `ReadHalf&lt;T&gt;` and `WriteHalf&lt;T&gt;` are
/// a matching pair originating from the same call to `AsyncReadExt::split`.
</span><span class="kw">pub fn </span>reunite(<span class="self">self</span>, other: WriteHalf&lt;T&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;T, ReuniteError&lt;T&gt;&gt; {
<span class="self">self</span>.handle
.reunite(other.handle)
.map_err(|err| ReuniteError(ReadHalf { handle: err.<span class="number">0 </span>}, WriteHalf { handle: err.<span class="number">1 </span>}))
}
}
<span class="kw">impl</span>&lt;T: Unpin&gt; WriteHalf&lt;T&gt; {
<span class="doccomment">/// Attempts to put the two &quot;halves&quot; of a split `AsyncRead + AsyncWrite` back
/// together. Succeeds only if the `ReadHalf&lt;T&gt;` and `WriteHalf&lt;T&gt;` are
/// a matching pair originating from the same call to `AsyncReadExt::split`.
</span><span class="kw">pub fn </span>reunite(<span class="self">self</span>, other: ReadHalf&lt;T&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;T, ReuniteError&lt;T&gt;&gt; {
other.reunite(<span class="self">self</span>)
}
}
<span class="kw">impl</span>&lt;R: AsyncRead&gt; AsyncRead <span class="kw">for </span>ReadHalf&lt;R&gt; {
<span class="kw">fn </span>poll_read(
<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;,
cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;,
buf: <span class="kw-2">&amp;mut </span>[u8],
) -&gt; Poll&lt;io::Result&lt;usize&gt;&gt; {
lock_and_then(<span class="kw-2">&amp;</span><span class="self">self</span>.handle, cx, |l, cx| l.poll_read(cx, buf))
}
<span class="kw">fn </span>poll_read_vectored(
<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;,
cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;,
bufs: <span class="kw-2">&amp;mut </span>[IoSliceMut&lt;<span class="lifetime">&#39;_</span>&gt;],
) -&gt; Poll&lt;io::Result&lt;usize&gt;&gt; {
lock_and_then(<span class="kw-2">&amp;</span><span class="self">self</span>.handle, cx, |l, cx| l.poll_read_vectored(cx, bufs))
}
}
<span class="kw">impl</span>&lt;W: AsyncWrite&gt; AsyncWrite <span class="kw">for </span>WriteHalf&lt;W&gt; {
<span class="kw">fn </span>poll_write(
<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;,
cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;,
buf: <span class="kw-2">&amp;</span>[u8],
) -&gt; Poll&lt;io::Result&lt;usize&gt;&gt; {
lock_and_then(<span class="kw-2">&amp;</span><span class="self">self</span>.handle, cx, |l, cx| l.poll_write(cx, buf))
}
<span class="kw">fn </span>poll_write_vectored(
<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;,
cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;,
bufs: <span class="kw-2">&amp;</span>[IoSlice&lt;<span class="lifetime">&#39;_</span>&gt;],
) -&gt; Poll&lt;io::Result&lt;usize&gt;&gt; {
lock_and_then(<span class="kw-2">&amp;</span><span class="self">self</span>.handle, cx, |l, cx| l.poll_write_vectored(cx, bufs))
}
<span class="kw">fn </span>poll_flush(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;io::Result&lt;()&gt;&gt; {
lock_and_then(<span class="kw-2">&amp;</span><span class="self">self</span>.handle, cx, |l, cx| l.poll_flush(cx))
}
<span class="kw">fn </span>poll_close(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;io::Result&lt;()&gt;&gt; {
lock_and_then(<span class="kw-2">&amp;</span><span class="self">self</span>.handle, cx, |l, cx| l.poll_close(cx))
}
}
<span class="doccomment">/// Error indicating a `ReadHalf&lt;T&gt;` and `WriteHalf&lt;T&gt;` were not two halves
/// of a `AsyncRead + AsyncWrite`, and thus could not be `reunite`d.
</span><span class="kw">pub struct </span>ReuniteError&lt;T&gt;(<span class="kw">pub </span>ReadHalf&lt;T&gt;, <span class="kw">pub </span>WriteHalf&lt;T&gt;);
<span class="kw">impl</span>&lt;T&gt; fmt::Debug <span class="kw">for </span>ReuniteError&lt;T&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
f.debug_tuple(<span class="string">&quot;ReuniteError&quot;</span>).field(<span class="kw-2">&amp;</span><span class="string">&quot;...&quot;</span>).finish()
}
}
<span class="kw">impl</span>&lt;T&gt; fmt::Display <span class="kw">for </span>ReuniteError&lt;T&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
<span class="macro">write!</span>(f, <span class="string">&quot;tried to reunite a ReadHalf and WriteHalf that don&#39;t form a pair&quot;</span>)
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;std&quot;</span>)]
</span><span class="kw">impl</span>&lt;T: core::any::Any&gt; std::error::Error <span class="kw">for </span>ReuniteError&lt;T&gt; {}
</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>