224 lines
No EOL
10 KiB
HTML
224 lines
No EOL
10 KiB
HTML
<!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::unsync::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">☰</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'>unsync</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'>unsync</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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../../../src/futures/unsync/mpsc.rs.html#1-474' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>A multi-producer, single-consumer, futures-aware, FIFO queue with back
|
||
pressure, for use communicating between tasks on the same thread.</p>
|
||
<p>These queues are the same as those in <code>futures::sync</code>, except they're not
|
||
intended to be sent across threads.</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::unsync::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::unsync::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::unsync::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::unsync::mpsc::Sender'>Sender</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The transmission end of a channel.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.SpawnHandle.html"
|
||
title='struct futures::unsync::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.UnboundedReceiver.html"
|
||
title='struct futures::unsync::mpsc::UnboundedReceiver'>UnboundedReceiver</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The receiving end of an unbounded channel.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.UnboundedSender.html"
|
||
title='struct futures::unsync::mpsc::UnboundedSender'>UnboundedSender</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The transmission end of an unbounded channel.</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::unsync::mpsc::channel'>channel</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Creates a bounded in-memory channel with buffered storage.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.spawn.html"
|
||
title='fn futures::unsync::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::unsync::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::unsync::mpsc::unbounded'>unbounded</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Creates an unbounded in-memory channel with buffered storage.</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>⏎</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> |