+/livesplit-wrapper

git clone https://git.julia.blue/+/livesplit-wrapper

P1n3appl3deploy: 9b9f353f3b0e319547cabc5dcadc542d5ab54386b0170e4

gh-pages
37.2 KiB872 linesraw
1<!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 `/home/runner/.cargo/registry/src/github.com-1ecc6299db9ec823/once_cell-1.15.0/src/imp_std.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>imp_std.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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../once_cell/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="../../once_cell/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../once_cell/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="example-wrap"><pre class="line-numbers"><span id="1">1</span>
2<span id="2">2</span>
3<span id="3">3</span>
4<span id="4">4</span>
5<span id="5">5</span>
6<span id="6">6</span>
7<span id="7">7</span>
8<span id="8">8</span>
9<span id="9">9</span>
10<span id="10">10</span>
11<span id="11">11</span>
12<span id="12">12</span>
13<span id="13">13</span>
14<span id="14">14</span>
15<span id="15">15</span>
16<span id="16">16</span>
17<span id="17">17</span>
18<span id="18">18</span>
19<span id="19">19</span>
20<span id="20">20</span>
21<span id="21">21</span>
22<span id="22">22</span>
23<span id="23">23</span>
24<span id="24">24</span>
25<span id="25">25</span>
26<span id="26">26</span>
27<span id="27">27</span>
28<span id="28">28</span>
29<span id="29">29</span>
30<span id="30">30</span>
31<span id="31">31</span>
32<span id="32">32</span>
33<span id="33">33</span>
34<span id="34">34</span>
35<span id="35">35</span>
36<span id="36">36</span>
37<span id="37">37</span>
38<span id="38">38</span>
39<span id="39">39</span>
40<span id="40">40</span>
41<span id="41">41</span>
42<span id="42">42</span>
43<span id="43">43</span>
44<span id="44">44</span>
45<span id="45">45</span>
46<span id="46">46</span>
47<span id="47">47</span>
48<span id="48">48</span>
49<span id="49">49</span>
50<span id="50">50</span>
51<span id="51">51</span>
52<span id="52">52</span>
53<span id="53">53</span>
54<span id="54">54</span>
55<span id="55">55</span>
56<span id="56">56</span>
57<span id="57">57</span>
58<span id="58">58</span>
59<span id="59">59</span>
60<span id="60">60</span>
61<span id="61">61</span>
62<span id="62">62</span>
63<span id="63">63</span>
64<span id="64">64</span>
65<span id="65">65</span>
66<span id="66">66</span>
67<span id="67">67</span>
68<span id="68">68</span>
69<span id="69">69</span>
70<span id="70">70</span>
71<span id="71">71</span>
72<span id="72">72</span>
73<span id="73">73</span>
74<span id="74">74</span>
75<span id="75">75</span>
76<span id="76">76</span>
77<span id="77">77</span>
78<span id="78">78</span>
79<span id="79">79</span>
80<span id="80">80</span>
81<span id="81">81</span>
82<span id="82">82</span>
83<span id="83">83</span>
84<span id="84">84</span>
85<span id="85">85</span>
86<span id="86">86</span>
87<span id="87">87</span>
88<span id="88">88</span>
89<span id="89">89</span>
90<span id="90">90</span>
91<span id="91">91</span>
92<span id="92">92</span>
93<span id="93">93</span>
94<span id="94">94</span>
95<span id="95">95</span>
96<span id="96">96</span>
97<span id="97">97</span>
98<span id="98">98</span>
99<span id="99">99</span>
100<span id="100">100</span>
101<span id="101">101</span>
102<span id="102">102</span>
103<span id="103">103</span>
104<span id="104">104</span>
105<span id="105">105</span>
106<span id="106">106</span>
107<span id="107">107</span>
108<span id="108">108</span>
109<span id="109">109</span>
110<span id="110">110</span>
111<span id="111">111</span>
112<span id="112">112</span>
113<span id="113">113</span>
114<span id="114">114</span>
115<span id="115">115</span>
116<span id="116">116</span>
117<span id="117">117</span>
118<span id="118">118</span>
119<span id="119">119</span>
120<span id="120">120</span>
121<span id="121">121</span>
122<span id="122">122</span>
123<span id="123">123</span>
124<span id="124">124</span>
125<span id="125">125</span>
126<span id="126">126</span>
127<span id="127">127</span>
128<span id="128">128</span>
129<span id="129">129</span>
130<span id="130">130</span>
131<span id="131">131</span>
132<span id="132">132</span>
133<span id="133">133</span>
134<span id="134">134</span>
135<span id="135">135</span>
136<span id="136">136</span>
137<span id="137">137</span>
138<span id="138">138</span>
139<span id="139">139</span>
140<span id="140">140</span>
141<span id="141">141</span>
142<span id="142">142</span>
143<span id="143">143</span>
144<span id="144">144</span>
145<span id="145">145</span>
146<span id="146">146</span>
147<span id="147">147</span>
148<span id="148">148</span>
149<span id="149">149</span>
150<span id="150">150</span>
151<span id="151">151</span>
152<span id="152">152</span>
153<span id="153">153</span>
154<span id="154">154</span>
155<span id="155">155</span>
156<span id="156">156</span>
157<span id="157">157</span>
158<span id="158">158</span>
159<span id="159">159</span>
160<span id="160">160</span>
161<span id="161">161</span>
162<span id="162">162</span>
163<span id="163">163</span>
164<span id="164">164</span>
165<span id="165">165</span>
166<span id="166">166</span>
167<span id="167">167</span>
168<span id="168">168</span>
169<span id="169">169</span>
170<span id="170">170</span>
171<span id="171">171</span>
172<span id="172">172</span>
173<span id="173">173</span>
174<span id="174">174</span>
175<span id="175">175</span>
176<span id="176">176</span>
177<span id="177">177</span>
178<span id="178">178</span>
179<span id="179">179</span>
180<span id="180">180</span>
181<span id="181">181</span>
182<span id="182">182</span>
183<span id="183">183</span>
184<span id="184">184</span>
185<span id="185">185</span>
186<span id="186">186</span>
187<span id="187">187</span>
188<span id="188">188</span>
189<span id="189">189</span>
190<span id="190">190</span>
191<span id="191">191</span>
192<span id="192">192</span>
193<span id="193">193</span>
194<span id="194">194</span>
195<span id="195">195</span>
196<span id="196">196</span>
197<span id="197">197</span>
198<span id="198">198</span>
199<span id="199">199</span>
200<span id="200">200</span>
201<span id="201">201</span>
202<span id="202">202</span>
203<span id="203">203</span>
204<span id="204">204</span>
205<span id="205">205</span>
206<span id="206">206</span>
207<span id="207">207</span>
208<span id="208">208</span>
209<span id="209">209</span>
210<span id="210">210</span>
211<span id="211">211</span>
212<span id="212">212</span>
213<span id="213">213</span>
214<span id="214">214</span>
215<span id="215">215</span>
216<span id="216">216</span>
217<span id="217">217</span>
218<span id="218">218</span>
219<span id="219">219</span>
220<span id="220">220</span>
221<span id="221">221</span>
222<span id="222">222</span>
223<span id="223">223</span>
224<span id="224">224</span>
225<span id="225">225</span>
226<span id="226">226</span>
227<span id="227">227</span>
228<span id="228">228</span>
229<span id="229">229</span>
230<span id="230">230</span>
231<span id="231">231</span>
232<span id="232">232</span>
233<span id="233">233</span>
234<span id="234">234</span>
235<span id="235">235</span>
236<span id="236">236</span>
237<span id="237">237</span>
238<span id="238">238</span>
239<span id="239">239</span>
240<span id="240">240</span>
241<span id="241">241</span>
242<span id="242">242</span>
243<span id="243">243</span>
244<span id="244">244</span>
245<span id="245">245</span>
246<span id="246">246</span>
247<span id="247">247</span>
248<span id="248">248</span>
249<span id="249">249</span>
250<span id="250">250</span>
251<span id="251">251</span>
252<span id="252">252</span>
253<span id="253">253</span>
254<span id="254">254</span>
255<span id="255">255</span>
256<span id="256">256</span>
257<span id="257">257</span>
258<span id="258">258</span>
259<span id="259">259</span>
260<span id="260">260</span>
261<span id="261">261</span>
262<span id="262">262</span>
263<span id="263">263</span>
264<span id="264">264</span>
265<span id="265">265</span>
266<span id="266">266</span>
267<span id="267">267</span>
268<span id="268">268</span>
269<span id="269">269</span>
270<span id="270">270</span>
271<span id="271">271</span>
272<span id="272">272</span>
273<span id="273">273</span>
274<span id="274">274</span>
275<span id="275">275</span>
276<span id="276">276</span>
277<span id="277">277</span>
278<span id="278">278</span>
279<span id="279">279</span>
280<span id="280">280</span>
281<span id="281">281</span>
282<span id="282">282</span>
283<span id="283">283</span>
284<span id="284">284</span>
285<span id="285">285</span>
286<span id="286">286</span>
287<span id="287">287</span>
288<span id="288">288</span>
289<span id="289">289</span>
290<span id="290">290</span>
291<span id="291">291</span>
292<span id="292">292</span>
293<span id="293">293</span>
294<span id="294">294</span>
295<span id="295">295</span>
296<span id="296">296</span>
297<span id="297">297</span>
298<span id="298">298</span>
299<span id="299">299</span>
300<span id="300">300</span>
301<span id="301">301</span>
302<span id="302">302</span>
303<span id="303">303</span>
304<span id="304">304</span>
305<span id="305">305</span>
306<span id="306">306</span>
307<span id="307">307</span>
308<span id="308">308</span>
309<span id="309">309</span>
310<span id="310">310</span>
311<span id="311">311</span>
312<span id="312">312</span>
313<span id="313">313</span>
314<span id="314">314</span>
315<span id="315">315</span>
316<span id="316">316</span>
317<span id="317">317</span>
318<span id="318">318</span>
319<span id="319">319</span>
320<span id="320">320</span>
321<span id="321">321</span>
322<span id="322">322</span>
323<span id="323">323</span>
324<span id="324">324</span>
325<span id="325">325</span>
326<span id="326">326</span>
327<span id="327">327</span>
328<span id="328">328</span>
329<span id="329">329</span>
330<span id="330">330</span>
331<span id="331">331</span>
332<span id="332">332</span>
333<span id="333">333</span>
334<span id="334">334</span>
335<span id="335">335</span>
336<span id="336">336</span>
337<span id="337">337</span>
338<span id="338">338</span>
339<span id="339">339</span>
340<span id="340">340</span>
341<span id="341">341</span>
342<span id="342">342</span>
343<span id="343">343</span>
344<span id="344">344</span>
345<span id="345">345</span>
346<span id="346">346</span>
347<span id="347">347</span>
348<span id="348">348</span>
349<span id="349">349</span>
350<span id="350">350</span>
351<span id="351">351</span>
352<span id="352">352</span>
353<span id="353">353</span>
354<span id="354">354</span>
355<span id="355">355</span>
356<span id="356">356</span>
357<span id="357">357</span>
358<span id="358">358</span>
359<span id="359">359</span>
360<span id="360">360</span>
361<span id="361">361</span>
362<span id="362">362</span>
363<span id="363">363</span>
364<span id="364">364</span>
365<span id="365">365</span>
366<span id="366">366</span>
367<span id="367">367</span>
368<span id="368">368</span>
369<span id="369">369</span>
370<span id="370">370</span>
371<span id="371">371</span>
372<span id="372">372</span>
373<span id="373">373</span>
374<span id="374">374</span>
375<span id="375">375</span>
376<span id="376">376</span>
377<span id="377">377</span>
378<span id="378">378</span>
379<span id="379">379</span>
380<span id="380">380</span>
381<span id="381">381</span>
382<span id="382">382</span>
383<span id="383">383</span>
384<span id="384">384</span>
385<span id="385">385</span>
386<span id="386">386</span>
387<span id="387">387</span>
388<span id="388">388</span>
389<span id="389">389</span>
390<span id="390">390</span>
391<span id="391">391</span>
392<span id="392">392</span>
393<span id="393">393</span>
394<span id="394">394</span>
395<span id="395">395</span>
396<span id="396">396</span>
397<span id="397">397</span>
398<span id="398">398</span>
399<span id="399">399</span>
400<span id="400">400</span>
401<span id="401">401</span>
402<span id="402">402</span>
403<span id="403">403</span>
404<span id="404">404</span>
405<span id="405">405</span>
406<span id="406">406</span>
407<span id="407">407</span>
408<span id="408">408</span>
409<span id="409">409</span>
410<span id="410">410</span>
411<span id="411">411</span>
412<span id="412">412</span>
413<span id="413">413</span>
414<span id="414">414</span>
415<span id="415">415</span>
416<span id="416">416</span>
417<span id="417">417</span>
418<span id="418">418</span>
419<span id="419">419</span>
420<span id="420">420</span>
421<span id="421">421</span>
422<span id="422">422</span>
423<span id="423">423</span>
424<span id="424">424</span>
425<span id="425">425</span>
426<span id="426">426</span>
427<span id="427">427</span>
428<span id="428">428</span>
429<span id="429">429</span>
430<span id="430">430</span>
431<span id="431">431</span>
432<span id="432">432</span>
433<span id="433">433</span>
434<span id="434">434</span>
435<span id="435">435</span>
436</pre><pre class="rust"><code><span class="comment">// There&#39;s a lot of scary concurrent code in this module, but it is copied from
437// `std::sync::Once` with two changes:
438//   * no poisoning
439//   * init function can fail
440
441</span><span class="kw">use </span>std::{
442    cell::{Cell, UnsafeCell},
443    hint::unreachable_unchecked,
444    marker::PhantomData,
445    panic::{RefUnwindSafe, UnwindSafe},
446    sync::atomic::{AtomicBool, AtomicPtr, Ordering},
447    thread::{<span class="self">self</span>, Thread},
448};
449
450<span class="kw">use </span><span class="kw">crate</span>::take_unchecked;
451
452<span class="attribute">#[derive(Debug)]
453</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>OnceCell&lt;T&gt; {
454    <span class="comment">// This `queue` field is the core of the implementation. It encodes two
455    // pieces of information:
456    //
457    // * The current state of the cell (`INCOMPLETE`, `RUNNING`, `COMPLETE`)
458    // * Linked list of threads waiting for the current cell.
459    //
460    // State is encoded in two low bits. Only `INCOMPLETE` and `RUNNING` states
461    // allow waiters.
462    </span>queue: AtomicPtr&lt;Waiter&gt;,
463    _marker: PhantomData&lt;<span class="kw-2">*mut </span>Waiter&gt;,
464    value: UnsafeCell&lt;<span class="prelude-ty">Option</span>&lt;T&gt;&gt;,
465}
466
467<span class="comment">// Why do we need `T: Send`?
468// Thread A creates a `OnceCell` and shares it with
469// scoped thread B, which fills the cell, which is
470// then destroyed by A. That is, destructor observes
471// a sent value.
472</span><span class="kw">unsafe impl</span>&lt;T: Sync + Send&gt; Sync <span class="kw">for </span>OnceCell&lt;T&gt; {}
473<span class="kw">unsafe impl</span>&lt;T: Send&gt; Send <span class="kw">for </span>OnceCell&lt;T&gt; {}
474
475<span class="kw">impl</span>&lt;T: RefUnwindSafe + UnwindSafe&gt; RefUnwindSafe <span class="kw">for </span>OnceCell&lt;T&gt; {}
476<span class="kw">impl</span>&lt;T: UnwindSafe&gt; UnwindSafe <span class="kw">for </span>OnceCell&lt;T&gt; {}
477
478<span class="kw">impl</span>&lt;T&gt; OnceCell&lt;T&gt; {
479    <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const fn </span>new() -&gt; OnceCell&lt;T&gt; {
480        OnceCell {
481            queue: AtomicPtr::new(INCOMPLETE_PTR),
482            _marker: PhantomData,
483            value: UnsafeCell::new(<span class="prelude-val">None</span>),
484        }
485    }
486
487    <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const fn </span>with_value(value: T) -&gt; OnceCell&lt;T&gt; {
488        OnceCell {
489            queue: AtomicPtr::new(COMPLETE_PTR),
490            _marker: PhantomData,
491            value: UnsafeCell::new(<span class="prelude-val">Some</span>(value)),
492        }
493    }
494
495    <span class="doccomment">/// Safety: synchronizes with store to value via Release/(Acquire|SeqCst).
496    </span><span class="attribute">#[inline]
497    </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>is_initialized(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
498        <span class="comment">// An `Acquire` load is enough because that makes all the initialization
499        // operations visible to us, and, this being a fast path, weaker
500        // ordering helps with performance. This `Acquire` synchronizes with
501        // `SeqCst` operations on the slow path.
502        </span><span class="self">self</span>.queue.load(Ordering::Acquire) == COMPLETE_PTR
503    }
504
505    <span class="doccomment">/// Safety: synchronizes with store to value via SeqCst read from state,
506    /// writes value only once because we never get to INCOMPLETE state after a
507    /// successful write.
508    </span><span class="attribute">#[cold]
509    </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>initialize&lt;F, E&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, f: F) -&gt; <span class="prelude-ty">Result</span>&lt;(), E&gt;
510    <span class="kw">where
511        </span>F: FnOnce() -&gt; <span class="prelude-ty">Result</span>&lt;T, E&gt;,
512    {
513        <span class="kw">let </span><span class="kw-2">mut </span>f = <span class="prelude-val">Some</span>(f);
514        <span class="kw">let </span><span class="kw-2">mut </span>res: <span class="prelude-ty">Result</span>&lt;(), E&gt; = <span class="prelude-val">Ok</span>(());
515        <span class="kw">let </span>slot: <span class="kw-2">*mut </span><span class="prelude-ty">Option</span>&lt;T&gt; = <span class="self">self</span>.value.get();
516        initialize_or_wait(
517            <span class="kw-2">&amp;</span><span class="self">self</span>.queue,
518            <span class="prelude-val">Some</span>(<span class="kw-2">&amp;mut </span>|| {
519                <span class="kw">let </span>f = <span class="kw">unsafe </span>{ take_unchecked(<span class="kw-2">&amp;mut </span>f) };
520                <span class="kw">match </span>f() {
521                    <span class="prelude-val">Ok</span>(value) =&gt; {
522                        <span class="kw">unsafe </span>{ <span class="kw-2">*</span>slot = <span class="prelude-val">Some</span>(value) };
523                        <span class="bool-val">true
524                    </span>}
525                    <span class="prelude-val">Err</span>(err) =&gt; {
526                        res = <span class="prelude-val">Err</span>(err);
527                        <span class="bool-val">false
528                    </span>}
529                }
530            }),
531        );
532        res
533    }
534
535    <span class="attribute">#[cold]
536    </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>wait(<span class="kw-2">&amp;</span><span class="self">self</span>) {
537        initialize_or_wait(<span class="kw-2">&amp;</span><span class="self">self</span>.queue, <span class="prelude-val">None</span>);
538    }
539
540    <span class="doccomment">/// Get the reference to the underlying value, without checking if the cell
541    /// is initialized.
542    ///
543    /// # Safety
544    ///
545    /// Caller must ensure that the cell is in initialized state, and that
546    /// the contents are acquired by (synchronized to) this thread.
547    </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">unsafe fn </span>get_unchecked(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>T {
548        <span class="macro">debug_assert!</span>(<span class="self">self</span>.is_initialized());
549        <span class="kw">let </span>slot: <span class="kw-2">&amp;</span><span class="prelude-ty">Option</span>&lt;T&gt; = <span class="kw-2">&amp;*</span><span class="self">self</span>.value.get();
550        <span class="kw">match </span>slot {
551            <span class="prelude-val">Some</span>(value) =&gt; value,
552            <span class="comment">// This unsafe does improve performance, see `examples/bench`.
553            </span><span class="prelude-val">None </span>=&gt; {
554                <span class="macro">debug_assert!</span>(<span class="bool-val">false</span>);
555                unreachable_unchecked()
556            }
557        }
558    }
559
560    <span class="doccomment">/// Gets the mutable reference to the underlying value.
561    /// Returns `None` if the cell is empty.
562    </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>get_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;mut </span>T&gt; {
563        <span class="comment">// Safe b/c we have a unique access.
564        </span><span class="kw">unsafe </span>{ <span class="kw-2">&amp;mut *</span><span class="self">self</span>.value.get() }.as_mut()
565    }
566
567    <span class="doccomment">/// Consumes this `OnceCell`, returning the wrapped value.
568    /// Returns `None` if the cell was empty.
569    </span><span class="attribute">#[inline]
570    </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>into_inner(<span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;T&gt; {
571        <span class="comment">// Because `into_inner` takes `self` by value, the compiler statically
572        // verifies that it is not currently borrowed.
573        // So, it is safe to move out `Option&lt;T&gt;`.
574        </span><span class="self">self</span>.value.into_inner()
575    }
576}
577
578<span class="comment">// Three states that a OnceCell can be in, encoded into the lower bits of `queue` in
579// the OnceCell structure.
580</span><span class="kw">const </span>INCOMPLETE: usize = <span class="number">0x0</span>;
581<span class="kw">const </span>RUNNING: usize = <span class="number">0x1</span>;
582<span class="kw">const </span>COMPLETE: usize = <span class="number">0x2</span>;
583<span class="kw">const </span>INCOMPLETE_PTR: <span class="kw-2">*mut </span>Waiter = INCOMPLETE <span class="kw">as </span><span class="kw-2">*mut </span>Waiter;
584<span class="kw">const </span>COMPLETE_PTR: <span class="kw-2">*mut </span>Waiter = COMPLETE <span class="kw">as </span><span class="kw-2">*mut </span>Waiter;
585
586<span class="comment">// Mask to learn about the state. All other bits are the queue of waiters if
587// this is in the RUNNING state.
588</span><span class="kw">const </span>STATE_MASK: usize = <span class="number">0x3</span>;
589
590<span class="doccomment">/// Representation of a node in the linked list of waiters in the RUNNING state.
591/// A waiters is stored on the stack of the waiting threads.
592</span><span class="attribute">#[repr(align(<span class="number">4</span>))] </span><span class="comment">// Ensure the two lower bits are free to use as state bits.
593</span><span class="kw">struct </span>Waiter {
594    thread: Cell&lt;<span class="prelude-ty">Option</span>&lt;Thread&gt;&gt;,
595    signaled: AtomicBool,
596    next: <span class="kw-2">*mut </span>Waiter,
597}
598
599<span class="doccomment">/// Drains and notifies the queue of waiters on drop.
600</span><span class="kw">struct </span>Guard&lt;<span class="lifetime">&#39;a</span>&gt; {
601    queue: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>AtomicPtr&lt;Waiter&gt;,
602    new_queue: <span class="kw-2">*mut </span>Waiter,
603}
604
605<span class="kw">impl </span>Drop <span class="kw">for </span>Guard&lt;<span class="lifetime">&#39;_</span>&gt; {
606    <span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
607        <span class="kw">let </span>queue = <span class="self">self</span>.queue.swap(<span class="self">self</span>.new_queue, Ordering::AcqRel);
608
609        <span class="kw">let </span>state = strict::addr(queue) &amp; STATE_MASK;
610        <span class="macro">assert_eq!</span>(state, RUNNING);
611
612        <span class="kw">unsafe </span>{
613            <span class="kw">let </span><span class="kw-2">mut </span>waiter = strict::map_addr(queue, |q| q &amp; !STATE_MASK);
614            <span class="kw">while </span>!waiter.is_null() {
615                <span class="kw">let </span>next = (<span class="kw-2">*</span>waiter).next;
616                <span class="kw">let </span>thread = (<span class="kw-2">*</span>waiter).thread.take().unwrap();
617                (<span class="kw-2">*</span>waiter).signaled.store(<span class="bool-val">true</span>, Ordering::Release);
618                waiter = next;
619                thread.unpark();
620            }
621        }
622    }
623}
624
625<span class="comment">// Corresponds to `std::sync::Once::call_inner`.
626//
627// Originally copied from std, but since modified to remove poisoning and to
628// support wait.
629//
630// Note: this is intentionally monomorphic
631</span><span class="attribute">#[inline(never)]
632</span><span class="kw">fn </span>initialize_or_wait(queue: <span class="kw-2">&amp;</span>AtomicPtr&lt;Waiter&gt;, <span class="kw-2">mut </span>init: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;mut </span><span class="kw">dyn </span>FnMut() -&gt; bool&gt;) {
633    <span class="kw">let </span><span class="kw-2">mut </span>curr_queue = queue.load(Ordering::Acquire);
634
635    <span class="kw">loop </span>{
636        <span class="kw">let </span>curr_state = strict::addr(curr_queue) &amp; STATE_MASK;
637        <span class="kw">match </span>(curr_state, <span class="kw-2">&amp;mut </span>init) {
638            (COMPLETE, <span class="kw">_</span>) =&gt; <span class="kw">return</span>,
639            (INCOMPLETE, <span class="prelude-val">Some</span>(init)) =&gt; {
640                <span class="kw">let </span>exchange = queue.compare_exchange(
641                    curr_queue,
642                    strict::map_addr(curr_queue, |q| (q &amp; !STATE_MASK) | RUNNING),
643                    Ordering::Acquire,
644                    Ordering::Acquire,
645                );
646                <span class="kw">if let </span><span class="prelude-val">Err</span>(new_queue) = exchange {
647                    curr_queue = new_queue;
648                    <span class="kw">continue</span>;
649                }
650                <span class="kw">let </span><span class="kw-2">mut </span>guard = Guard { queue, new_queue: INCOMPLETE_PTR };
651                <span class="kw">if </span>init() {
652                    guard.new_queue = COMPLETE_PTR;
653                }
654                <span class="kw">return</span>;
655            }
656            (INCOMPLETE, <span class="prelude-val">None</span>) | (RUNNING, <span class="kw">_</span>) =&gt; {
657                wait(<span class="kw-2">&amp;</span>queue, curr_queue);
658                curr_queue = queue.load(Ordering::Acquire);
659            }
660            <span class="kw">_ </span>=&gt; <span class="macro">debug_assert!</span>(<span class="bool-val">false</span>),
661        }
662    }
663}
664
665<span class="kw">fn </span>wait(queue: <span class="kw-2">&amp;</span>AtomicPtr&lt;Waiter&gt;, <span class="kw-2">mut </span>curr_queue: <span class="kw-2">*mut </span>Waiter) {
666    <span class="kw">let </span>curr_state = strict::addr(curr_queue) &amp; STATE_MASK;
667    <span class="kw">loop </span>{
668        <span class="kw">let </span>node = Waiter {
669            thread: Cell::new(<span class="prelude-val">Some</span>(thread::current())),
670            signaled: AtomicBool::new(<span class="bool-val">false</span>),
671            next: strict::map_addr(curr_queue, |q| q &amp; !STATE_MASK),
672        };
673        <span class="kw">let </span>me = <span class="kw-2">&amp;</span>node <span class="kw">as </span><span class="kw-2">*const </span>Waiter <span class="kw">as </span><span class="kw-2">*mut </span>Waiter;
674
675        <span class="kw">let </span>exchange = queue.compare_exchange(
676            curr_queue,
677            strict::map_addr(me, |q| q | curr_state),
678            Ordering::Release,
679            Ordering::Relaxed,
680        );
681        <span class="kw">if let </span><span class="prelude-val">Err</span>(new_queue) = exchange {
682            <span class="kw">if </span>strict::addr(new_queue) &amp; STATE_MASK != curr_state {
683                <span class="kw">return</span>;
684            }
685            curr_queue = new_queue;
686            <span class="kw">continue</span>;
687        }
688
689        <span class="kw">while </span>!node.signaled.load(Ordering::Acquire) {
690            thread::park();
691        }
692        <span class="kw">break</span>;
693    }
694}
695
696<span class="comment">// Polyfill of strict provenance from https://crates.io/crates/sptr.
697//
698// Use free-standing function rather than a trait to keep things simple and
699// avoid any potential conflicts with future stabile std API.
700</span><span class="kw">mod </span>strict {
701    <span class="attribute">#[must_use]
702    #[inline]
703    </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>addr&lt;T&gt;(ptr: <span class="kw-2">*mut </span>T) -&gt; usize
704    <span class="kw">where
705        </span>T: Sized,
706    {
707        <span class="comment">// FIXME(strict_provenance_magic): I am magic and should be a compiler intrinsic.
708        // SAFETY: Pointer-to-integer transmutes are valid (if you are okay with losing the
709        // provenance).
710        </span><span class="kw">unsafe </span>{ core::mem::transmute(ptr) }
711    }
712
713    <span class="attribute">#[must_use]
714    #[inline]
715    </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>with_addr&lt;T&gt;(ptr: <span class="kw-2">*mut </span>T, addr: usize) -&gt; <span class="kw-2">*mut </span>T
716    <span class="kw">where
717        </span>T: Sized,
718    {
719        <span class="comment">// FIXME(strict_provenance_magic): I am magic and should be a compiler intrinsic.
720        //
721        // In the mean-time, this operation is defined to be &quot;as if&quot; it was
722        // a wrapping_offset, so we can emulate it as such. This should properly
723        // restore pointer provenance even under today&#39;s compiler.
724        </span><span class="kw">let </span>self_addr = <span class="self">self</span>::addr(ptr) <span class="kw">as </span>isize;
725        <span class="kw">let </span>dest_addr = addr <span class="kw">as </span>isize;
726        <span class="kw">let </span>offset = dest_addr.wrapping_sub(self_addr);
727
728        <span class="comment">// This is the canonical desugarring of this operation,
729        // but `pointer::cast` was only stabilized in 1.38.
730        // self.cast::&lt;u8&gt;().wrapping_offset(offset).cast::&lt;T&gt;()
731        </span>(ptr <span class="kw">as </span><span class="kw-2">*mut </span>u8).wrapping_offset(offset) <span class="kw">as </span><span class="kw-2">*mut </span>T
732    }
733
734    <span class="attribute">#[must_use]
735    #[inline]
736    </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>map_addr&lt;T&gt;(ptr: <span class="kw-2">*mut </span>T, f: <span class="kw">impl </span>FnOnce(usize) -&gt; usize) -&gt; <span class="kw-2">*mut </span>T
737    <span class="kw">where
738        </span>T: Sized,
739    {
740        <span class="self">self</span>::with_addr(ptr, f(addr(ptr)))
741    }
742}
743
744<span class="comment">// These test are snatched from std as well.
745</span><span class="attribute">#[cfg(test)]
746</span><span class="kw">mod </span>tests {
747    <span class="kw">use </span>std::panic;
748    <span class="kw">use </span>std::{sync::mpsc::channel, thread};
749
750    <span class="kw">use </span><span class="kw">super</span>::OnceCell;
751
752    <span class="kw">impl</span>&lt;T&gt; OnceCell&lt;T&gt; {
753        <span class="kw">fn </span>init(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw">impl </span>FnOnce() -&gt; T) {
754            <span class="kw">enum </span>Void {}
755            <span class="kw">let _ </span>= <span class="self">self</span>.initialize(|| <span class="prelude-val">Ok</span>::&lt;T, Void&gt;(f()));
756        }
757    }
758
759    <span class="attribute">#[test]
760    </span><span class="kw">fn </span>smoke_once() {
761        <span class="kw">static </span>O: OnceCell&lt;()&gt; = OnceCell::new();
762        <span class="kw">let </span><span class="kw-2">mut </span>a = <span class="number">0</span>;
763        O.init(|| a += <span class="number">1</span>);
764        <span class="macro">assert_eq!</span>(a, <span class="number">1</span>);
765        O.init(|| a += <span class="number">1</span>);
766        <span class="macro">assert_eq!</span>(a, <span class="number">1</span>);
767    }
768
769    <span class="attribute">#[test]
770    </span><span class="kw">fn </span>stampede_once() {
771        <span class="kw">static </span>O: OnceCell&lt;()&gt; = OnceCell::new();
772        <span class="kw">static </span><span class="kw-2">mut </span>RUN: bool = <span class="bool-val">false</span>;
773
774        <span class="kw">let </span>(tx, rx) = channel();
775        <span class="kw">for _ in </span><span class="number">0</span>..<span class="number">10 </span>{
776            <span class="kw">let </span>tx = tx.clone();
777            thread::spawn(<span class="kw">move </span>|| {
778                <span class="kw">for _ in </span><span class="number">0</span>..<span class="number">4 </span>{
779                    thread::yield_now()
780                }
781                <span class="kw">unsafe </span>{
782                    O.init(|| {
783                        <span class="macro">assert!</span>(!RUN);
784                        RUN = <span class="bool-val">true</span>;
785                    });
786                    <span class="macro">assert!</span>(RUN);
787                }
788                tx.send(()).unwrap();
789            });
790        }
791
792        <span class="kw">unsafe </span>{
793            O.init(|| {
794                <span class="macro">assert!</span>(!RUN);
795                RUN = <span class="bool-val">true</span>;
796            });
797            <span class="macro">assert!</span>(RUN);
798        }
799
800        <span class="kw">for _ in </span><span class="number">0</span>..<span class="number">10 </span>{
801            rx.recv().unwrap();
802        }
803    }
804
805    <span class="attribute">#[test]
806    </span><span class="kw">fn </span>poison_bad() {
807        <span class="kw">static </span>O: OnceCell&lt;()&gt; = OnceCell::new();
808
809        <span class="comment">// poison the once
810        </span><span class="kw">let </span>t = panic::catch_unwind(|| {
811            O.init(|| <span class="macro">panic!</span>());
812        });
813        <span class="macro">assert!</span>(t.is_err());
814
815        <span class="comment">// we can subvert poisoning, however
816        </span><span class="kw">let </span><span class="kw-2">mut </span>called = <span class="bool-val">false</span>;
817        O.init(|| {
818            called = <span class="bool-val">true</span>;
819        });
820        <span class="macro">assert!</span>(called);
821
822        <span class="comment">// once any success happens, we stop propagating the poison
823        </span>O.init(|| {});
824    }
825
826    <span class="attribute">#[test]
827    </span><span class="kw">fn </span>wait_for_force_to_finish() {
828        <span class="kw">static </span>O: OnceCell&lt;()&gt; = OnceCell::new();
829
830        <span class="comment">// poison the once
831        </span><span class="kw">let </span>t = panic::catch_unwind(|| {
832            O.init(|| <span class="macro">panic!</span>());
833        });
834        <span class="macro">assert!</span>(t.is_err());
835
836        <span class="comment">// make sure someone&#39;s waiting inside the once via a force
837        </span><span class="kw">let </span>(tx1, rx1) = channel();
838        <span class="kw">let </span>(tx2, rx2) = channel();
839        <span class="kw">let </span>t1 = thread::spawn(<span class="kw">move </span>|| {
840            O.init(|| {
841                tx1.send(()).unwrap();
842                rx2.recv().unwrap();
843            });
844        });
845
846        rx1.recv().unwrap();
847
848        <span class="comment">// put another waiter on the once
849        </span><span class="kw">let </span>t2 = thread::spawn(|| {
850            <span class="kw">let </span><span class="kw-2">mut </span>called = <span class="bool-val">false</span>;
851            O.init(|| {
852                called = <span class="bool-val">true</span>;
853            });
854            <span class="macro">assert!</span>(!called);
855        });
856
857        tx2.send(()).unwrap();
858
859        <span class="macro">assert!</span>(t1.join().is_ok());
860        <span class="macro">assert!</span>(t2.join().is_ok());
861    }
862
863    <span class="attribute">#[test]
864    #[cfg(target_pointer_width = <span class="string">&quot;64&quot;</span>)]
865    </span><span class="kw">fn </span>test_size() {
866        <span class="kw">use </span>std::mem::size_of;
867
868        <span class="macro">assert_eq!</span>(size_of::&lt;OnceCell&lt;u32&gt;&gt;(), <span class="number">4 </span>* size_of::&lt;u32&gt;());
869    }
870}
871</code></pre></div>
872</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="once_cell" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (4a1467723 2022-09-23)" ></div></body></html>