181 lines
No EOL
8.4 KiB
HTML
181 lines
No EOL
8.4 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 `futures_cpupool` crate.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, futures_cpupool">
|
||
|
||
<title>futures_cpupool - 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'>Crate futures_cpupool</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'futures_cpupool', 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=''>futures_cpupool</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_cpupool/lib.rs.html#1-450' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>A simple crate for executing work on a thread pool, and getting back a
|
||
future.</p>
|
||
<p>This crate provides a simple thread pool abstraction for running work
|
||
externally from the current thread that's running. An instance of <code>Future</code>
|
||
is handed back to represent that the work may be done later, and further
|
||
computations can be chained along with it as well.</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">futures</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">futures_cpupool</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">Future</span>;
|
||
<span class="kw">use</span> <span class="ident">futures_cpupool</span>::<span class="ident">CpuPool</span>;
|
||
|
||
|
||
<span class="comment">// Create a worker thread pool with four threads</span>
|
||
<span class="kw">let</span> <span class="ident">pool</span> <span class="op">=</span> <span class="ident">CpuPool</span>::<span class="ident">new</span>(<span class="number">4</span>);
|
||
|
||
<span class="comment">// Execute some work on the thread pool, optionally closing over data.</span>
|
||
<span class="kw">let</span> <span class="ident">a</span> <span class="op">=</span> <span class="ident">pool</span>.<span class="ident">spawn</span>(<span class="ident">long_running_future</span>(<span class="number">2</span>));
|
||
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">pool</span>.<span class="ident">spawn</span>(<span class="ident">long_running_future</span>(<span class="number">100</span>));
|
||
|
||
<span class="comment">// Express some further computation once the work is completed on the thread</span>
|
||
<span class="comment">// pool.</span>
|
||
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">a</span>.<span class="ident">join</span>(<span class="ident">b</span>).<span class="ident">map</span>(<span class="op">|</span>(<span class="ident">a</span>, <span class="ident">b</span>)<span class="op">|</span> <span class="ident">a</span> <span class="op">+</span> <span class="ident">b</span>).<span class="ident">wait</span>().<span class="ident">unwrap</span>();
|
||
|
||
<span class="comment">// Print out the result</span>
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">c</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.Builder.html"
|
||
title='struct futures_cpupool::Builder'>Builder</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Thread pool configuration object</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.CpuFuture.html"
|
||
title='struct futures_cpupool::CpuFuture'>CpuFuture</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The type of future returned from the <code>CpuPool::spawn</code> function, which
|
||
proxies the futures running on the thread pool.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.CpuPool.html"
|
||
title='struct futures_cpupool::CpuPool'>CpuPool</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A thread pool intended to run CPU intensive work.</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_cpupool";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |