<!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="This crate provides a stable, safe and scoped threadpool."><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../scoped_threadpool/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><h2 class="location">Crate scoped_threadpool</h2><div class="block version"><p>Version 0.1.9</p></div><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><div id="sidebar-vars" data-name="scoped_threadpool" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">scoped_threadpool</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></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/scoped_threadpool/lib.rs.html#1-518" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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::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::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="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="ident">vec</span>, <span class="macro">vec!</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></details><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><div id="rustdoc-vars" data-root-path="../" data-current-crate="scoped_threadpool" data-search-index-js="../search-index.js" data-search-js="../search.js"></div><script src="../main.js"></script></body></html>