<!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 to the Rust file `/Users/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/futures-0.1.20/src/sink/wait.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>wait.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../../dark.css">
<link rel="stylesheet" type="text/css" href="../../../main.css" id="themeStyle">
<script src="../../../storage.js"></script>
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><pre class="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>
</pre><pre class="rust ">
<span class="kw">use</span> <span class="ident">sink</span>::<span class="ident">Sink</span>;
<span class="kw">use</span> <span class="ident">executor</span>;
<span class="doccomment">/// A sink combinator which converts an asynchronous sink to a **blocking</span>
<span class="doccomment">/// sink**.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Created by the `Sink::wait` method, this function transforms any sink into a</span>
<span class="doccomment">/// blocking version. This is implemented by blocking the current thread when a</span>
<span class="doccomment">/// sink is otherwise unable to make progress.</span>
<span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">"sinks do nothing unless used"</span>]</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Wait</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
<span class="ident">sink</span>: <span class="ident">executor</span>::<span class="ident">Spawn</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>,
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Sink</span><span class="op">></span>(<span class="ident">s</span>: <span class="ident">S</span>) <span class="op">-></span> <span class="ident">Wait</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
<span class="ident">Wait</span> {
<span class="ident">sink</span>: <span class="ident">executor</span>::<span class="ident">spawn</span>(<span class="ident">s</span>),
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Sink</span><span class="op">></span> <span class="ident">Wait</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
<span class="doccomment">/// Sends a value to this sink, blocking the current thread until it's able</span>
<span class="doccomment">/// to do so.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will take the `value` provided and call the underlying</span>
<span class="doccomment">/// sink's `start_send` function until it's ready to accept the value. If</span>
<span class="doccomment">/// the function returns `NotReady` then the current thread is blocked</span>
<span class="doccomment">/// until it is otherwise ready to accept the value.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Return value</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If `Ok(())` is returned then the `value` provided was successfully sent</span>
<span class="doccomment">/// along the sink, and if `Err(e)` is returned then an error occurred</span>
<span class="doccomment">/// which prevented the value from being sent.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">send</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">value</span>: <span class="ident">S</span>::<span class="ident">SinkItem</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">S</span>::<span class="ident">SinkError</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">sink</span>.<span class="ident">wait_send</span>(<span class="ident">value</span>)
}
<span class="doccomment">/// Flushes any buffered data in this sink, blocking the current thread</span>
<span class="doccomment">/// until it's entirely flushed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will call the underlying sink's `poll_complete` method</span>
<span class="doccomment">/// until it returns that it's ready to proceed. If the method returns</span>
<span class="doccomment">/// `NotReady` the current thread will be blocked until it's otherwise</span>
<span class="doccomment">/// ready to proceed.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">flush</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">S</span>::<span class="ident">SinkError</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">sink</span>.<span class="ident">wait_flush</span>()
}
<span class="doccomment">/// Close this sink, blocking the current thread until it's entirely closed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will call the underlying sink's `close` method</span>
<span class="doccomment">/// until it returns that it's closed. If the method returns</span>
<span class="doccomment">/// `NotReady` the current thread will be blocked until it's otherwise closed.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">close</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">S</span>::<span class="ident">SinkError</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">sink</span>.<span class="ident">wait_close</span>()
}
}
</pre>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>⏎</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../";
window.currentCrate = "futures";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>