mentat/relay/index.html
2018-08-22 17:04:13 +00:00

181 lines
No EOL
7.8 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `relay` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, relay">
<title>relay - 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'>Crate relay</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'></p><script>window.sidebarCurrent = {name: 'relay', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>relay</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/relay/lib.rs.html#1-319' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><h1 id="relay" class="section-header"><a href="#relay">relay</a></h1>
<p>A light-weight channel using <code>Future</code>. A relay channel does not implement
<code>Send</code>, and so is not meant for synchronizing between threads. Instead,
its used to send message between tasks that live in the same thread.</p>
<p>It is similar to the <code>oneshot</code> channel in the <code>futures</code> crate, but since
it is not meant for sending across threads, it performs about twice as
fast.</p>
<h2 id="example" class="section-header"><a href="#example">Example</a></h2>
<pre class="rust rust-example-rendered">
<span class="kw">let</span> (<span class="ident">tx</span>, <span class="ident">rx</span>) <span class="op">=</span> <span class="ident">relay</span>::<span class="ident">channel</span>();
<span class="ident">tx</span>.<span class="ident">complete</span>(<span class="string">&quot;foo&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">rx</span>.<span class="ident">wait</span>().<span class="ident">unwrap</span>(), <span class="string">&quot;foo&quot;</span>);</pre>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Canceled.html"
title='struct relay::Canceled'>Canceled</a></td>
<td class='docblock-short'>
<p>Represents that the <code>Sender</code> dropped before sending a message.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Receiver.html"
title='struct relay::Receiver'>Receiver</a></td>
<td class='docblock-short'>
<p>The receiver end of the channel.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Sender.html"
title='struct relay::Sender'>Sender</a></td>
<td class='docblock-short'>
<p>The Sender portion of a channel.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Waiting.html"
title='struct relay::Waiting'>Waiting</a></td>
<td class='docblock-short'>
<p>A <code>Future</code> waiting for interest to be registered on the <code>Receiver</code>.</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 relay::channel'>channel</a></td>
<td class='docblock-short'>
<p>Create a new channel to send a message.</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 = "relay";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>