RONCC
/
HPC-Tools-for-Quantum-Computing


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252
							<!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 `mpsc` mod in crate `futures`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, mpsc">

    <title>futures::sync::mpsc - 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="../../../main.css" id="themeStyle">
    <script src="../../../storage.js"></script>
    

    
    
</head>
<body class="rustdoc mod">
    <!--[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'>Module mpsc</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../../index.html'>futures</a>::<wbr><a href='../index.html'>sync</a></p><script>window.sidebarCurrent = {name: 'mpsc', ty: 'mod', 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">
            </div>
        </form>
    </nav>

    <section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Module <a href='../../index.html'>futures</a>::<wbr><a href='../index.html'>sync</a>::<wbr><a class="mod" href=''>mpsc</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/sync/mpsc/mod.rs.html#1-1149' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>A multi-producer, single-consumer, futures-aware, FIFO queue with back pressure.</p>
<p>A channel can be used as a communication primitive between tasks running on
<code>futures-rs</code> executors. Channel creation provides <code>Receiver</code> and <code>Sender</code>
handles. <code>Receiver</code> implements <code>Stream</code> and allows a task to read values
out of the channel. If there is no message to read from the channel, the
current task will be notified when a new value is sent. <code>Sender</code> implements
the <code>Sink</code> trait and allows a task to send messages into the channel. If
the channel is at capacity, then send will be rejected and the task will be
notified when additional capacity is available.</p>
<h1 id="disconnection" class="section-header"><a href="#disconnection">Disconnection</a></h1>
<p>When all <code>Sender</code> handles have been dropped, it is no longer possible to
send values into the channel. This is considered the termination event of
the stream. As such, <code>Sender::poll</code> will return <code>Ok(Ready(None))</code>.</p>
<p>If the receiver handle is dropped, then messages can no longer be read out
of the channel. In this case, a <code>send</code> will result in an error.</p>
<h1 id="clean-shutdown" class="section-header"><a href="#clean-shutdown">Clean Shutdown</a></h1>
<p>If the <code>Receiver</code> is simply dropped, then it is possible for there to be
messages still in the channel that will not be processed. As such, it is
usually desirable to perform a &quot;clean&quot; shutdown. To do this, the receiver
will first call <code>close</code>, which will prevent any further messages to be sent
into the channel. Then, the receiver consumes the channel to completion, at
which point the receiver can be dropped.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.Execute.html"
                                  title='struct futures::sync::mpsc::Execute'>Execute</a></td>
                           <td class='docblock-short'>
                                <p>Type of future which <code>Executor</code> instances must be able to execute for <code>spawn</code>.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.Receiver.html"
                                  title='struct futures::sync::mpsc::Receiver'>Receiver</a></td>
                           <td class='docblock-short'>
                                <p>The receiving end of a channel which implements the <code>Stream</code> trait.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.SendError.html"
                                  title='struct futures::sync::mpsc::SendError'>SendError</a></td>
                           <td class='docblock-short'>
                                <p>Error type for sending, used when the receiving end of a channel is
dropped</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.Sender.html"
                                  title='struct futures::sync::mpsc::Sender'>Sender</a></td>
                           <td class='docblock-short'>
                                <p>The transmission end of a channel which is used to send values.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.SpawnHandle.html"
                                  title='struct futures::sync::mpsc::SpawnHandle'>SpawnHandle</a></td>
                           <td class='docblock-short'>
                                <p>Handle returned from the <code>spawn</code> function.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.TrySendError.html"
                                  title='struct futures::sync::mpsc::TrySendError'>TrySendError</a></td>
                           <td class='docblock-short'>
                                <p>Error type returned from <code>try_send</code></p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.UnboundedReceiver.html"
                                  title='struct futures::sync::mpsc::UnboundedReceiver'>UnboundedReceiver</a></td>
                           <td class='docblock-short'>
                                <p>The receiving end of a channel which implements the <code>Stream</code> trait.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.UnboundedSender.html"
                                  title='struct futures::sync::mpsc::UnboundedSender'>UnboundedSender</a></td>
                           <td class='docblock-short'>
                                <p>The transmission end of a channel which is used to send values.</p>

                           </td>
                       </tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.channel.html"
                                  title='fn futures::sync::mpsc::channel'>channel</a></td>
                           <td class='docblock-short'>
                                <p>Creates an in-memory channel implementation of the <code>Stream</code> trait with
bounded capacity.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.spawn.html"
                                  title='fn futures::sync::mpsc::spawn'>spawn</a></td>
                           <td class='docblock-short'>
                                <p>Spawns a <code>stream</code> onto the instance of <code>Executor</code> provided, <code>executor</code>,
returning a handle representing the remote stream.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.spawn_unbounded.html"
                                  title='fn futures::sync::mpsc::spawn_unbounded'>spawn_unbounded</a></td>
                           <td class='docblock-short'>
                                <p>Spawns a <code>stream</code> onto the instance of <code>Executor</code> provided, <code>executor</code>,
returning a handle representing the remote stream, with unbounded buffering.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.unbounded.html"
                                  title='fn futures::sync::mpsc::unbounded'>unbounded</a></td>
                           <td class='docblock-short'>
                                <p>Creates an in-memory channel implementation of the <code>Stream</code> trait with
unbounded capacity.</p>

                           </td>
                       </tr></table></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>
            </div>
        </div>
    </aside>

    

    <script>
        window.rootPath = "../../../";
        window.currentCrate = "futures";
    </script>
    <script src="../../../main.js"></script>
    <script defer src="../../../search-index.js"></script>
</body>
</html>