blob: 3331366f4d085da621a2c0f019fe1473e166a5ac [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/sink/send.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>send.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>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::Feed;
<span class="kw">use </span>core::pin::Pin;
<span class="kw">use </span>futures_core::future::Future;
<span class="kw">use </span>futures_core::ready;
<span class="kw">use </span>futures_core::task::{Context, Poll};
<span class="kw">use </span>futures_sink::Sink;
<span class="doccomment">/// Future for the [`send`](super::SinkExt::send) method.
</span><span class="attribute">#[derive(Debug)]
#[must_use = <span class="string">&quot;futures do nothing unless you `.await` or poll them&quot;</span>]
</span><span class="kw">pub struct </span>Send&lt;<span class="lifetime">&#39;a</span>, Si: <span class="question-mark">?</span>Sized, Item&gt; {
feed: Feed&lt;<span class="lifetime">&#39;a</span>, Si, Item&gt;,
}
<span class="comment">// Pinning is never projected to children
</span><span class="kw">impl</span>&lt;Si: Unpin + <span class="question-mark">?</span>Sized, Item&gt; Unpin <span class="kw">for </span>Send&lt;<span class="lifetime">&#39;_</span>, Si, Item&gt; {}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, Si: Sink&lt;Item&gt; + Unpin + <span class="question-mark">?</span>Sized, Item&gt; Send&lt;<span class="lifetime">&#39;a</span>, Si, Item&gt; {
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(sink: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>Si, item: Item) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{ feed: Feed::new(sink, item) }
}
}
<span class="kw">impl</span>&lt;Si: Sink&lt;Item&gt; + Unpin + <span class="question-mark">?</span>Sized, Item&gt; Future <span class="kw">for </span>Send&lt;<span class="lifetime">&#39;_</span>, Si, Item&gt; {
<span class="kw">type </span>Output = <span class="prelude-ty">Result</span>&lt;(), Si::Error&gt;;
<span class="kw">fn </span>poll(<span class="kw-2">mut </span><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;<span class="self">Self</span>::Output&gt; {
<span class="kw">let </span>this = <span class="kw-2">&amp;mut *</span><span class="self">self</span>;
<span class="kw">if </span>this.feed.is_item_pending() {
<span class="macro">ready!</span>(Pin::new(<span class="kw-2">&amp;mut </span>this.feed).poll(cx))<span class="question-mark">?</span>;
<span class="macro">debug_assert!</span>(!this.feed.is_item_pending());
}
<span class="comment">// we&#39;re done sending the item, but want to block on flushing the
// sink
</span><span class="macro">ready!</span>(this.feed.sink_pin_mut().poll_flush(cx))<span class="question-mark">?</span>;
Poll::Ready(<span class="prelude-val">Ok</span>(()))
}
}
</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>