blob: bc3ea52bedf75a4edca5e6799a2c905f8c6a8c40 [file] [log] [blame]
<!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 of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/try-lock-0.2.4/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../try_lock/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../try_lock/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><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"><a href="../../help.html">?</a></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><section id="main-content" class="content"><div class="example-wrap"><pre class="src-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>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
</pre><pre class="rust"><code><span class="attribute">#![doc(html_root_url = <span class="string">&quot;https://docs.rs/try-lock/0.2.3&quot;</span>)]
#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
#![deny(warnings)]
#![cfg_attr(not(test), no_std)]
</span><span class="doccomment">//! A light-weight lock guarded by an atomic boolean.
//!
//! Most efficient when contention is low, acquiring the lock is a single
//! atomic swap, and releasing it just 1 more atomic swap.
//!
//! # Example
//!
//! ```
//! use std::sync::Arc;
//! use try_lock::TryLock;
//!
//! // a thing we want to share
//! struct Widget {
//! name: String,
//! }
//!
//! // lock it up!
//! let widget1 = Arc::new(TryLock::new(Widget {
//! name: &quot;Spanner&quot;.into(),
//! }));
//!
//! let widget2 = widget1.clone();
//!
//!
//! // mutate the widget
//! let mut locked = widget1.try_lock().expect(&quot;example isn&#39;t locked yet&quot;);
//! locked.name.push_str(&quot; Bundle&quot;);
//!
//! // hands off, buddy
//! let not_locked = widget2.try_lock();
//! assert!(not_locked.is_none(), &quot;widget1 has the lock&quot;);
//!
//! // ok, you can have it
//! drop(locked);
//!
//! let locked2 = widget2.try_lock().expect(&quot;widget1 lock is released&quot;);
//!
//! assert_eq!(locked2.name, &quot;Spanner Bundle&quot;);
//! ```
</span><span class="attribute">#[cfg(test)]
</span><span class="kw">extern crate </span>core;
<span class="kw">use </span>core::cell::UnsafeCell;
<span class="kw">use </span>core::fmt;
<span class="kw">use </span>core::ops::{Deref, DerefMut};
<span class="kw">use </span>core::sync::atomic::{AtomicBool, Ordering};
<span class="kw">use </span>core::marker::PhantomData;
<span class="doccomment">/// A light-weight lock guarded by an atomic boolean.
///
/// Most efficient when contention is low, acquiring the lock is a single
/// atomic swap, and releasing it just 1 more atomic swap.
///
/// It is only possible to try to acquire the lock, it is not possible to
/// wait for the lock to become ready, like with a `Mutex`.
</span><span class="attribute">#[derive(Default)]
</span><span class="kw">pub struct </span>TryLock&lt;T&gt; {
is_locked: AtomicBool,
value: UnsafeCell&lt;T&gt;,
}
<span class="kw">impl</span>&lt;T&gt; TryLock&lt;T&gt; {
<span class="doccomment">/// Create a `TryLock` around the value.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>new(val: T) -&gt; TryLock&lt;T&gt; {
TryLock {
is_locked: AtomicBool::new(<span class="bool-val">false</span>),
value: UnsafeCell::new(val),
}
}
<span class="doccomment">/// Try to acquire the lock of this value.
///
/// If the lock is already acquired by someone else, this returns
/// `None`. You can try to acquire again whenever you want, perhaps
/// by spinning a few times, or by using some other means of
/// notification.
///
/// # Note
///
/// The default memory ordering is to use `Acquire` to lock, and `Release`
/// to unlock. If different ordering is required, use
/// [`try_lock_explicit`](TryLock::try_lock_explicit) or
/// [`try_lock_explicit_unchecked`](TryLock::try_lock_explicit_unchecked).
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>try_lock(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Locked&lt;T&gt;&gt; {
<span class="kw">unsafe </span>{
<span class="self">self</span>.try_lock_explicit_unchecked(Ordering::Acquire, Ordering::Release)
}
}
<span class="doccomment">/// Try to acquire the lock of this value using the lock and unlock orderings.
///
/// If the lock is already acquired by someone else, this returns
/// `None`. You can try to acquire again whenever you want, perhaps
/// by spinning a few times, or by using some other means of
/// notification.
</span><span class="attribute">#[inline]
#[deprecated(
since = <span class="string">&quot;0.2.3&quot;</span>,
note = <span class="string">&quot;This method is actually unsafe because it unsafely allows \
the use of weaker memory ordering. Please use try_lock_explicit instead&quot;
</span>)]
</span><span class="kw">pub fn </span>try_lock_order(<span class="kw-2">&amp;</span><span class="self">self</span>, lock_order: Ordering, unlock_order: Ordering) -&gt; <span class="prelude-ty">Option</span>&lt;Locked&lt;T&gt;&gt; {
<span class="kw">unsafe </span>{
<span class="self">self</span>.try_lock_explicit_unchecked(lock_order, unlock_order)
}
}
<span class="doccomment">/// Try to acquire the lock of this value using the specified lock and
/// unlock orderings.
///
/// If the lock is already acquired by someone else, this returns
/// `None`. You can try to acquire again whenever you want, perhaps
/// by spinning a few times, or by using some other means of
/// notification.
///
/// # Panic
///
/// This method panics if `lock_order` is not any of `Acquire`, `AcqRel`,
/// and `SeqCst`, or `unlock_order` is not any of `Release` and `SeqCst`.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>try_lock_explicit(<span class="kw-2">&amp;</span><span class="self">self</span>, lock_order: Ordering, unlock_order: Ordering) -&gt; <span class="prelude-ty">Option</span>&lt;Locked&lt;T&gt;&gt; {
<span class="kw">match </span>lock_order {
Ordering::Acquire |
Ordering::AcqRel |
Ordering::SeqCst =&gt; {}
<span class="kw">_ </span>=&gt; <span class="macro">panic!</span>(<span class="string">&quot;lock ordering must be `Acquire`, `AcqRel`, or `SeqCst`&quot;</span>),
}
<span class="kw">match </span>unlock_order {
Ordering::Release |
Ordering::SeqCst =&gt; {}
<span class="kw">_ </span>=&gt; <span class="macro">panic!</span>(<span class="string">&quot;unlock ordering must be `Release` or `SeqCst`&quot;</span>),
}
<span class="kw">unsafe </span>{
<span class="self">self</span>.try_lock_explicit_unchecked(lock_order, unlock_order)
}
}
<span class="doccomment">/// Try to acquire the lock of this value using the specified lock and
/// unlock orderings without checking that the specified orderings are
/// strong enough to be safe.
///
/// If the lock is already acquired by someone else, this returns
/// `None`. You can try to acquire again whenever you want, perhaps
/// by spinning a few times, or by using some other means of
/// notification.
///
/// # Safety
///
/// Unlike [`try_lock_explicit`], this method is unsafe because it does not
/// check that the given memory orderings are strong enough to prevent data
/// race.
///
/// [`try_lock_explicit`]: Self::try_lock_explicit
</span><span class="attribute">#[inline]
</span><span class="kw">pub unsafe fn </span>try_lock_explicit_unchecked(<span class="kw-2">&amp;</span><span class="self">self</span>, lock_order: Ordering, unlock_order: Ordering) -&gt; <span class="prelude-ty">Option</span>&lt;Locked&lt;T&gt;&gt; {
<span class="kw">if </span>!<span class="self">self</span>.is_locked.swap(<span class="bool-val">true</span>, lock_order) {
<span class="prelude-val">Some</span>(Locked {
lock: <span class="self">self</span>,
order: unlock_order,
_p: PhantomData,
})
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Take the value back out of the lock when this is the sole owner.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>into_inner(<span class="self">self</span>) -&gt; T {
<span class="macro">debug_assert!</span>(!<span class="self">self</span>.is_locked.load(Ordering::Relaxed), <span class="string">&quot;TryLock was mem::forgotten&quot;</span>);
<span class="comment">// Since the compiler can statically determine this is the only owner,
// it&#39;s safe to take the value out. In fact, in newer versions of Rust,
// `UnsafeCell::into_inner` has been marked safe.
//
// To support older version (1.21), the unsafe block is still here.
</span><span class="attribute">#[allow(unused_unsafe)]
</span><span class="kw">unsafe </span>{
<span class="self">self</span>.value.into_inner()
}
}
}
<span class="kw">unsafe impl</span>&lt;T: Send&gt; Send <span class="kw">for </span>TryLock&lt;T&gt; {}
<span class="kw">unsafe impl</span>&lt;T: Send&gt; Sync <span class="kw">for </span>TryLock&lt;T&gt; {}
<span class="kw">impl</span>&lt;T: fmt::Debug&gt; fmt::Debug <span class="kw">for </span>TryLock&lt;T&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
<span class="comment">// Used if the TryLock cannot acquire the lock.
</span><span class="kw">struct </span>LockedPlaceholder;
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>LockedPlaceholder {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
f.write_str(<span class="string">&quot;&lt;locked&gt;&quot;</span>)
}
}
<span class="kw">let </span><span class="kw-2">mut </span>builder = f.debug_struct(<span class="string">&quot;TryLock&quot;</span>);
<span class="kw">if let </span><span class="prelude-val">Some</span>(locked) = <span class="self">self</span>.try_lock() {
builder.field(<span class="string">&quot;value&quot;</span>, <span class="kw-2">&amp;*</span>locked);
} <span class="kw">else </span>{
builder.field(<span class="string">&quot;value&quot;</span>, <span class="kw-2">&amp;</span>LockedPlaceholder);
}
builder.finish()
}
}
<span class="doccomment">/// A locked value acquired from a `TryLock`.
///
/// The type represents an exclusive view at the underlying value. The lock is
/// released when this type is dropped.
///
/// This type derefs to the underlying value.
</span><span class="attribute">#[must_use = <span class="string">&quot;TryLock will immediately unlock if not used&quot;</span>]
</span><span class="kw">pub struct </span>Locked&lt;<span class="lifetime">&#39;a</span>, T: <span class="lifetime">&#39;a</span>&gt; {
lock: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>TryLock&lt;T&gt;,
order: Ordering,
<span class="doccomment">/// Suppresses Send and Sync autotraits for `struct Locked`.
</span>_p: PhantomData&lt;<span class="kw-2">*mut </span>T&gt;,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T&gt; Deref <span class="kw">for </span>Locked&lt;<span class="lifetime">&#39;a</span>, T&gt; {
<span class="kw">type </span>Target = T;
<span class="attribute">#[inline]
</span><span class="kw">fn </span>deref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>T {
<span class="kw">unsafe </span>{ <span class="kw-2">&amp;*</span><span class="self">self</span>.lock.value.get() }
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T&gt; DerefMut <span class="kw">for </span>Locked&lt;<span class="lifetime">&#39;a</span>, T&gt; {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>deref_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>T {
<span class="kw">unsafe </span>{ <span class="kw-2">&amp;mut *</span><span class="self">self</span>.lock.value.get() }
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T&gt; Drop <span class="kw">for </span>Locked&lt;<span class="lifetime">&#39;a</span>, T&gt; {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="self">self</span>.lock.is_locked.store(<span class="bool-val">false</span>, <span class="self">self</span>.order);
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T: fmt::Debug&gt; fmt::Debug <span class="kw">for </span>Locked&lt;<span class="lifetime">&#39;a</span>, T&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
fmt::Debug::fmt(<span class="kw-2">&amp;**</span><span class="self">self</span>, f)
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::TryLock;
<span class="attribute">#[test]
</span><span class="kw">fn </span>fmt_debug() {
<span class="kw">let </span>lock = TryLock::new(<span class="number">5</span>);
<span class="macro">assert_eq!</span>(<span class="macro">format!</span>(<span class="string">&quot;{:?}&quot;</span>, lock), <span class="string">&quot;TryLock { value: 5 }&quot;</span>);
<span class="kw">let </span>locked = lock.try_lock().unwrap();
<span class="macro">assert_eq!</span>(<span class="macro">format!</span>(<span class="string">&quot;{:?}&quot;</span>, locked), <span class="string">&quot;5&quot;</span>);
<span class="macro">assert_eq!</span>(<span class="macro">format!</span>(<span class="string">&quot;{:?}&quot;</span>, lock), <span class="string">&quot;TryLock { value: &lt;locked&gt; }&quot;</span>);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="try_lock" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>