<!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 `/home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/futures-util-0.3.31/src/lib.rs`."><title>lib.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.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.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../../static.files/src-script-56102188.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">futures_util/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"> <a href="#1" id="1">1</a> <a href="#2" id="2">2</a> <a href="#3" id="3">3</a> <a href="#4" id="4">4</a> <a href="#5" id="5">5</a> <a href="#6" id="6">6</a> <a href="#7" id="7">7</a> <a href="#8" id="8">8</a> <a href="#9" id="9">9</a> <a href="#10" id="10">10</a> <a href="#11" id="11">11</a> <a href="#12" id="12">12</a> <a href="#13" id="13">13</a> <a href="#14" id="14">14</a> <a href="#15" id="15">15</a> <a href="#16" id="16">16</a> <a href="#17" id="17">17</a> <a href="#18" id="18">18</a> <a href="#19" id="19">19</a> <a href="#20" id="20">20</a> <a href="#21" id="21">21</a> <a href="#22" id="22">22</a> <a href="#23" id="23">23</a> <a href="#24" id="24">24</a> <a href="#25" id="25">25</a> <a href="#26" id="26">26</a> <a href="#27" id="27">27</a> <a href="#28" id="28">28</a> <a href="#29" id="29">29</a> <a href="#30" id="30">30</a> <a href="#31" id="31">31</a> <a href="#32" id="32">32</a> <a href="#33" id="33">33</a> <a href="#34" id="34">34</a> <a href="#35" id="35">35</a> <a href="#36" id="36">36</a> <a href="#37" id="37">37</a> <a href="#38" id="38">38</a> <a href="#39" id="39">39</a> <a href="#40" id="40">40</a> <a href="#41" id="41">41</a> <a href="#42" id="42">42</a> <a href="#43" id="43">43</a> <a href="#44" id="44">44</a> <a href="#45" id="45">45</a> <a href="#46" id="46">46</a> <a href="#47" id="47">47</a> <a href="#48" id="48">48</a> <a href="#49" id="49">49</a> <a href="#50" id="50">50</a> <a href="#51" id="51">51</a> <a href="#52" id="52">52</a> <a href="#53" id="53">53</a> <a href="#54" id="54">54</a> <a href="#55" id="55">55</a> <a href="#56" id="56">56</a> <a href="#57" id="57">57</a> <a href="#58" id="58">58</a> <a href="#59" id="59">59</a> <a href="#60" id="60">60</a> <a href="#61" id="61">61</a> <a href="#62" id="62">62</a> <a href="#63" id="63">63</a> <a href="#64" id="64">64</a> <a href="#65" id="65">65</a> <a href="#66" id="66">66</a> <a href="#67" id="67">67</a> <a href="#68" id="68">68</a> <a href="#69" id="69">69</a> <a href="#70" id="70">70</a> <a href="#71" id="71">71</a> <a href="#72" id="72">72</a> <a href="#73" id="73">73</a> <a href="#74" id="74">74</a> <a href="#75" id="75">75</a> <a href="#76" id="76">76</a> <a href="#77" id="77">77</a> <a href="#78" id="78">78</a> <a href="#79" id="79">79</a> <a href="#80" id="80">80</a> <a href="#81" id="81">81</a> <a href="#82" id="82">82</a> <a href="#83" id="83">83</a> <a href="#84" id="84">84</a> <a href="#85" id="85">85</a> <a href="#86" id="86">86</a> <a href="#87" id="87">87</a> <a href="#88" id="88">88</a> <a href="#89" id="89">89</a> <a href="#90" id="90">90</a> <a href="#91" id="91">91</a> <a href="#92" id="92">92</a> <a href="#93" id="93">93</a> <a href="#94" id="94">94</a> <a href="#95" id="95">95</a> <a href="#96" id="96">96</a> <a href="#97" id="97">97</a> <a href="#98" id="98">98</a> <a href="#99" id="99">99</a> <a href="#100" id="100">100</a> <a href="#101" id="101">101</a> <a href="#102" id="102">102</a> <a href="#103" id="103">103</a> <a href="#104" id="104">104</a> <a href="#105" id="105">105</a> <a href="#106" id="106">106</a> <a href="#107" id="107">107</a> <a href="#108" id="108">108</a> <a href="#109" id="109">109</a> <a href="#110" id="110">110</a> <a href="#111" id="111">111</a> <a href="#112" id="112">112</a> <a href="#113" id="113">113</a> <a href="#114" id="114">114</a> <a href="#115" id="115">115</a> <a href="#116" id="116">116</a> <a href="#117" id="117">117</a> <a href="#118" id="118">118</a> <a href="#119" id="119">119</a> <a href="#120" id="120">120</a> <a href="#121" id="121">121</a> <a href="#122" id="122">122</a> <a href="#123" id="123">123</a> <a href="#124" id="124">124</a> <a href="#125" id="125">125</a> <a href="#126" id="126">126</a> <a href="#127" id="127">127</a> <a href="#128" id="128">128</a> <a href="#129" id="129">129</a> <a href="#130" id="130">130</a> <a href="#131" id="131">131</a> <a href="#132" id="132">132</a> <a href="#133" id="133">133</a> <a href="#134" id="134">134</a> <a href="#135" id="135">135</a> <a href="#136" id="136">136</a> <a href="#137" id="137">137</a> <a href="#138" id="138">138</a> <a href="#139" id="139">139</a> <a href="#140" id="140">140</a> <a href="#141" id="141">141</a> <a href="#142" id="142">142</a> <a href="#143" id="143">143</a> <a href="#144" id="144">144</a> <a href="#145" id="145">145</a> <a href="#146" id="146">146</a> <a href="#147" id="147">147</a> <a href="#148" id="148">148</a> <a href="#149" id="149">149</a> <a href="#150" id="150">150</a> <a href="#151" id="151">151</a> <a href="#152" id="152">152</a> <a href="#153" id="153">153</a> <a href="#154" id="154">154</a> <a href="#155" id="155">155</a> <a href="#156" id="156">156</a> <a href="#157" id="157">157</a> <a href="#158" id="158">158</a> <a href="#159" id="159">159</a> <a href="#160" id="160">160</a> <a href="#161" id="161">161</a> <a href="#162" id="162">162</a> <a href="#163" id="163">163</a> <a href="#164" id="164">164</a> <a href="#165" id="165">165</a> <a href="#166" id="166">166</a> <a href="#167" id="167">167</a> <a href="#168" id="168">168</a> <a href="#169" id="169">169</a> <a href="#170" id="170">170</a> <a href="#171" id="171">171</a> <a href="#172" id="172">172</a> <a href="#173" id="173">173</a> <a href="#174" id="174">174</a> <a href="#175" id="175">175</a> <a href="#176" id="176">176</a> <a href="#177" id="177">177</a> <a href="#178" id="178">178</a> <a href="#179" id="179">179</a> <a href="#180" id="180">180</a> <a href="#181" id="181">181</a> <a href="#182" id="182">182</a> <a href="#183" id="183">183</a> <a href="#184" id="184">184</a> <a href="#185" id="185">185</a> <a href="#186" id="186">186</a> <a href="#187" id="187">187</a> <a href="#188" id="188">188</a> <a href="#189" id="189">189</a> <a href="#190" id="190">190</a> <a href="#191" id="191">191</a> <a href="#192" id="192">192</a> <a href="#193" id="193">193</a> <a href="#194" id="194">194</a> <a href="#195" id="195">195</a> <a href="#196" id="196">196</a> <a href="#197" id="197">197</a> <a href="#198" id="198">198</a> <a href="#199" id="199">199</a> <a href="#200" id="200">200</a> <a href="#201" id="201">201</a> <a href="#202" id="202">202</a> <a href="#203" id="203">203</a> <a href="#204" id="204">204</a> <a href="#205" id="205">205</a> <a href="#206" id="206">206</a> <a href="#207" id="207">207</a> <a href="#208" id="208">208</a> <a href="#209" id="209">209</a> <a href="#210" id="210">210</a> <a href="#211" id="211">211</a> <a href="#212" id="212">212</a> <a href="#213" id="213">213</a> <a href="#214" id="214">214</a> <a href="#215" id="215">215</a> <a href="#216" id="216">216</a> <a href="#217" id="217">217</a> <a href="#218" id="218">218</a> <a href="#219" id="219">219</a> <a href="#220" id="220">220</a> <a href="#221" id="221">221</a> <a href="#222" id="222">222</a> <a href="#223" id="223">223</a> <a href="#224" id="224">224</a> <a href="#225" id="225">225</a> <a href="#226" id="226">226</a> <a href="#227" id="227">227</a> <a href="#228" id="228">228</a> <a href="#229" id="229">229</a> <a href="#230" id="230">230</a> <a href="#231" id="231">231</a> <a href="#232" id="232">232</a> <a href="#233" id="233">233</a> <a href="#234" id="234">234</a> <a href="#235" id="235">235</a> <a href="#236" id="236">236</a> <a href="#237" id="237">237</a> <a href="#238" id="238">238</a> <a href="#239" id="239">239</a> <a href="#240" id="240">240</a> <a href="#241" id="241">241</a> <a href="#242" id="242">242</a> <a href="#243" id="243">243</a> <a href="#244" id="244">244</a> <a href="#245" id="245">245</a> <a href="#246" id="246">246</a> <a href="#247" id="247">247</a> <a href="#248" id="248">248</a> <a href="#249" id="249">249</a> <a href="#250" id="250">250</a> <a href="#251" id="251">251</a> <a href="#252" id="252">252</a> <a href="#253" id="253">253</a> <a href="#254" id="254">254</a> <a href="#255" id="255">255</a> <a href="#256" id="256">256</a> <a href="#257" id="257">257</a> <a href="#258" id="258">258</a> <a href="#259" id="259">259</a> <a href="#260" id="260">260</a> <a href="#261" id="261">261</a> <a href="#262" id="262">262</a> <a href="#263" id="263">263</a> <a href="#264" id="264">264</a> <a href="#265" id="265">265</a> <a href="#266" id="266">266</a> <a href="#267" id="267">267</a> <a href="#268" id="268">268</a> <a href="#269" id="269">269</a> <a href="#270" id="270">270</a> <a href="#271" id="271">271</a> <a href="#272" id="272">272</a> <a href="#273" id="273">273</a> <a href="#274" id="274">274</a> <a href="#275" id="275">275</a> <a href="#276" id="276">276</a> <a href="#277" id="277">277</a> <a href="#278" id="278">278</a> <a href="#279" id="279">279</a> <a href="#280" id="280">280</a> <a href="#281" id="281">281</a> <a href="#282" id="282">282</a> <a href="#283" id="283">283</a> <a href="#284" id="284">284</a> <a href="#285" id="285">285</a> <a href="#286" id="286">286</a> <a href="#287" id="287">287</a> <a href="#288" id="288">288</a> <a href="#289" id="289">289</a> <a href="#290" id="290">290</a> <a href="#291" id="291">291</a> <a href="#292" id="292">292</a> <a href="#293" id="293">293</a> <a href="#294" id="294">294</a> <a href="#295" id="295">295</a> <a href="#296" id="296">296</a> <a href="#297" id="297">297</a> <a href="#298" id="298">298</a> <a href="#299" id="299">299</a> <a href="#300" id="300">300</a> <a href="#301" id="301">301</a> <a href="#302" id="302">302</a> <a href="#303" id="303">303</a> <a href="#304" id="304">304</a> <a href="#305" id="305">305</a> <a href="#306" id="306">306</a> <a href="#307" id="307">307</a> <a href="#308" id="308">308</a> <a href="#309" id="309">309</a> <a href="#310" id="310">310</a> <a href="#311" id="311">311</a> <a href="#312" id="312">312</a> <a href="#313" id="313">313</a> <a href="#314" id="314">314</a> <a href="#315" id="315">315</a> <a href="#316" id="316">316</a> <a href="#317" id="317">317</a> <a href="#318" id="318">318</a> <a href="#319" id="319">319</a> <a href="#320" id="320">320</a> <a href="#321" id="321">321</a> <a href="#322" id="322">322</a> <a href="#323" id="323">323</a> <a href="#324" id="324">324</a> <a href="#325" id="325">325</a> <a href="#326" id="326">326</a> <a href="#327" id="327">327</a> <a href="#328" id="328">328</a> <a href="#329" id="329">329</a> <a href="#330" id="330">330</a> <a href="#331" id="331">331</a> <a href="#332" id="332">332</a></pre></div><pre class="rust"><code><span class="doccomment">//! Combinators and utilities for working with `Future`s, `Stream`s, `Sink`s, //! and the `AsyncRead` and `AsyncWrite` traits. </span><span class="attr">#![no_std] #![doc(test( no_crate_inject, attr( deny(warnings, rust_2018_idioms, single_use_lifetimes), allow(dead_code, unused_assignments, unused_variables) ) ))] #![warn(missing_docs, unsafe_op_in_unsafe_fn)] #![cfg_attr(docsrs, feature(doc_cfg))] #[cfg(all(feature = <span class="string">"bilock"</span>, not(feature = <span class="string">"unstable"</span>)))] </span><span class="macro">compile_error!</span>(<span class="string">"The `bilock` feature requires the `unstable` feature as an explicit opt-in to unstable features"</span>); <span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)] </span><span class="kw">extern crate </span>alloc; <span class="attr">#[cfg(feature = <span class="string">"std"</span>)] </span><span class="kw">extern crate </span>std; <span class="comment">// Macro re-exports </span><span class="kw">pub use </span>futures_core::ready; <span class="kw">pub use </span>pin_utils::pin_mut; <span class="attr">#[cfg(feature = <span class="string">"async-await"</span>)] #[macro_use] </span><span class="kw">mod </span>async_await; <span class="attr">#[cfg(feature = <span class="string">"async-await"</span>)] #[doc(hidden)] </span><span class="kw">pub use </span><span class="self">self</span>::async_await::<span class="kw-2">*</span>; <span class="comment">// Not public API. </span><span class="attr">#[cfg(feature = <span class="string">"async-await"</span>)] #[doc(hidden)] </span><span class="kw">pub mod </span>__private { <span class="kw">pub use crate</span>::<span class="kw-2">*</span>; <span class="kw">pub use </span>core::{ option::Option::{<span class="self">self</span>, <span class="prelude-val">None</span>, <span class="prelude-val">Some</span>}, pin::Pin, result::Result::{<span class="prelude-val">Err</span>, <span class="prelude-val">Ok</span>}, }; <span class="kw">pub mod </span>async_await { <span class="kw">pub use </span><span class="kw">crate</span>::async_await::<span class="kw-2">*</span>; } } <span class="attr">#[cfg(feature = <span class="string">"sink"</span>)] </span><span class="macro">macro_rules!</span> delegate_sink { (<span class="macro-nonterminal">$field</span>:ident, <span class="macro-nonterminal">$item</span>:ty) => { <span class="kw">fn </span>poll_ready( <span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>core::task::Context<<span class="lifetime">'_</span>>, ) -> core::task::Poll<<span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>> { <span class="self">self</span>.project().<span class="macro-nonterminal">$field</span>.poll_ready(cx) } <span class="kw">fn </span>start_send(<span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, item: <span class="macro-nonterminal">$item</span>) -> <span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error> { <span class="self">self</span>.project().<span class="macro-nonterminal">$field</span>.start_send(item) } <span class="kw">fn </span>poll_flush( <span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>core::task::Context<<span class="lifetime">'_</span>>, ) -> core::task::Poll<<span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>> { <span class="self">self</span>.project().<span class="macro-nonterminal">$field</span>.poll_flush(cx) } <span class="kw">fn </span>poll_close( <span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>core::task::Context<<span class="lifetime">'_</span>>, ) -> core::task::Poll<<span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>> { <span class="self">self</span>.project().<span class="macro-nonterminal">$field</span>.poll_close(cx) } }; } <span class="macro">macro_rules!</span> delegate_future { (<span class="macro-nonterminal">$field</span>:ident) => { <span class="kw">fn </span>poll( <span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>core::task::Context<<span class="lifetime">'_</span>>, ) -> core::task::Poll<<span class="self">Self</span>::Output> { <span class="self">self</span>.project().<span class="macro-nonterminal">$field</span>.poll(cx) } }; } <span class="macro">macro_rules!</span> delegate_stream { (<span class="macro-nonterminal">$field</span>:ident) => { <span class="kw">fn </span>poll_next( <span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>core::task::Context<<span class="lifetime">'_</span>>, ) -> core::task::Poll<<span class="prelude-ty">Option</span><<span class="self">Self</span>::Item>> { <span class="self">self</span>.project().<span class="macro-nonterminal">$field</span>.poll_next(cx) } <span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> (usize, <span class="prelude-ty">Option</span><usize>) { <span class="self">self</span>.<span class="macro-nonterminal">$field</span>.size_hint() } }; } <span class="attr">#[cfg(feature = <span class="string">"io"</span>)] #[cfg(feature = <span class="string">"std"</span>)] </span><span class="macro">macro_rules!</span> delegate_async_write { (<span class="macro-nonterminal">$field</span>:ident) => { <span class="kw">fn </span>poll_write( <span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>core::task::Context<<span class="lifetime">'_</span>>, buf: <span class="kw-2">&</span>[u8], ) -> core::task::Poll<std::io::Result<usize>> { <span class="self">self</span>.project().<span class="macro-nonterminal">$field</span>.poll_write(cx, buf) } <span class="kw">fn </span>poll_write_vectored( <span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>core::task::Context<<span class="lifetime">'_</span>>, bufs: <span class="kw-2">&</span>[std::io::IoSlice<<span class="lifetime">'_</span>>], ) -> core::task::Poll<std::io::Result<usize>> { <span class="self">self</span>.project().<span class="macro-nonterminal">$field</span>.poll_write_vectored(cx, bufs) } <span class="kw">fn </span>poll_flush( <span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>core::task::Context<<span class="lifetime">'_</span>>, ) -> core::task::Poll<std::io::Result<()>> { <span class="self">self</span>.project().<span class="macro-nonterminal">$field</span>.poll_flush(cx) } <span class="kw">fn </span>poll_close( <span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>core::task::Context<<span class="lifetime">'_</span>>, ) -> core::task::Poll<std::io::Result<()>> { <span class="self">self</span>.project().<span class="macro-nonterminal">$field</span>.poll_close(cx) } }; } <span class="attr">#[cfg(feature = <span class="string">"io"</span>)] #[cfg(feature = <span class="string">"std"</span>)] </span><span class="macro">macro_rules!</span> delegate_async_read { (<span class="macro-nonterminal">$field</span>:ident) => { <span class="kw">fn </span>poll_read( <span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>core::task::Context<<span class="lifetime">'_</span>>, buf: <span class="kw-2">&mut </span>[u8], ) -> core::task::Poll<std::io::Result<usize>> { <span class="self">self</span>.project().<span class="macro-nonterminal">$field</span>.poll_read(cx, buf) } <span class="kw">fn </span>poll_read_vectored( <span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>core::task::Context<<span class="lifetime">'_</span>>, bufs: <span class="kw-2">&mut </span>[std::io::IoSliceMut<<span class="lifetime">'_</span>>], ) -> core::task::Poll<std::io::Result<usize>> { <span class="self">self</span>.project().<span class="macro-nonterminal">$field</span>.poll_read_vectored(cx, bufs) } }; } <span class="attr">#[cfg(feature = <span class="string">"io"</span>)] #[cfg(feature = <span class="string">"std"</span>)] </span><span class="macro">macro_rules!</span> delegate_async_buf_read { (<span class="macro-nonterminal">$field</span>:ident) => { <span class="kw">fn </span>poll_fill_buf( <span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>core::task::Context<<span class="lifetime">'_</span>>, ) -> core::task::Poll<std::io::Result<<span class="kw-2">&</span>[u8]>> { <span class="self">self</span>.project().<span class="macro-nonterminal">$field</span>.poll_fill_buf(cx) } <span class="kw">fn </span>consume(<span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, amt: usize) { <span class="self">self</span>.project().<span class="macro-nonterminal">$field</span>.consume(amt) } }; } <span class="macro">macro_rules!</span> delegate_access_inner { (<span class="macro-nonterminal">$field</span>:ident, <span class="macro-nonterminal">$inner</span>:ty, ($(<span class="macro-nonterminal">$ind</span>:tt)<span class="kw-2">*</span>)) => { <span class="doccomment">/// Acquires a reference to the underlying sink or stream that this combinator is /// pulling from. </span><span class="kw">pub fn </span>get_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="macro-nonterminal">$inner </span>{ (<span class="kw-2">&</span><span class="self">self</span>.<span class="macro-nonterminal">$field</span>) $(<span class="macro-nonterminal">$ind </span>get_ref())* } <span class="doccomment">/// Acquires a mutable reference to the underlying sink or stream that this /// combinator is pulling from. /// /// Note that care must be taken to avoid tampering with the state of the /// sink or stream which may otherwise confuse this combinator. </span><span class="kw">pub fn </span>get_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span><span class="macro-nonterminal">$inner </span>{ (<span class="kw-2">&mut </span><span class="self">self</span>.<span class="macro-nonterminal">$field</span>) $(<span class="macro-nonterminal">$ind </span>get_mut())* } <span class="doccomment">/// Acquires a pinned mutable reference to the underlying sink or stream that this /// combinator is pulling from. /// /// Note that care must be taken to avoid tampering with the state of the /// sink or stream which may otherwise confuse this combinator. </span><span class="kw">pub fn </span>get_pin_mut(<span class="self">self</span>: core::pin::Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>) -> core::pin::Pin<<span class="kw-2">&mut </span><span class="macro-nonterminal">$inner</span>> { <span class="self">self</span>.project().<span class="macro-nonterminal">$field </span>$(<span class="macro-nonterminal">$ind </span>get_pin_mut())* } <span class="doccomment">/// Consumes this combinator, returning the underlying sink or stream. /// /// Note that this may discard intermediate state of this combinator, so /// care should be taken to avoid losing resources when this is called. </span><span class="kw">pub fn </span>into_inner(<span class="self">self</span>) -> <span class="macro-nonterminal">$inner </span>{ <span class="self">self</span>.<span class="macro-nonterminal">$field </span>$(<span class="macro-nonterminal">$ind </span>into_inner())* } } } <span class="macro">macro_rules!</span> delegate_all { (@<span class="kw">trait </span>Future <span class="macro-nonterminal">$name</span>:ident < $(<span class="macro-nonterminal">$arg</span>:ident),* > (<span class="macro-nonterminal">$t</span>:ty) $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>:tt)<span class="kw-2">*</span>)<span class="kw-2">*</span>) => { <span class="kw">impl</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> futures_core::future::Future <span class="kw">for </span><span class="macro-nonterminal">$name</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> <span class="kw">where </span><span class="macro-nonterminal">$t</span>: futures_core::future::Future $(, $(<span class="macro-nonterminal">$bound</span>)<span class="kw-2">*</span>)* { <span class="kw">type </span>Output = <<span class="macro-nonterminal">$t </span><span class="kw">as </span>futures_core::future::Future>::Output; <span class="macro">delegate_future!</span>(inner); } }; (@<span class="kw">trait </span>FusedFuture <span class="macro-nonterminal">$name</span>:ident < $(<span class="macro-nonterminal">$arg</span>:ident),* > (<span class="macro-nonterminal">$t</span>:ty) $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>:tt)<span class="kw-2">*</span>)<span class="kw-2">*</span>) => { <span class="kw">impl</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> futures_core::future::FusedFuture <span class="kw">for </span><span class="macro-nonterminal">$name</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> <span class="kw">where </span><span class="macro-nonterminal">$t</span>: futures_core::future::FusedFuture $(, $(<span class="macro-nonterminal">$bound</span>)<span class="kw-2">*</span>)* { <span class="kw">fn </span>is_terminated(<span class="kw-2">&</span><span class="self">self</span>) -> bool { <span class="self">self</span>.inner.is_terminated() } } }; (@<span class="kw">trait </span>Stream <span class="macro-nonterminal">$name</span>:ident < $(<span class="macro-nonterminal">$arg</span>:ident),* > (<span class="macro-nonterminal">$t</span>:ty) $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>:tt)<span class="kw-2">*</span>)<span class="kw-2">*</span>) => { <span class="kw">impl</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> futures_core::stream::Stream <span class="kw">for </span><span class="macro-nonterminal">$name</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> <span class="kw">where </span><span class="macro-nonterminal">$t</span>: futures_core::stream::Stream $(, $(<span class="macro-nonterminal">$bound</span>)<span class="kw-2">*</span>)* { <span class="kw">type </span>Item = <<span class="macro-nonterminal">$t </span><span class="kw">as </span>futures_core::stream::Stream>::Item; <span class="macro">delegate_stream!</span>(inner); } }; (@<span class="kw">trait </span>FusedStream <span class="macro-nonterminal">$name</span>:ident < $(<span class="macro-nonterminal">$arg</span>:ident),* > (<span class="macro-nonterminal">$t</span>:ty) $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>:tt)<span class="kw-2">*</span>)<span class="kw-2">*</span>) => { <span class="kw">impl</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> futures_core::stream::FusedStream <span class="kw">for </span><span class="macro-nonterminal">$name</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> <span class="kw">where </span><span class="macro-nonterminal">$t</span>: futures_core::stream::FusedStream $(, $(<span class="macro-nonterminal">$bound</span>)<span class="kw-2">*</span>)* { <span class="kw">fn </span>is_terminated(<span class="kw-2">&</span><span class="self">self</span>) -> bool { <span class="self">self</span>.inner.is_terminated() } } }; (@<span class="kw">trait </span>Sink <span class="macro-nonterminal">$name</span>:ident < $(<span class="macro-nonterminal">$arg</span>:ident),* > (<span class="macro-nonterminal">$t</span>:ty) $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>:tt)<span class="kw-2">*</span>)<span class="kw-2">*</span>) => { <span class="attr">#[cfg(feature = <span class="string">"sink"</span>)] </span><span class="kw">impl</span><_Item, $(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> futures_sink::Sink<_Item> <span class="kw">for </span><span class="macro-nonterminal">$name</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> <span class="kw">where </span><span class="macro-nonterminal">$t</span>: futures_sink::Sink<_Item> $(, $(<span class="macro-nonterminal">$bound</span>)<span class="kw-2">*</span>)* { <span class="kw">type </span>Error = <<span class="macro-nonterminal">$t </span><span class="kw">as </span>futures_sink::Sink<_Item>>::Error; <span class="macro">delegate_sink!</span>(inner, _Item); } }; (@<span class="kw">trait </span>Debug <span class="macro-nonterminal">$name</span>:ident < $(<span class="macro-nonterminal">$arg</span>:ident),* > (<span class="macro-nonterminal">$t</span>:ty) $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>:tt)<span class="kw-2">*</span>)<span class="kw-2">*</span>) => { <span class="kw">impl</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> core::fmt::Debug <span class="kw">for </span><span class="macro-nonterminal">$name</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> <span class="kw">where </span><span class="macro-nonterminal">$t</span>: core::fmt::Debug $(, $(<span class="macro-nonterminal">$bound</span>)<span class="kw-2">*</span>)* { <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>core::fmt::Formatter<<span class="lifetime">'_</span>>) -> core::fmt::Result { core::fmt::Debug::fmt(<span class="kw-2">&</span><span class="self">self</span>.inner, f) } } }; (@<span class="kw">trait </span>AccessInner[<span class="macro-nonterminal">$inner</span>:ty, ($(<span class="macro-nonterminal">$ind</span>:tt)<span class="kw-2">*</span>)] <span class="macro-nonterminal">$name</span>:ident < $(<span class="macro-nonterminal">$arg</span>:ident),* > (<span class="macro-nonterminal">$t</span>:ty) $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>:tt)<span class="kw-2">*</span>)<span class="kw-2">*</span>) => { <span class="kw">impl</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> <span class="macro-nonterminal">$name</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>)<span class="kw-2">*</span>)* { <span class="macro">delegate_access_inner!</span>(inner, <span class="macro-nonterminal">$inner</span>, ($(<span class="macro-nonterminal">$ind</span>)<span class="kw-2">*</span>)); } }; (@<span class="kw">trait </span>New[|$(<span class="macro-nonterminal">$param</span>:ident: <span class="macro-nonterminal">$paramt</span>:ty),<span class="kw-2">*</span>| <span class="macro-nonterminal">$cons</span>:expr] <span class="macro-nonterminal">$name</span>:ident < $(<span class="macro-nonterminal">$arg</span>:ident),* > (<span class="macro-nonterminal">$t</span>:ty) $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>:tt)<span class="kw-2">*</span>)<span class="kw-2">*</span>) => { <span class="kw">impl</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> <span class="macro-nonterminal">$name</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>)<span class="kw-2">*</span>)* { <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new($(<span class="macro-nonterminal">$param</span>: <span class="macro-nonterminal">$paramt</span>),<span class="kw-2">*</span>) -> <span class="self">Self </span>{ <span class="self">Self </span>{ inner: <span class="macro-nonterminal">$cons </span>} } } }; ($(<span class="attr">#[<span class="macro-nonterminal">$attr</span>:meta]</span>)* <span class="macro-nonterminal">$name</span>:ident<$(<span class="macro-nonterminal">$arg</span>:ident),<span class="kw-2">*</span>>(<span class="macro-nonterminal">$t</span>:ty) : <span class="macro-nonterminal">$ftrait</span>:ident $([$(<span class="macro-nonterminal">$targs</span>:tt)<span class="kw-2">*</span>])* $({$(<span class="macro-nonterminal">$item</span>:tt)<span class="kw-2">*</span>})* $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>:tt)<span class="kw-2">*</span>)<span class="kw-2">*</span>) => { <span class="macro">pin_project_lite::pin_project!</span> { <span class="attr">#[must_use = <span class="string">"futures/streams/sinks do nothing unless you `.await` or poll them"</span>] </span>$(<span class="attr">#[<span class="macro-nonterminal">$attr</span>]</span>)* <span class="kw">pub struct </span><span class="macro-nonterminal">$name</span>< $(<span class="macro-nonterminal">$arg</span>),* > $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>)<span class="kw-2">*</span>)* { <span class="attr">#[pin] </span>inner: <span class="macro-nonterminal">$t </span>} } <span class="kw">impl</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>> <span class="macro-nonterminal">$name</span>< $(<span class="macro-nonterminal">$arg</span>),* > $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>)<span class="kw-2">*</span>)* { $($(<span class="macro-nonterminal">$item</span>)<span class="kw-2">*</span>)* } <span class="macro">delegate_all!</span>(@<span class="kw">trait </span><span class="macro-nonterminal">$ftrait </span>$([$(<span class="macro-nonterminal">$targs</span>)<span class="kw-2">*</span>])* <span class="macro-nonterminal">$name</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>>(<span class="macro-nonterminal">$t</span>) $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>)<span class="kw-2">*</span>)<span class="kw-2">*</span>); }; ($(<span class="attr">#[<span class="macro-nonterminal">$attr</span>:meta]</span>)* <span class="macro-nonterminal">$name</span>:ident<$(<span class="macro-nonterminal">$arg</span>:ident),<span class="kw-2">*</span>>(<span class="macro-nonterminal">$t</span>:ty) : <span class="macro-nonterminal">$ftrait</span>:ident $([$(<span class="macro-nonterminal">$ftargs</span>:tt)<span class="kw-2">*</span>])* + <span class="macro-nonterminal">$strait</span>:ident $([$(<span class="macro-nonterminal">$stargs</span>:tt)<span class="kw-2">*</span>])* $(+ <span class="macro-nonterminal">$</span><span class="kw">trait</span>:<span class="macro-nonterminal">ident </span>$([$(<span class="macro-nonterminal">$targs</span>:tt)<span class="kw-2">*</span>])<span class="kw-2">*</span>)* $({$(<span class="macro-nonterminal">$item</span>:tt)<span class="kw-2">*</span>})* $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>:tt)<span class="kw-2">*</span>)<span class="kw-2">*</span>) => { <span class="macro">delegate_all!</span>($(<span class="attr">#[<span class="macro-nonterminal">$attr</span>]</span>)* <span class="macro-nonterminal">$name</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>>(<span class="macro-nonterminal">$t</span>) : <span class="macro-nonterminal">$strait </span>$([$(<span class="macro-nonterminal">$stargs</span>)<span class="kw-2">*</span>])* $(+ <span class="macro-nonterminal">$</span><span class="kw">trait </span>$([$(<span class="macro-nonterminal">$targs</span>)<span class="kw-2">*</span>])<span class="kw-2">*</span>)* $({$(<span class="macro-nonterminal">$item</span>)<span class="kw-2">*</span>})* $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>)<span class="kw-2">*</span>)<span class="kw-2">*</span>); <span class="macro">delegate_all!</span>(@<span class="kw">trait </span><span class="macro-nonterminal">$ftrait </span>$([$(<span class="macro-nonterminal">$ftargs</span>)<span class="kw-2">*</span>])* <span class="macro-nonterminal">$name</span><$(<span class="macro-nonterminal">$arg</span>),<span class="kw-2">*</span>>(<span class="macro-nonterminal">$t</span>) $(<span class="kw">where </span>$(<span class="macro-nonterminal">$bound</span>)<span class="kw-2">*</span>)<span class="kw-2">*</span>); }; } <span class="kw">pub mod </span>future; <span class="attr">#[doc(no_inline)] </span><span class="kw">pub use </span><span class="kw">crate</span>::future::{Future, FutureExt, TryFuture, TryFutureExt}; <span class="kw">pub mod </span>stream; <span class="attr">#[doc(no_inline)] </span><span class="kw">pub use </span><span class="kw">crate</span>::stream::{Stream, StreamExt, TryStream, TryStreamExt}; <span class="attr">#[cfg(feature = <span class="string">"sink"</span>)] #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"sink"</span>)))] </span><span class="kw">pub mod </span>sink; <span class="attr">#[cfg(feature = <span class="string">"sink"</span>)] #[doc(no_inline)] </span><span class="kw">pub use </span><span class="kw">crate</span>::sink::{Sink, SinkExt}; <span class="kw">pub mod </span>task; <span class="kw">pub mod </span>never; <span class="attr">#[cfg(feature = <span class="string">"compat"</span>)] #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"compat"</span>)))] </span><span class="kw">pub mod </span>compat; <span class="attr">#[cfg(feature = <span class="string">"io"</span>)] #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"io"</span>)))] #[cfg(feature = <span class="string">"std"</span>)] </span><span class="kw">pub mod </span>io; <span class="attr">#[cfg(feature = <span class="string">"io"</span>)] #[cfg(feature = <span class="string">"std"</span>)] #[doc(no_inline)] </span><span class="kw">pub use </span><span class="kw">crate</span>::io::{ AsyncBufRead, AsyncBufReadExt, AsyncRead, AsyncReadExt, AsyncSeek, AsyncSeekExt, AsyncWrite, AsyncWriteExt, }; <span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)] </span><span class="kw">pub mod </span>lock; <span class="attr">#[cfg_attr(target_os = <span class="string">"none"</span>, cfg(target_has_atomic = <span class="string">"ptr"</span>))] #[cfg(feature = <span class="string">"alloc"</span>)] </span><span class="kw">mod </span>abortable; <span class="kw">mod </span>fns; <span class="kw">mod </span>unfold_state; </code></pre></div></section></main></body></html>