forked from diesel-rs/diesel
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtrait.RawMutex.html
More file actions
36 lines (33 loc) · 10.4 KB
/
Copy pathtrait.RawMutex.html
File metadata and controls
36 lines (33 loc) · 10.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<!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="Basic operations for a mutex."><meta name="keywords" content="rust, rustlang, rust-lang, RawMutex"><title>RawMutex in lock_api - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../lock_api/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../lock_api/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">RawMutex</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-associated-types">Required Associated Types</a></h3><ul><li><a href="#associatedtype.GuardMarker">GuardMarker</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#required-associated-consts">Required Associated Constants</a></h3><ul><li><a href="#associatedconstant.INIT">INIT</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.lock">lock</a></li><li><a href="#tymethod.try_lock">try_lock</a></li><li><a href="#tymethod.unlock">unlock</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><ul><li><a href="#method.is_locked">is_locked</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In lock_api</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../lock_api/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1">
<a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div>
</div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Trait <a href="index.html">lock_api</a>::<wbr><a class="trait" href="#">RawMutex</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/lock_api/mutex.rs.html#36-79">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub unsafe trait RawMutex {
type <a href="#associatedtype.GuardMarker" class="associatedtype">GuardMarker</a>;
const <a href="#associatedconstant.INIT" class="constant">INIT</a>: Self;
fn <a href="#tymethod.lock" class="fnname">lock</a>(&self);
<span class="item-spacer"></span> fn <a href="#tymethod.try_lock" class="fnname">try_lock</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a>;
<span class="item-spacer"></span> unsafe fn <a href="#tymethod.unlock" class="fnname">unlock</a>(&self);
fn <a href="#method.is_locked" class="fnname">is_locked</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a> { ... }
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Basic operations for a mutex.</p>
<p>Types implementing this trait can be used by <code>Mutex</code> to form a safe and
fully-functioning mutex type.</p>
<h2 id="safety"><a href="#safety">Safety</a></h2>
<p>Implementations of this trait must ensure that the mutex is actually
exclusive: a lock can’t be acquired while the mutex is already locked.</p>
</div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="associatedtype.GuardMarker" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/mutex.rs.html#45">source</a></div><h4 class="code-header">type <a href="#associatedtype.GuardMarker" class="associatedtype">GuardMarker</a></h4></div></summary><div class="docblock"><p>Marker type which determines whether a lock guard should be <code>Send</code>. Use
one of the <code>GuardSend</code> or <code>GuardNoSend</code> helper types here.</p>
</div></details></div><h2 id="required-associated-consts" class="small-section-header">Required Associated Constants<a href="#required-associated-consts" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="associatedconstant.INIT" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/mutex.rs.html#41">source</a></div><h4 class="code-header">const <a href="#associatedconstant.INIT" class="constant">INIT</a>: Self</h4></div></summary><div class="docblock"><p>Initial value for an unlocked mutex.</p>
</div></details></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.lock" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/mutex.rs.html#48">source</a></div><h4 class="code-header">fn <a href="#tymethod.lock" class="fnname">lock</a>(&self)</h4></div></summary><div class="docblock"><p>Acquires this mutex, blocking the current thread until it is able to do so.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.try_lock" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/mutex.rs.html#52">source</a></div><h4 class="code-header">fn <a href="#tymethod.try_lock" class="fnname">try_lock</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a></h4></div></summary><div class="docblock"><p>Attempts to acquire this mutex without blocking. Returns <code>true</code>
if the lock was successfully acquired and <code>false</code> otherwise.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.unlock" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/mutex.rs.html#65">source</a></div><h4 class="code-header">unsafe fn <a href="#tymethod.unlock" class="fnname">unlock</a>(&self)</h4></div></summary><div class="docblock"><p>Unlocks this mutex.</p>
<h5 id="safety-1"><a href="#safety-1">Safety</a></h5>
<p>This method may only be called if the mutex is held in the current context, i.e. it must
be paired with a successful call to <a href="#tymethod.lock"><code>lock</code></a>, <a href="#tymethod.try_lock"><code>try_lock</code></a>, <a href="trait.RawMutexTimed.html#tymethod.try_lock_for"><code>try_lock_for</code></a> or <a href="trait.RawMutexTimed.html#tymethod.try_lock_until"><code>try_lock_until</code></a>.</p>
</div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="method.is_locked" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/lock_api/mutex.rs.html#69-78">source</a></div><h4 class="code-header">fn <a href="#method.is_locked" class="fnname">is_locked</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a></h4></div></summary><div class="docblock"><p>Checks whether the mutex is currently locked.</p>
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../implementors/lock_api/mutex/trait.RawMutex.js" data-ignore-extern-crates="" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="lock_api" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0-nightly (495b21669 2022-07-03)" ></div>
</body></html>