<!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="Source to the Rust file `src/libstd/sys_common/condvar.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>condvar.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../main.css">
<link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<a href='../../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
</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"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
</pre><pre class="rust ">
<span class="comment">// Copyright 2014 The Rust Project Developers. See the COPYRIGHT</span>
<span class="comment">// file at the top-level directory of this distribution and at</span>
<span class="comment">// http://rust-lang.org/COPYRIGHT.</span>
<span class="comment">//</span>
<span class="comment">// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span>
<span class="comment">// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span>
<span class="comment">// option. This file may not be copied, modified, or distributed</span>
<span class="comment">// except according to those terms.</span>
<span class="kw">use</span> <span class="ident">time</span>::<span class="ident">Duration</span>;
<span class="kw">use</span> <span class="ident">sys_common</span>::<span class="ident">mutex</span>::{<span class="self">self</span>, <span class="ident">Mutex</span>};
<span class="kw">use</span> <span class="ident">sys</span>::<span class="ident">condvar</span> <span class="kw">as</span> <span class="ident">imp</span>;
<span class="doccomment">/// An OS-based condition variable.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This structure is the lowest layer possible on top of the OS-provided</span>
<span class="doccomment">/// condition variables. It is consequently entirely unsafe to use. It is</span>
<span class="doccomment">/// recommended to use the safer types at the top level of this crate instead of</span>
<span class="doccomment">/// this type.</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Condvar</span>(<span class="ident">imp</span>::<span class="ident">Condvar</span>);
<span class="kw">impl</span> <span class="ident">Condvar</span> {
<span class="doccomment">/// Creates a new condition variable for use.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Behavior is undefined if the condition variable is moved after it is</span>
<span class="doccomment">/// first used with any of the functions below.</span>
<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-></span> <span class="ident">Condvar</span> { <span class="ident">Condvar</span>(<span class="ident">imp</span>::<span class="ident">Condvar</span>::<span class="ident">new</span>()) }
<span class="doccomment">/// Prepares the condition variable for use.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This should be called once the condition variable is at a stable memory</span>
<span class="doccomment">/// address.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">init</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) { <span class="self">self</span>.<span class="number">0</span>.<span class="ident">init</span>() }
<span class="doccomment">/// Signals one waiter on this condition variable to wake up.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">notify_one</span>(<span class="kw-2">&</span><span class="self">self</span>) { <span class="self">self</span>.<span class="number">0</span>.<span class="ident">notify_one</span>() }
<span class="doccomment">/// Awakens all current waiters on this condition variable.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">notify_all</span>(<span class="kw-2">&</span><span class="self">self</span>) { <span class="self">self</span>.<span class="number">0</span>.<span class="ident">notify_all</span>() }
<span class="doccomment">/// Waits for a signal on the specified mutex.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Behavior is undefined if the mutex is not locked by the current thread.</span>
<span class="doccomment">/// Behavior is also undefined if more than one mutex is used concurrently</span>
<span class="doccomment">/// on this condition variable.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">wait</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">mutex</span>: <span class="kw-2">&</span><span class="ident">Mutex</span>) { <span class="self">self</span>.<span class="number">0</span>.<span class="ident">wait</span>(<span class="ident">mutex</span>::<span class="ident">raw</span>(<span class="ident">mutex</span>)) }
<span class="doccomment">/// Waits for a signal on the specified mutex with a timeout duration</span>
<span class="doccomment">/// specified by `dur` (a relative time into the future).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Behavior is undefined if the mutex is not locked by the current thread.</span>
<span class="doccomment">/// Behavior is also undefined if more than one mutex is used concurrently</span>
<span class="doccomment">/// on this condition variable.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">wait_timeout</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">mutex</span>: <span class="kw-2">&</span><span class="ident">Mutex</span>, <span class="ident">dur</span>: <span class="ident">Duration</span>) <span class="op">-></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">wait_timeout</span>(<span class="ident">mutex</span>::<span class="ident">raw</span>(<span class="ident">mutex</span>), <span class="ident">dur</span>)
}
<span class="doccomment">/// Deallocates all resources associated with this condition variable.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Behavior is undefined if there are current or will be future users of</span>
<span class="doccomment">/// this condition variable.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">destroy</span>(<span class="kw-2">&</span><span class="self">self</span>) { <span class="self">self</span>.<span class="number">0</span>.<span class="ident">destroy</span>() }
}
</pre>
</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>
<dt>+</dt>
<dd>Collapse/expand 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 = "std";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
878cdd00a13d17a73c6619a777ef5d74
>
files
>
2819
