152 lines
No EOL
7.7 KiB
HTML
152 lines
No EOL
7.7 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 `Condvar` struct in crate `bitflags`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Condvar">
|
||
|
||
<title>bitflags::__core::sync::Condvar - 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'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>sync</a></p><script>window.sidebarCurrent = {name: 'Condvar', 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'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>sync</a>::<wbr><a class='struct' href=''>Condvar</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-10106' class='srclink' href='https://doc.rust-lang.org/nightly/std/sync/condvar/struct.Condvar.html?gotosrc=10106' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct Condvar {
|
||
// some fields omitted
|
||
}</pre><span class="since">1.0.0</span><div class='docblock'><p>A Condition Variable</p>
|
||
|
||
<p>Condition variables represent the ability to block a thread such that it
|
||
consumes no CPU time while waiting for an event to occur. Condition
|
||
variables are typically associated with a boolean predicate (a condition)
|
||
and a mutex. The predicate is always verified inside of the mutex before
|
||
determining that thread must block.</p>
|
||
|
||
<p>Functions in this module will block the current <strong>thread</strong> of execution and
|
||
are bindings to system-provided condition variables where possible. Note
|
||
that this module places one additional restriction over the system condition
|
||
variables: each condvar can be used with precisely one mutex at runtime. Any
|
||
attempt to use multiple mutexes on the same condition variable will result
|
||
in a runtime panic. If this is not desired, then the unsafe primitives in
|
||
<code>sys</code> do not have this restriction but may result in undefined behavior.</p>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>sync</span>::{<span class='ident'>Arc</span>, <span class='ident'>Mutex</span>, <span class='ident'>Condvar</span>};
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>thread</span>;
|
||
|
||
<span class='kw'>let</span> <span class='ident'>pair</span> <span class='op'>=</span> <span class='ident'>Arc</span>::<span class='ident'>new</span>((<span class='ident'>Mutex</span>::<span class='ident'>new</span>(<span class='boolval'>false</span>), <span class='ident'>Condvar</span>::<span class='ident'>new</span>()));
|
||
<span class='kw'>let</span> <span class='ident'>pair2</span> <span class='op'>=</span> <span class='ident'>pair</span>.<span class='ident'>clone</span>();
|
||
|
||
<span class='comment'>// Inside of our lock, spawn a new thread, and then wait for it to start</span>
|
||
<span class='ident'>thread</span>::<span class='ident'>spawn</span>(<span class='kw'>move</span><span class='op'>||</span> {
|
||
<span class='kw'>let</span> <span class='kw-2'>&</span>(<span class='kw-2'>ref</span> <span class='ident'>lock</span>, <span class='kw-2'>ref</span> <span class='ident'>cvar</span>) <span class='op'>=</span> <span class='kw-2'>&</span><span class='op'>*</span><span class='ident'>pair2</span>;
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>started</span> <span class='op'>=</span> <span class='ident'>lock</span>.<span class='ident'>lock</span>().<span class='ident'>unwrap</span>();
|
||
<span class='op'>*</span><span class='ident'>started</span> <span class='op'>=</span> <span class='boolval'>true</span>;
|
||
<span class='ident'>cvar</span>.<span class='ident'>notify_one</span>();
|
||
});
|
||
|
||
<span class='comment'>// wait for the thread to start up</span>
|
||
<span class='kw'>let</span> <span class='kw-2'>&</span>(<span class='kw-2'>ref</span> <span class='ident'>lock</span>, <span class='kw-2'>ref</span> <span class='ident'>cvar</span>) <span class='op'>=</span> <span class='kw-2'>&</span><span class='op'>*</span><span class='ident'>pair</span>;
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>started</span> <span class='op'>=</span> <span class='ident'>lock</span>.<span class='ident'>lock</span>().<span class='ident'>unwrap</span>();
|
||
<span class='kw'>while</span> <span class='op'>!</span><span class='op'>*</span><span class='ident'>started</span> {
|
||
<span class='ident'>started</span> <span class='op'>=</span> <span class='ident'>cvar</span>.<span class='ident'>wait</span>(<span class='ident'>started</span>).<span class='ident'>unwrap</span>();
|
||
}</pre>
|
||
</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 = "bitflags";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../../jquery.js"></script>
|
||
<script src="../../../main.js"></script>
|
||
|
||
<script defer src="../../../search-index.js"></script>
|
||
</body>
|
||
</html> |