138 lines
No EOL
5.9 KiB
HTML
138 lines
No EOL
5.9 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 `WaitGroup` struct in crate `scoped_pool`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, WaitGroup">
|
||
|
||
<title>scoped_pool::WaitGroup - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'><a href='index.html'>scoped_pool</a></p><script>window.sidebarCurrent = {name: 'WaitGroup', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<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 struct">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>scoped_pool</a>::<wbr><a class='struct' href=''>WaitGroup</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 id='src-92' class='srclink' href='../src/scoped_pool/lib.rs.html#282-287' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct WaitGroup {
|
||
// some fields omitted
|
||
}</pre><div class='docblock'><p>A synchronization primitive for awaiting a set of actions.</p>
|
||
|
||
<p>Adding new jobs is done with <code>submit</code>, jobs are completed with <code>complete</code>,
|
||
and any thread may wait for all jobs to be <code>complete</code>d with <code>join</code>.</p>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><code>impl <a class='struct' href='../scoped_pool/struct.WaitGroup.html' title='scoped_pool::WaitGroup'>WaitGroup</a></code></h3><div class='impl-items'><h4 id='method.new' class='method'><code>fn <a href='#method.new' class='fnname'>new</a>() -> Self</code></h4>
|
||
<div class='docblock'><p>Create a new empty WaitGroup.</p>
|
||
</div><h4 id='method.waiting' class='method'><code>fn <a href='#method.waiting' class='fnname'>waiting</a>(&self) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.usize.html'>usize</a></code></h4>
|
||
<div class='docblock'><p>How many submitted tasks are waiting for completion.</p>
|
||
</div><h4 id='method.submit' class='method'><code>fn <a href='#method.submit' class='fnname'>submit</a>(&self)</code></h4>
|
||
<div class='docblock'><p>Submit to this WaitGroup, causing <code>join</code> to wait
|
||
for an additional <code>complete</code>.</p>
|
||
</div><h4 id='method.complete' class='method'><code>fn <a href='#method.complete' class='fnname'>complete</a>(&self)</code></h4>
|
||
<div class='docblock'><p>Complete a previous <code>submit</code>.</p>
|
||
</div><h4 id='method.poison' class='method'><code>fn <a href='#method.poison' class='fnname'>poison</a>(&self)</code></h4>
|
||
<div class='docblock'><p>Poison the WaitGroup so all <code>join</code>ing threads panic.</p>
|
||
</div><h4 id='method.join' class='method'><code>fn <a href='#method.join' class='fnname'>join</a>(&self)</code></h4>
|
||
<div class='docblock'><p>Wait for <code>submit</code>s to this WaitGroup to be <code>complete</code>d.</p>
|
||
|
||
<p>Submits occuring completely before joins will always be waited on.</p>
|
||
|
||
<p>Submits occuring concurrently with a <code>join</code> may or may not
|
||
be waited for.</p>
|
||
|
||
<p>Before submitting, <code>join</code> will always return immediately.</p>
|
||
</div></div></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>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</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 = "scoped_pool";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../jquery.js"></script>
|
||
<script src="../main.js"></script>
|
||
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |