|
|
<!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 `scoped_threadpool` crate."><meta name="keywords" content="rust, rustlang, rust-lang, scoped_threadpool"><title>scoped_threadpool - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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><a href='../scoped_threadpool/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate scoped_threadpool</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all scoped_threadpool's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'scoped_threadpool', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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/scoped_threadpool/lib.rs.html#1-518' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>scoped_threadpool</a></span></h1><div class='docblock'><p>This crate provides a stable, safe and scoped threadpool.</p>
|
|
|
<p>It can be used to execute a number of short-lived jobs in parallel
|
|
|
without the need to respawn the underlying threads.</p>
|
|
|
<p>Jobs are runnable by borrowing the pool for a given scope, during which
|
|
|
an arbitrary number of them can be executed. These jobs can access data of
|
|
|
any lifetime outside of the pools scope, which allows working on
|
|
|
non-<code>'static</code> references in parallel.</p>
|
|
|
<p>For safety reasons, a panic inside a worker thread will not be isolated,
|
|
|
but rather propagate to the outside of the pool.</p>
|
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples:</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">scoped_threadpool</span>;
|
|
|
<span class="kw">use</span> <span class="ident">scoped_threadpool</span>::<span class="ident">Pool</span>;
|
|
|
|
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|
|
<span class="comment">// Create a threadpool holding 4 threads</span>
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">pool</span> <span class="op">=</span> <span class="ident">Pool</span>::<span class="ident">new</span>(<span class="number">4</span>);
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">vec</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>];
|
|
|
|
|
|
<span class="comment">// Use the threads as scoped threads that can</span>
|
|
|
<span class="comment">// reference anything outside this closure</span>
|
|
|
<span class="ident">pool</span>.<span class="ident">scoped</span>(<span class="op">|</span><span class="ident">scope</span><span class="op">|</span> {
|
|
|
<span class="comment">// Create references to each element in the vector ...</span>
|
|
|
<span class="kw">for</span> <span class="ident">e</span> <span class="kw">in</span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">vec</span> {
|
|
|
<span class="comment">// ... and add 1 to it in a seperate thread</span>
|
|
|
<span class="ident">scope</span>.<span class="ident">execute</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
|
|
|
<span class="kw-2">*</span><span class="ident">e</span> <span class="op">+</span><span class="op">=</span> <span class="number">1</span>;
|
|
|
});
|
|
|
}
|
|
|
});
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">vec</span>, <span class="macro">vec</span><span class="macro">!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>]);
|
|
|
}</pre></div>
|
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.Pool.html" title='scoped_threadpool::Pool struct'>Pool</a></td><td class='docblock-short'><p>A threadpool that acts as a handle to a number
|
|
|
of threads spawned at construction.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Scope.html" title='scoped_threadpool::Scope struct'>Scope</a></td><td class='docblock-short'><p>Handle to the scope during which the threadpool is borrowed.</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><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 = "scoped_threadpool";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
