Strona główna Odkrywaj Pomoc
Zaloguj się
RONCC
/
HPC-Tools-for-Quantum-Computing
Obserwuj 1
Polub 0
Forkuj 0
Pliki Problemy 0 Oczekujące zmiany 0 Wiki
Drzewo: e971e022d2
Gałęzie Tagi
HPC-Tools-fo...
/
doc
/
futures
/
sink
/
struct.Wait.html

struct.Wait.html 13 KB
Historia Czysty

1234567891011121314151617181920212223242526272829303132333435363738394041 
  1. <!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="API documentation for the Rust `Wait` struct in crate `futures`."><meta name="keywords" content="rust, rustlang, rust-lang, Wait"><title>futures::sink::Wait - Rust</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="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[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">&#9776;</div><p class='location'>Struct Wait</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.send">send</a><a href="#method.flush">flush</a><a href="#method.close">close</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='../index.html'>futures</a>::<wbr><a href='index.html'>sink</a></p><script>window.sidebarCurrent = {name: 'Wait', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></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"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>futures</a>::<wbr><a href='index.html'>sink</a>::<wbr><a class="struct" href=''>Wait</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/futures/sink/wait.rs.html#12-14' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'><div class="docblock attributes">#[must_use = "sinks do nothing unless used"]
    2. 

  2. </div>pub struct Wait&lt;S&gt; { /* fields omitted */ }</pre></div><div class='docblock'><p>A sink combinator which converts an asynchronous sink to a <strong>blocking
    3. 

  3. sink</strong>.</p>
    4. 

  4. <p>Created by the <code>Sink::wait</code> method, this function transforms any sink into a
    5. 

  5. blocking version. This is implemented by blocking the current thread when a
    6. 

  6. sink is otherwise unable to make progress.</p>
    7. 

  7. </div>
    8. 

  8.                     <h2 id='methods' class='small-section-header'>
    9. 

  9.                       Methods<a href='#methods' class='anchor'></a>
    10. 

  10.                     </h2>
    11. 

  11.                 <h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;S:&nbsp;<a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&gt; <a class="struct" href="../../futures/sink/struct.Wait.html" title="struct futures::sink::Wait">Wait</a>&lt;S&gt;</code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/sink/wait.rs.html#22-59' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.send' class="method"><span id='send.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.send' class='fnname'>send</a>(&amp;mut self, value: S::<a class="type" href="../../futures/sink/trait.Sink.html#associatedtype.SinkItem" title="type futures::sink::Sink::SinkItem">SinkItem</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, S::<a class="type" href="../../futures/sink/trait.Sink.html#associatedtype.SinkError" title="type futures::sink::Sink::SinkError">SinkError</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/sink/wait.rs.html#36-38' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sends a value to this sink, blocking the current thread until it's able
    12. 

  12. to do so.</p>
    13. 

  13. <p>This function will take the <code>value</code> provided and call the underlying
    14. 

  14. sink's <code>start_send</code> function until it's ready to accept the value. If
    15. 

  15. the function returns <code>NotReady</code> then the current thread is blocked
    16. 

  16. until it is otherwise ready to accept the value.</p>
    17. 

  17. <h1 id="return-value" class="section-header"><a href="#return-value">Return value</a></h1>
    18. 

  18. <p>If <code>Ok(())</code> is returned then the <code>value</code> provided was successfully sent
    19. 

  19. along the sink, and if <code>Err(e)</code> is returned then an error occurred
    20. 

  20. which prevented the value from being sent.</p>
    21. 

  21. </div><h4 id='method.flush' class="method"><span id='flush.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.flush' class='fnname'>flush</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, S::<a class="type" href="../../futures/sink/trait.Sink.html#associatedtype.SinkError" title="type futures::sink::Sink::SinkError">SinkError</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/sink/wait.rs.html#47-49' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Flushes any buffered data in this sink, blocking the current thread
    22. 

  22. until it's entirely flushed.</p>
    23. 

  23. <p>This function will call the underlying sink's <code>poll_complete</code> method
    24. 

  24. until it returns that it's ready to proceed. If the method returns
    25. 

  25. <code>NotReady</code> the current thread will be blocked until it's otherwise
    26. 

  26. ready to proceed.</p>
    27. 

  27. </div><h4 id='method.close' class="method"><span id='close.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.close' class='fnname'>close</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, S::<a class="type" href="../../futures/sink/trait.Sink.html#associatedtype.SinkError" title="type futures::sink::Sink::SinkError">SinkError</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/sink/wait.rs.html#56-58' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Close this sink, blocking the current thread until it's entirely closed.</p>
    28. 

  28. <p>This function will call the underlying sink's <code>close</code> method
    29. 

  29. until it returns that it's closed. If the method returns
    30. 

  30. <code>NotReady</code> the current thread will be blocked until it's otherwise closed.</p>
    31. 

  31. </div></div>
    32. 

  32.                 <h2 id='implementations' class='small-section-header'>
    33. 

  33.                   Trait Implementations<a href='#implementations' class='anchor'></a>
    34. 

  34.                 </h2>
    35. 

  35.                 <div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;S:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../futures/sink/struct.Wait.html" title="struct futures::sink::Wait">Wait</a>&lt;S&gt;</code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/sink/wait.rs.html#11' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/sink/wait.rs.html#11' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
    36. 

  36. </div></div></div>
    37. 

  37.                 <h2 id='synthetic-implementations' class='small-section-header'>
    38. 

  38.                   Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
    39. 

  39.                 </h2>
    40. 

  40.                 <div id='synthetic-implementations-list'>
    41. 

  41.             <h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;S&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../futures/sink/struct.Wait.html" title="struct futures::sink::Wait">Wait</a>&lt;S&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,&nbsp;</span></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;S&gt; !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../futures/sink/struct.Wait.html" title="struct futures::sink::Wait">Wait</a>&lt;S&gt;</code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>&#9166;</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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "futures";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
    42.