| <!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/arc-swap-1.6.0/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="../../arc_swap/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="../../arc_swap/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> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| <span id="443">443</span> |
| <span id="444">444</span> |
| <span id="445">445</span> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| <span id="491">491</span> |
| <span id="492">492</span> |
| <span id="493">493</span> |
| <span id="494">494</span> |
| <span id="495">495</span> |
| <span id="496">496</span> |
| <span id="497">497</span> |
| <span id="498">498</span> |
| <span id="499">499</span> |
| <span id="500">500</span> |
| <span id="501">501</span> |
| <span id="502">502</span> |
| <span id="503">503</span> |
| <span id="504">504</span> |
| <span id="505">505</span> |
| <span id="506">506</span> |
| <span id="507">507</span> |
| <span id="508">508</span> |
| <span id="509">509</span> |
| <span id="510">510</span> |
| <span id="511">511</span> |
| <span id="512">512</span> |
| <span id="513">513</span> |
| <span id="514">514</span> |
| <span id="515">515</span> |
| <span id="516">516</span> |
| <span id="517">517</span> |
| <span id="518">518</span> |
| <span id="519">519</span> |
| <span id="520">520</span> |
| <span id="521">521</span> |
| <span id="522">522</span> |
| <span id="523">523</span> |
| <span id="524">524</span> |
| <span id="525">525</span> |
| <span id="526">526</span> |
| <span id="527">527</span> |
| <span id="528">528</span> |
| <span id="529">529</span> |
| <span id="530">530</span> |
| <span id="531">531</span> |
| <span id="532">532</span> |
| <span id="533">533</span> |
| <span id="534">534</span> |
| <span id="535">535</span> |
| <span id="536">536</span> |
| <span id="537">537</span> |
| <span id="538">538</span> |
| <span id="539">539</span> |
| <span id="540">540</span> |
| <span id="541">541</span> |
| <span id="542">542</span> |
| <span id="543">543</span> |
| <span id="544">544</span> |
| <span id="545">545</span> |
| <span id="546">546</span> |
| <span id="547">547</span> |
| <span id="548">548</span> |
| <span id="549">549</span> |
| <span id="550">550</span> |
| <span id="551">551</span> |
| <span id="552">552</span> |
| <span id="553">553</span> |
| <span id="554">554</span> |
| <span id="555">555</span> |
| <span id="556">556</span> |
| <span id="557">557</span> |
| <span id="558">558</span> |
| <span id="559">559</span> |
| <span id="560">560</span> |
| <span id="561">561</span> |
| <span id="562">562</span> |
| <span id="563">563</span> |
| <span id="564">564</span> |
| <span id="565">565</span> |
| <span id="566">566</span> |
| <span id="567">567</span> |
| <span id="568">568</span> |
| <span id="569">569</span> |
| <span id="570">570</span> |
| <span id="571">571</span> |
| <span id="572">572</span> |
| <span id="573">573</span> |
| <span id="574">574</span> |
| <span id="575">575</span> |
| <span id="576">576</span> |
| <span id="577">577</span> |
| <span id="578">578</span> |
| <span id="579">579</span> |
| <span id="580">580</span> |
| <span id="581">581</span> |
| <span id="582">582</span> |
| <span id="583">583</span> |
| <span id="584">584</span> |
| <span id="585">585</span> |
| <span id="586">586</span> |
| <span id="587">587</span> |
| <span id="588">588</span> |
| <span id="589">589</span> |
| <span id="590">590</span> |
| <span id="591">591</span> |
| <span id="592">592</span> |
| <span id="593">593</span> |
| <span id="594">594</span> |
| <span id="595">595</span> |
| <span id="596">596</span> |
| <span id="597">597</span> |
| <span id="598">598</span> |
| <span id="599">599</span> |
| <span id="600">600</span> |
| <span id="601">601</span> |
| <span id="602">602</span> |
| <span id="603">603</span> |
| <span id="604">604</span> |
| <span id="605">605</span> |
| <span id="606">606</span> |
| <span id="607">607</span> |
| <span id="608">608</span> |
| <span id="609">609</span> |
| <span id="610">610</span> |
| <span id="611">611</span> |
| <span id="612">612</span> |
| <span id="613">613</span> |
| <span id="614">614</span> |
| <span id="615">615</span> |
| <span id="616">616</span> |
| <span id="617">617</span> |
| <span id="618">618</span> |
| <span id="619">619</span> |
| <span id="620">620</span> |
| <span id="621">621</span> |
| <span id="622">622</span> |
| <span id="623">623</span> |
| <span id="624">624</span> |
| <span id="625">625</span> |
| <span id="626">626</span> |
| <span id="627">627</span> |
| <span id="628">628</span> |
| <span id="629">629</span> |
| <span id="630">630</span> |
| <span id="631">631</span> |
| <span id="632">632</span> |
| <span id="633">633</span> |
| <span id="634">634</span> |
| <span id="635">635</span> |
| <span id="636">636</span> |
| <span id="637">637</span> |
| <span id="638">638</span> |
| <span id="639">639</span> |
| <span id="640">640</span> |
| <span id="641">641</span> |
| <span id="642">642</span> |
| <span id="643">643</span> |
| <span id="644">644</span> |
| <span id="645">645</span> |
| <span id="646">646</span> |
| <span id="647">647</span> |
| <span id="648">648</span> |
| <span id="649">649</span> |
| <span id="650">650</span> |
| <span id="651">651</span> |
| <span id="652">652</span> |
| <span id="653">653</span> |
| <span id="654">654</span> |
| <span id="655">655</span> |
| <span id="656">656</span> |
| <span id="657">657</span> |
| <span id="658">658</span> |
| <span id="659">659</span> |
| <span id="660">660</span> |
| <span id="661">661</span> |
| <span id="662">662</span> |
| <span id="663">663</span> |
| <span id="664">664</span> |
| <span id="665">665</span> |
| <span id="666">666</span> |
| <span id="667">667</span> |
| <span id="668">668</span> |
| <span id="669">669</span> |
| <span id="670">670</span> |
| <span id="671">671</span> |
| <span id="672">672</span> |
| <span id="673">673</span> |
| <span id="674">674</span> |
| <span id="675">675</span> |
| <span id="676">676</span> |
| <span id="677">677</span> |
| <span id="678">678</span> |
| <span id="679">679</span> |
| <span id="680">680</span> |
| <span id="681">681</span> |
| <span id="682">682</span> |
| <span id="683">683</span> |
| <span id="684">684</span> |
| <span id="685">685</span> |
| <span id="686">686</span> |
| <span id="687">687</span> |
| <span id="688">688</span> |
| <span id="689">689</span> |
| <span id="690">690</span> |
| <span id="691">691</span> |
| <span id="692">692</span> |
| <span id="693">693</span> |
| <span id="694">694</span> |
| <span id="695">695</span> |
| <span id="696">696</span> |
| <span id="697">697</span> |
| <span id="698">698</span> |
| <span id="699">699</span> |
| <span id="700">700</span> |
| <span id="701">701</span> |
| <span id="702">702</span> |
| <span id="703">703</span> |
| <span id="704">704</span> |
| <span id="705">705</span> |
| <span id="706">706</span> |
| <span id="707">707</span> |
| <span id="708">708</span> |
| <span id="709">709</span> |
| <span id="710">710</span> |
| <span id="711">711</span> |
| <span id="712">712</span> |
| <span id="713">713</span> |
| <span id="714">714</span> |
| <span id="715">715</span> |
| <span id="716">716</span> |
| <span id="717">717</span> |
| <span id="718">718</span> |
| <span id="719">719</span> |
| <span id="720">720</span> |
| <span id="721">721</span> |
| <span id="722">722</span> |
| <span id="723">723</span> |
| <span id="724">724</span> |
| <span id="725">725</span> |
| <span id="726">726</span> |
| <span id="727">727</span> |
| <span id="728">728</span> |
| <span id="729">729</span> |
| <span id="730">730</span> |
| <span id="731">731</span> |
| <span id="732">732</span> |
| <span id="733">733</span> |
| <span id="734">734</span> |
| <span id="735">735</span> |
| <span id="736">736</span> |
| <span id="737">737</span> |
| <span id="738">738</span> |
| <span id="739">739</span> |
| <span id="740">740</span> |
| <span id="741">741</span> |
| <span id="742">742</span> |
| <span id="743">743</span> |
| <span id="744">744</span> |
| <span id="745">745</span> |
| <span id="746">746</span> |
| <span id="747">747</span> |
| <span id="748">748</span> |
| <span id="749">749</span> |
| <span id="750">750</span> |
| <span id="751">751</span> |
| <span id="752">752</span> |
| <span id="753">753</span> |
| <span id="754">754</span> |
| <span id="755">755</span> |
| <span id="756">756</span> |
| <span id="757">757</span> |
| <span id="758">758</span> |
| <span id="759">759</span> |
| <span id="760">760</span> |
| <span id="761">761</span> |
| <span id="762">762</span> |
| <span id="763">763</span> |
| <span id="764">764</span> |
| <span id="765">765</span> |
| <span id="766">766</span> |
| <span id="767">767</span> |
| <span id="768">768</span> |
| <span id="769">769</span> |
| <span id="770">770</span> |
| <span id="771">771</span> |
| <span id="772">772</span> |
| <span id="773">773</span> |
| <span id="774">774</span> |
| <span id="775">775</span> |
| <span id="776">776</span> |
| <span id="777">777</span> |
| <span id="778">778</span> |
| <span id="779">779</span> |
| <span id="780">780</span> |
| <span id="781">781</span> |
| <span id="782">782</span> |
| <span id="783">783</span> |
| <span id="784">784</span> |
| <span id="785">785</span> |
| <span id="786">786</span> |
| <span id="787">787</span> |
| <span id="788">788</span> |
| <span id="789">789</span> |
| <span id="790">790</span> |
| <span id="791">791</span> |
| <span id="792">792</span> |
| <span id="793">793</span> |
| <span id="794">794</span> |
| <span id="795">795</span> |
| <span id="796">796</span> |
| <span id="797">797</span> |
| <span id="798">798</span> |
| <span id="799">799</span> |
| <span id="800">800</span> |
| <span id="801">801</span> |
| <span id="802">802</span> |
| <span id="803">803</span> |
| <span id="804">804</span> |
| <span id="805">805</span> |
| <span id="806">806</span> |
| <span id="807">807</span> |
| <span id="808">808</span> |
| <span id="809">809</span> |
| <span id="810">810</span> |
| <span id="811">811</span> |
| <span id="812">812</span> |
| <span id="813">813</span> |
| <span id="814">814</span> |
| <span id="815">815</span> |
| <span id="816">816</span> |
| <span id="817">817</span> |
| <span id="818">818</span> |
| <span id="819">819</span> |
| <span id="820">820</span> |
| <span id="821">821</span> |
| <span id="822">822</span> |
| <span id="823">823</span> |
| <span id="824">824</span> |
| <span id="825">825</span> |
| <span id="826">826</span> |
| <span id="827">827</span> |
| <span id="828">828</span> |
| <span id="829">829</span> |
| <span id="830">830</span> |
| <span id="831">831</span> |
| <span id="832">832</span> |
| <span id="833">833</span> |
| <span id="834">834</span> |
| <span id="835">835</span> |
| <span id="836">836</span> |
| <span id="837">837</span> |
| <span id="838">838</span> |
| <span id="839">839</span> |
| <span id="840">840</span> |
| <span id="841">841</span> |
| <span id="842">842</span> |
| <span id="843">843</span> |
| <span id="844">844</span> |
| <span id="845">845</span> |
| <span id="846">846</span> |
| <span id="847">847</span> |
| <span id="848">848</span> |
| <span id="849">849</span> |
| <span id="850">850</span> |
| <span id="851">851</span> |
| <span id="852">852</span> |
| <span id="853">853</span> |
| <span id="854">854</span> |
| <span id="855">855</span> |
| <span id="856">856</span> |
| <span id="857">857</span> |
| <span id="858">858</span> |
| <span id="859">859</span> |
| <span id="860">860</span> |
| <span id="861">861</span> |
| <span id="862">862</span> |
| <span id="863">863</span> |
| <span id="864">864</span> |
| <span id="865">865</span> |
| <span id="866">866</span> |
| <span id="867">867</span> |
| <span id="868">868</span> |
| <span id="869">869</span> |
| <span id="870">870</span> |
| <span id="871">871</span> |
| <span id="872">872</span> |
| <span id="873">873</span> |
| <span id="874">874</span> |
| <span id="875">875</span> |
| <span id="876">876</span> |
| <span id="877">877</span> |
| <span id="878">878</span> |
| <span id="879">879</span> |
| <span id="880">880</span> |
| <span id="881">881</span> |
| <span id="882">882</span> |
| <span id="883">883</span> |
| <span id="884">884</span> |
| <span id="885">885</span> |
| <span id="886">886</span> |
| <span id="887">887</span> |
| <span id="888">888</span> |
| <span id="889">889</span> |
| <span id="890">890</span> |
| <span id="891">891</span> |
| <span id="892">892</span> |
| <span id="893">893</span> |
| <span id="894">894</span> |
| <span id="895">895</span> |
| <span id="896">896</span> |
| <span id="897">897</span> |
| <span id="898">898</span> |
| <span id="899">899</span> |
| <span id="900">900</span> |
| <span id="901">901</span> |
| <span id="902">902</span> |
| <span id="903">903</span> |
| <span id="904">904</span> |
| <span id="905">905</span> |
| <span id="906">906</span> |
| <span id="907">907</span> |
| <span id="908">908</span> |
| <span id="909">909</span> |
| <span id="910">910</span> |
| <span id="911">911</span> |
| <span id="912">912</span> |
| <span id="913">913</span> |
| <span id="914">914</span> |
| <span id="915">915</span> |
| <span id="916">916</span> |
| <span id="917">917</span> |
| <span id="918">918</span> |
| <span id="919">919</span> |
| <span id="920">920</span> |
| <span id="921">921</span> |
| <span id="922">922</span> |
| <span id="923">923</span> |
| <span id="924">924</span> |
| <span id="925">925</span> |
| <span id="926">926</span> |
| <span id="927">927</span> |
| <span id="928">928</span> |
| <span id="929">929</span> |
| <span id="930">930</span> |
| <span id="931">931</span> |
| <span id="932">932</span> |
| <span id="933">933</span> |
| <span id="934">934</span> |
| <span id="935">935</span> |
| <span id="936">936</span> |
| <span id="937">937</span> |
| <span id="938">938</span> |
| <span id="939">939</span> |
| <span id="940">940</span> |
| <span id="941">941</span> |
| <span id="942">942</span> |
| <span id="943">943</span> |
| <span id="944">944</span> |
| <span id="945">945</span> |
| <span id="946">946</span> |
| <span id="947">947</span> |
| <span id="948">948</span> |
| <span id="949">949</span> |
| <span id="950">950</span> |
| <span id="951">951</span> |
| <span id="952">952</span> |
| <span id="953">953</span> |
| <span id="954">954</span> |
| <span id="955">955</span> |
| <span id="956">956</span> |
| <span id="957">957</span> |
| <span id="958">958</span> |
| <span id="959">959</span> |
| <span id="960">960</span> |
| <span id="961">961</span> |
| <span id="962">962</span> |
| <span id="963">963</span> |
| <span id="964">964</span> |
| <span id="965">965</span> |
| <span id="966">966</span> |
| <span id="967">967</span> |
| <span id="968">968</span> |
| <span id="969">969</span> |
| <span id="970">970</span> |
| <span id="971">971</span> |
| <span id="972">972</span> |
| <span id="973">973</span> |
| <span id="974">974</span> |
| <span id="975">975</span> |
| <span id="976">976</span> |
| <span id="977">977</span> |
| <span id="978">978</span> |
| <span id="979">979</span> |
| <span id="980">980</span> |
| <span id="981">981</span> |
| <span id="982">982</span> |
| <span id="983">983</span> |
| <span id="984">984</span> |
| <span id="985">985</span> |
| <span id="986">986</span> |
| <span id="987">987</span> |
| <span id="988">988</span> |
| <span id="989">989</span> |
| <span id="990">990</span> |
| <span id="991">991</span> |
| <span id="992">992</span> |
| <span id="993">993</span> |
| <span id="994">994</span> |
| <span id="995">995</span> |
| <span id="996">996</span> |
| <span id="997">997</span> |
| <span id="998">998</span> |
| <span id="999">999</span> |
| <span id="1000">1000</span> |
| <span id="1001">1001</span> |
| <span id="1002">1002</span> |
| <span id="1003">1003</span> |
| <span id="1004">1004</span> |
| <span id="1005">1005</span> |
| <span id="1006">1006</span> |
| <span id="1007">1007</span> |
| <span id="1008">1008</span> |
| <span id="1009">1009</span> |
| <span id="1010">1010</span> |
| <span id="1011">1011</span> |
| <span id="1012">1012</span> |
| <span id="1013">1013</span> |
| <span id="1014">1014</span> |
| <span id="1015">1015</span> |
| <span id="1016">1016</span> |
| <span id="1017">1017</span> |
| <span id="1018">1018</span> |
| <span id="1019">1019</span> |
| <span id="1020">1020</span> |
| <span id="1021">1021</span> |
| <span id="1022">1022</span> |
| <span id="1023">1023</span> |
| <span id="1024">1024</span> |
| <span id="1025">1025</span> |
| <span id="1026">1026</span> |
| <span id="1027">1027</span> |
| <span id="1028">1028</span> |
| <span id="1029">1029</span> |
| <span id="1030">1030</span> |
| <span id="1031">1031</span> |
| <span id="1032">1032</span> |
| <span id="1033">1033</span> |
| <span id="1034">1034</span> |
| <span id="1035">1035</span> |
| <span id="1036">1036</span> |
| <span id="1037">1037</span> |
| <span id="1038">1038</span> |
| <span id="1039">1039</span> |
| <span id="1040">1040</span> |
| <span id="1041">1041</span> |
| <span id="1042">1042</span> |
| <span id="1043">1043</span> |
| <span id="1044">1044</span> |
| <span id="1045">1045</span> |
| <span id="1046">1046</span> |
| <span id="1047">1047</span> |
| <span id="1048">1048</span> |
| <span id="1049">1049</span> |
| <span id="1050">1050</span> |
| <span id="1051">1051</span> |
| <span id="1052">1052</span> |
| <span id="1053">1053</span> |
| <span id="1054">1054</span> |
| <span id="1055">1055</span> |
| <span id="1056">1056</span> |
| <span id="1057">1057</span> |
| <span id="1058">1058</span> |
| <span id="1059">1059</span> |
| <span id="1060">1060</span> |
| <span id="1061">1061</span> |
| <span id="1062">1062</span> |
| <span id="1063">1063</span> |
| <span id="1064">1064</span> |
| <span id="1065">1065</span> |
| <span id="1066">1066</span> |
| <span id="1067">1067</span> |
| <span id="1068">1068</span> |
| <span id="1069">1069</span> |
| <span id="1070">1070</span> |
| <span id="1071">1071</span> |
| <span id="1072">1072</span> |
| <span id="1073">1073</span> |
| <span id="1074">1074</span> |
| <span id="1075">1075</span> |
| <span id="1076">1076</span> |
| <span id="1077">1077</span> |
| <span id="1078">1078</span> |
| <span id="1079">1079</span> |
| <span id="1080">1080</span> |
| <span id="1081">1081</span> |
| <span id="1082">1082</span> |
| <span id="1083">1083</span> |
| <span id="1084">1084</span> |
| <span id="1085">1085</span> |
| <span id="1086">1086</span> |
| <span id="1087">1087</span> |
| <span id="1088">1088</span> |
| <span id="1089">1089</span> |
| <span id="1090">1090</span> |
| <span id="1091">1091</span> |
| <span id="1092">1092</span> |
| <span id="1093">1093</span> |
| <span id="1094">1094</span> |
| <span id="1095">1095</span> |
| <span id="1096">1096</span> |
| <span id="1097">1097</span> |
| <span id="1098">1098</span> |
| <span id="1099">1099</span> |
| <span id="1100">1100</span> |
| <span id="1101">1101</span> |
| <span id="1102">1102</span> |
| <span id="1103">1103</span> |
| <span id="1104">1104</span> |
| <span id="1105">1105</span> |
| <span id="1106">1106</span> |
| <span id="1107">1107</span> |
| <span id="1108">1108</span> |
| <span id="1109">1109</span> |
| <span id="1110">1110</span> |
| <span id="1111">1111</span> |
| <span id="1112">1112</span> |
| <span id="1113">1113</span> |
| <span id="1114">1114</span> |
| <span id="1115">1115</span> |
| <span id="1116">1116</span> |
| <span id="1117">1117</span> |
| <span id="1118">1118</span> |
| <span id="1119">1119</span> |
| <span id="1120">1120</span> |
| <span id="1121">1121</span> |
| <span id="1122">1122</span> |
| <span id="1123">1123</span> |
| <span id="1124">1124</span> |
| <span id="1125">1125</span> |
| <span id="1126">1126</span> |
| <span id="1127">1127</span> |
| <span id="1128">1128</span> |
| <span id="1129">1129</span> |
| <span id="1130">1130</span> |
| <span id="1131">1131</span> |
| <span id="1132">1132</span> |
| <span id="1133">1133</span> |
| <span id="1134">1134</span> |
| <span id="1135">1135</span> |
| <span id="1136">1136</span> |
| <span id="1137">1137</span> |
| <span id="1138">1138</span> |
| <span id="1139">1139</span> |
| <span id="1140">1140</span> |
| <span id="1141">1141</span> |
| <span id="1142">1142</span> |
| <span id="1143">1143</span> |
| <span id="1144">1144</span> |
| <span id="1145">1145</span> |
| <span id="1146">1146</span> |
| <span id="1147">1147</span> |
| <span id="1148">1148</span> |
| <span id="1149">1149</span> |
| <span id="1150">1150</span> |
| <span id="1151">1151</span> |
| <span id="1152">1152</span> |
| <span id="1153">1153</span> |
| <span id="1154">1154</span> |
| <span id="1155">1155</span> |
| <span id="1156">1156</span> |
| <span id="1157">1157</span> |
| <span id="1158">1158</span> |
| <span id="1159">1159</span> |
| <span id="1160">1160</span> |
| <span id="1161">1161</span> |
| <span id="1162">1162</span> |
| <span id="1163">1163</span> |
| <span id="1164">1164</span> |
| <span id="1165">1165</span> |
| <span id="1166">1166</span> |
| <span id="1167">1167</span> |
| <span id="1168">1168</span> |
| <span id="1169">1169</span> |
| <span id="1170">1170</span> |
| <span id="1171">1171</span> |
| <span id="1172">1172</span> |
| <span id="1173">1173</span> |
| <span id="1174">1174</span> |
| <span id="1175">1175</span> |
| <span id="1176">1176</span> |
| <span id="1177">1177</span> |
| <span id="1178">1178</span> |
| <span id="1179">1179</span> |
| <span id="1180">1180</span> |
| <span id="1181">1181</span> |
| <span id="1182">1182</span> |
| <span id="1183">1183</span> |
| <span id="1184">1184</span> |
| <span id="1185">1185</span> |
| <span id="1186">1186</span> |
| <span id="1187">1187</span> |
| <span id="1188">1188</span> |
| <span id="1189">1189</span> |
| <span id="1190">1190</span> |
| <span id="1191">1191</span> |
| <span id="1192">1192</span> |
| <span id="1193">1193</span> |
| <span id="1194">1194</span> |
| <span id="1195">1195</span> |
| <span id="1196">1196</span> |
| <span id="1197">1197</span> |
| <span id="1198">1198</span> |
| <span id="1199">1199</span> |
| <span id="1200">1200</span> |
| <span id="1201">1201</span> |
| <span id="1202">1202</span> |
| <span id="1203">1203</span> |
| <span id="1204">1204</span> |
| <span id="1205">1205</span> |
| <span id="1206">1206</span> |
| <span id="1207">1207</span> |
| <span id="1208">1208</span> |
| <span id="1209">1209</span> |
| <span id="1210">1210</span> |
| <span id="1211">1211</span> |
| <span id="1212">1212</span> |
| <span id="1213">1213</span> |
| <span id="1214">1214</span> |
| <span id="1215">1215</span> |
| <span id="1216">1216</span> |
| <span id="1217">1217</span> |
| <span id="1218">1218</span> |
| <span id="1219">1219</span> |
| <span id="1220">1220</span> |
| <span id="1221">1221</span> |
| <span id="1222">1222</span> |
| <span id="1223">1223</span> |
| <span id="1224">1224</span> |
| <span id="1225">1225</span> |
| <span id="1226">1226</span> |
| <span id="1227">1227</span> |
| <span id="1228">1228</span> |
| <span id="1229">1229</span> |
| <span id="1230">1230</span> |
| <span id="1231">1231</span> |
| <span id="1232">1232</span> |
| <span id="1233">1233</span> |
| <span id="1234">1234</span> |
| <span id="1235">1235</span> |
| <span id="1236">1236</span> |
| <span id="1237">1237</span> |
| <span id="1238">1238</span> |
| <span id="1239">1239</span> |
| <span id="1240">1240</span> |
| <span id="1241">1241</span> |
| <span id="1242">1242</span> |
| <span id="1243">1243</span> |
| <span id="1244">1244</span> |
| <span id="1245">1245</span> |
| <span id="1246">1246</span> |
| <span id="1247">1247</span> |
| <span id="1248">1248</span> |
| <span id="1249">1249</span> |
| <span id="1250">1250</span> |
| <span id="1251">1251</span> |
| <span id="1252">1252</span> |
| <span id="1253">1253</span> |
| <span id="1254">1254</span> |
| <span id="1255">1255</span> |
| <span id="1256">1256</span> |
| <span id="1257">1257</span> |
| <span id="1258">1258</span> |
| <span id="1259">1259</span> |
| <span id="1260">1260</span> |
| <span id="1261">1261</span> |
| <span id="1262">1262</span> |
| <span id="1263">1263</span> |
| <span id="1264">1264</span> |
| <span id="1265">1265</span> |
| <span id="1266">1266</span> |
| <span id="1267">1267</span> |
| <span id="1268">1268</span> |
| <span id="1269">1269</span> |
| <span id="1270">1270</span> |
| <span id="1271">1271</span> |
| <span id="1272">1272</span> |
| <span id="1273">1273</span> |
| <span id="1274">1274</span> |
| <span id="1275">1275</span> |
| <span id="1276">1276</span> |
| <span id="1277">1277</span> |
| <span id="1278">1278</span> |
| <span id="1279">1279</span> |
| <span id="1280">1280</span> |
| <span id="1281">1281</span> |
| <span id="1282">1282</span> |
| <span id="1283">1283</span> |
| <span id="1284">1284</span> |
| <span id="1285">1285</span> |
| <span id="1286">1286</span> |
| <span id="1287">1287</span> |
| <span id="1288">1288</span> |
| <span id="1289">1289</span> |
| <span id="1290">1290</span> |
| <span id="1291">1291</span> |
| <span id="1292">1292</span> |
| <span id="1293">1293</span> |
| <span id="1294">1294</span> |
| <span id="1295">1295</span> |
| <span id="1296">1296</span> |
| <span id="1297">1297</span> |
| <span id="1298">1298</span> |
| <span id="1299">1299</span> |
| <span id="1300">1300</span> |
| <span id="1301">1301</span> |
| <span id="1302">1302</span> |
| <span id="1303">1303</span> |
| <span id="1304">1304</span> |
| <span id="1305">1305</span> |
| <span id="1306">1306</span> |
| </pre><pre class="rust"><code><span class="attribute">#![doc(test(attr(deny(warnings))))] |
| #![warn(missing_docs)] |
| #![cfg_attr(docsrs, feature(doc_cfg))] |
| #![allow(deprecated)] |
| |
| </span><span class="doccomment">//! Making [`Arc`][Arc] itself atomic |
| //! |
| //! The [`ArcSwap`] type is a container for an `Arc` that can be changed atomically. Semantically, |
| //! it is similar to something like `Atomic<Arc<T>>` (if there was such a thing) or |
| //! `RwLock<Arc<T>>` (but without the need for the locking). It is optimized for read-mostly |
| //! scenarios, with consistent performance characteristics. |
| //! |
| //! # Motivation |
| //! |
| //! There are many situations in which one might want to have some data structure that is often |
| //! read and seldom updated. Some examples might be a configuration of a service, routing tables, |
| //! snapshot of some data that is renewed every few minutes, etc. |
| //! |
| //! In all these cases one needs: |
| //! * Being able to read the current value of the data structure, fast, often and concurrently from |
| //! many threads. |
| //! * Using the same version of the data structure over longer period of time ‒ a query should be |
| //! answered by a consistent version of data, a packet should be routed either by an old or by a |
| //! new version of the routing table but not by a combination, etc. |
| //! * Perform an update without disrupting the processing. |
| //! |
| //! The first idea would be to use [`RwLock<T>`][RwLock] and keep a read-lock for the whole time of |
| //! processing. Update would, however, pause all processing until done. |
| //! |
| //! Better option would be to have [`RwLock<Arc<T>>`][RwLock]. Then one would lock, clone the [Arc] |
| //! and unlock. This suffers from CPU-level contention (on the lock and on the reference count of |
| //! the [Arc]) which makes it relatively slow. Depending on the implementation, an update may be |
| //! blocked for arbitrary long time by a steady inflow of readers. |
| //! |
| //! ```rust |
| //! # use std::sync::{Arc, RwLock}; |
| //! # use once_cell::sync::Lazy; |
| //! # struct RoutingTable; struct Packet; impl RoutingTable { fn route(&self, _: Packet) {} } |
| //! static ROUTING_TABLE: Lazy<RwLock<Arc<RoutingTable>>> = Lazy::new(|| { |
| //! RwLock::new(Arc::new(RoutingTable)) |
| //! }); |
| //! |
| //! fn process_packet(packet: Packet) { |
| //! let table = Arc::clone(&ROUTING_TABLE.read().unwrap()); |
| //! table.route(packet); |
| //! } |
| //! # fn main() { process_packet(Packet); } |
| //! ``` |
| //! |
| //! The [ArcSwap] can be used instead, which solves the above problems and has better performance |
| //! characteristics than the [RwLock], both in contended and non-contended scenarios. |
| //! |
| //! ```rust |
| //! # use arc_swap::ArcSwap; |
| //! # use once_cell::sync::Lazy; |
| //! # struct RoutingTable; struct Packet; impl RoutingTable { fn route(&self, _: Packet) {} } |
| //! static ROUTING_TABLE: Lazy<ArcSwap<RoutingTable>> = Lazy::new(|| { |
| //! ArcSwap::from_pointee(RoutingTable) |
| //! }); |
| //! |
| //! fn process_packet(packet: Packet) { |
| //! let table = ROUTING_TABLE.load(); |
| //! table.route(packet); |
| //! } |
| //! # fn main() { process_packet(Packet); } |
| //! ``` |
| //! |
| //! # Crate contents |
| //! |
| //! At the heart of the crate there are [`ArcSwap`] and [`ArcSwapOption`] types, containers for an |
| //! [`Arc`] and [`Option<Arc>`][Option]. |
| //! |
| //! Technically, these are type aliases for partial instantiations of the [`ArcSwapAny`] type. The |
| //! [`ArcSwapAny`] is more flexible and allows tweaking of many things (can store other things than |
| //! [`Arc`]s, can configure the locking [`Strategy`]). For details about the tweaking, see the |
| //! documentation of the [`strategy`] module and the [`RefCnt`] trait. |
| //! |
| //! The [`cache`] module provides means for speeding up read access of the contained data at the |
| //! cost of delayed reclamation. |
| //! |
| //! The [`access`] module can be used to do projections into the contained data to separate parts |
| //! of application from each other (eg. giving a component access to only its own part of |
| //! configuration while still having it reloaded as a whole). |
| //! |
| //! # Before using |
| //! |
| //! The data structure is a bit niche. Before using, please check the |
| //! [limitations and common pitfalls][docs::limitations] and the [performance |
| //! characteristics][docs::performance], including choosing the right [read |
| //! operation][docs::performance#read-operations]. |
| //! |
| //! You can also get an inspiration about what's possible in the [common patterns][docs::patterns] |
| //! section. |
| //! |
| //! # Examples |
| //! |
| //! ```rust |
| //! use std::sync::Arc; |
| //! |
| //! use arc_swap::ArcSwap; |
| //! use crossbeam_utils::thread; |
| //! |
| //! fn main() { |
| //! let config = ArcSwap::from(Arc::new(String::default())); |
| //! thread::scope(|scope| { |
| //! scope.spawn(|_| { |
| //! let new_conf = Arc::new("New configuration".to_owned()); |
| //! config.store(new_conf); |
| //! }); |
| //! for _ in 0..10 { |
| //! scope.spawn(|_| { |
| //! loop { |
| //! let cfg = config.load(); |
| //! if !cfg.is_empty() { |
| //! assert_eq!(**cfg, "New configuration"); |
| //! return; |
| //! } |
| //! } |
| //! }); |
| //! } |
| //! }).unwrap(); |
| //! } |
| //! ``` |
| //! |
| //! [RwLock]: https://doc.rust-lang.org/std/sync/struct.RwLock.html |
| |
| </span><span class="kw">pub mod </span>access; |
| <span class="kw">mod </span>as_raw; |
| <span class="kw">pub mod </span>cache; |
| <span class="kw">mod </span>compile_fail_tests; |
| <span class="kw">mod </span>debt; |
| <span class="kw">pub mod </span>docs; |
| <span class="kw">mod </span>ref_cnt; |
| <span class="attribute">#[cfg(feature = <span class="string">"serde"</span>)] |
| </span><span class="kw">mod </span>serde; |
| <span class="kw">pub mod </span>strategy; |
| <span class="attribute">#[cfg(feature = <span class="string">"weak"</span>)] |
| </span><span class="kw">mod </span>weak; |
| |
| <span class="kw">use </span>std::borrow::Borrow; |
| <span class="kw">use </span>std::fmt::{Debug, Display, Formatter, <span class="prelude-ty">Result </span><span class="kw">as </span>FmtResult}; |
| <span class="kw">use </span>std::marker::PhantomData; |
| <span class="kw">use </span>std::mem; |
| <span class="kw">use </span>std::ops::Deref; |
| <span class="kw">use </span>std::ptr; |
| <span class="kw">use </span>std::sync::atomic::{AtomicPtr, Ordering}; |
| <span class="kw">use </span>std::sync::Arc; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::access::{Access, Map}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::as_raw::AsRaw; |
| <span class="kw">pub use </span><span class="kw">crate</span>::cache::Cache; |
| <span class="kw">pub use </span><span class="kw">crate</span>::ref_cnt::RefCnt; |
| <span class="kw">use </span><span class="kw">crate</span>::strategy::hybrid::{DefaultConfig, HybridStrategy}; |
| <span class="kw">use </span><span class="kw">crate</span>::strategy::sealed::Protected; |
| <span class="kw">use </span><span class="kw">crate</span>::strategy::{CaS, Strategy}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::strategy::{DefaultStrategy, IndependentStrategy}; |
| |
| <span class="doccomment">/// A temporary storage of the pointer. |
| /// |
| /// This guard object is returned from most loading methods (with the notable exception of |
| /// [`load_full`](struct.ArcSwapAny.html#method.load_full)). It dereferences to the smart pointer |
| /// loaded, so most operations are to be done using that. |
| </span><span class="kw">pub struct </span>Guard<T: RefCnt, S: Strategy<T> = DefaultStrategy> { |
| inner: S::Protected, |
| } |
| |
| <span class="kw">impl</span><T: RefCnt, S: Strategy<T>> Guard<T, S> { |
| <span class="doccomment">/// Converts it into the held value. |
| /// |
| /// This, on occasion, may be a tiny bit faster than cloning the Arc or whatever is being held |
| /// inside. |
| </span><span class="comment">// Associated function on purpose, because of deref |
| </span><span class="attribute">#[allow(clippy::wrong_self_convention)] |
| #[inline] |
| </span><span class="kw">pub fn </span>into_inner(lease: <span class="self">Self</span>) -> T { |
| lease.inner.into_inner() |
| } |
| |
| <span class="doccomment">/// Create a guard for a given value `inner`. |
| /// |
| /// This can be useful on occasion to pass a specific object to code that expects or |
| /// wants to store a Guard. |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// # use arc_swap::{ArcSwap, DefaultStrategy, Guard}; |
| /// # use std::sync::Arc; |
| /// # let p = ArcSwap::from_pointee(42); |
| /// // Create two guards pointing to the same object |
| /// let g1 = p.load(); |
| /// let g2 = Guard::<_, DefaultStrategy>::from_inner(Arc::clone(&*g1)); |
| /// # drop(g2); |
| /// ``` |
| </span><span class="kw">pub fn </span>from_inner(inner: T) -> <span class="self">Self </span>{ |
| Guard { |
| inner: S::Protected::from_inner(inner), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T: RefCnt, S: Strategy<T>> Deref <span class="kw">for </span>Guard<T, S> { |
| <span class="kw">type </span>Target = T; |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>deref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>T { |
| <span class="self">self</span>.inner.borrow() |
| } |
| } |
| |
| <span class="kw">impl</span><T: RefCnt, S: Strategy<T>> From<T> <span class="kw">for </span>Guard<T, S> { |
| <span class="kw">fn </span>from(inner: T) -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::from_inner(inner) |
| } |
| } |
| |
| <span class="kw">impl</span><T: Default + RefCnt, S: Strategy<T>> Default <span class="kw">for </span>Guard<T, S> { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::from(T::default()) |
| } |
| } |
| |
| <span class="kw">impl</span><T: Debug + RefCnt, S: Strategy<T>> Debug <span class="kw">for </span>Guard<T, S> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, formatter: <span class="kw-2">&mut </span>Formatter) -> FmtResult { |
| <span class="self">self</span>.deref().fmt(formatter) |
| } |
| } |
| |
| <span class="kw">impl</span><T: Display + RefCnt, S: Strategy<T>> Display <span class="kw">for </span>Guard<T, S> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, formatter: <span class="kw-2">&mut </span>Formatter) -> FmtResult { |
| <span class="self">self</span>.deref().fmt(formatter) |
| } |
| } |
| |
| <span class="doccomment">/// Comparison of two pointer-like things. |
| </span><span class="comment">// A and B are likely to *be* references, or thin wrappers around that. Calling that with extra |
| // reference is just annoying. |
| </span><span class="attribute">#[allow(clippy::needless_pass_by_value)] |
| </span><span class="kw">fn </span>ptr_eq<Base, A, B>(a: A, b: B) -> bool |
| <span class="kw">where |
| </span>A: AsRaw<Base>, |
| B: AsRaw<Base>, |
| { |
| <span class="kw">let </span>a = a.as_raw(); |
| <span class="kw">let </span>b = b.as_raw(); |
| ptr::eq(a, b) |
| } |
| |
| <span class="doccomment">/// An atomic storage for a reference counted smart pointer like [`Arc`] or `Option<Arc>`. |
| /// |
| /// This is a storage where a smart pointer may live. It can be read and written atomically from |
| /// several threads, but doesn't act like a pointer itself. |
| /// |
| /// One can be created [`from`] an [`Arc`]. To get the pointer back, use the |
| /// [`load`](#method.load). |
| /// |
| /// # Note |
| /// |
| /// This is the common generic implementation. This allows sharing the same code for storing |
| /// both `Arc` and `Option<Arc>` (and possibly other similar types). |
| /// |
| /// In your code, you most probably want to interact with it through the |
| /// [`ArcSwap`](type.ArcSwap.html) and [`ArcSwapOption`](type.ArcSwapOption.html) aliases. However, |
| /// the methods they share are described here and are applicable to both of them. That's why the |
| /// examples here use `ArcSwap` ‒ but they could as well be written with `ArcSwapOption` or |
| /// `ArcSwapAny`. |
| /// |
| /// # Type parameters |
| /// |
| /// * `T`: The smart pointer to be kept inside. This crate provides implementation for `Arc<_>` and |
| /// `Option<Arc<_>>` (`Rc` too, but that one is not practically useful). But third party could |
| /// provide implementations of the [`RefCnt`] trait and plug in others. |
| /// * `S`: Chooses the [strategy] used to protect the data inside. They come with various |
| /// performance trade offs, the default [`DefaultStrategy`] is good rule of thumb for most use |
| /// cases. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use std::sync::Arc; |
| /// # use arc_swap::ArcSwap; |
| /// let arc = Arc::new(42); |
| /// let arc_swap = ArcSwap::from(arc); |
| /// assert_eq!(42, **arc_swap.load()); |
| /// // It can be read multiple times |
| /// assert_eq!(42, **arc_swap.load()); |
| /// |
| /// // Put a new one in there |
| /// let new_arc = Arc::new(0); |
| /// assert_eq!(42, *arc_swap.swap(new_arc)); |
| /// assert_eq!(0, **arc_swap.load()); |
| /// ``` |
| /// |
| /// # Known bugs |
| /// |
| /// Currently, things like `ArcSwapAny<Option<Option<Arc<_>>>>` (notice the double Option) don't |
| /// work properly. A proper solution is being looked into |
| /// ([#81](https://github.com/vorner/arc-swap/issues)). |
| /// |
| /// [`Arc`]: https://doc.rust-lang.org/std/sync/struct.Arc.html |
| /// [`from`]: https://doc.rust-lang.org/nightly/std/convert/trait.From.html#tymethod.from |
| /// [`RefCnt`]: trait.RefCnt.html |
| </span><span class="kw">pub struct </span>ArcSwapAny<T: RefCnt, S: Strategy<T> = DefaultStrategy> { |
| <span class="comment">// Notes: AtomicPtr needs Sized |
| </span><span class="doccomment">/// The actual pointer, extracted from the Arc. |
| </span>ptr: AtomicPtr<T::Base>, |
| |
| <span class="doccomment">/// We are basically an Arc in disguise. Inherit parameters from Arc by pretending to contain |
| /// it. |
| </span>_phantom_arc: PhantomData<T>, |
| |
| <span class="doccomment">/// Strategy to protect the data. |
| </span>strategy: S, |
| } |
| |
| <span class="kw">impl</span><T: RefCnt, S: Default + Strategy<T>> From<T> <span class="kw">for </span>ArcSwapAny<T, S> { |
| <span class="kw">fn </span>from(val: T) -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::with_strategy(val, S::default()) |
| } |
| } |
| |
| <span class="kw">impl</span><T: RefCnt, S: Strategy<T>> Drop <span class="kw">for </span>ArcSwapAny<T, S> { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="kw">let </span>ptr = <span class="kw-2">*</span><span class="self">self</span>.ptr.get_mut(); |
| <span class="kw">unsafe </span>{ |
| <span class="comment">// To pay any possible debts |
| </span><span class="self">self</span>.strategy.wait_for_readers(ptr, <span class="kw-2">&</span><span class="self">self</span>.ptr); |
| <span class="comment">// We are getting rid of the one stored ref count |
| </span>T::dec(ptr); |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T, S: Strategy<T>> Debug <span class="kw">for </span>ArcSwapAny<T, S> |
| <span class="kw">where |
| </span>T: Debug + RefCnt, |
| { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, formatter: <span class="kw-2">&mut </span>Formatter) -> FmtResult { |
| formatter |
| .debug_tuple(<span class="string">"ArcSwapAny"</span>) |
| .field(<span class="kw-2">&</span><span class="self">self</span>.load()) |
| .finish() |
| } |
| } |
| |
| <span class="kw">impl</span><T, S: Strategy<T>> Display <span class="kw">for </span>ArcSwapAny<T, S> |
| <span class="kw">where |
| </span>T: Display + RefCnt, |
| { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, formatter: <span class="kw-2">&mut </span>Formatter) -> FmtResult { |
| <span class="self">self</span>.load().fmt(formatter) |
| } |
| } |
| |
| <span class="kw">impl</span><T: RefCnt + Default, S: Default + Strategy<T>> Default <span class="kw">for </span>ArcSwapAny<T, S> { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::new(T::default()) |
| } |
| } |
| |
| <span class="kw">impl</span><T: RefCnt, S: Strategy<T>> ArcSwapAny<T, S> { |
| <span class="doccomment">/// Constructs a new storage. |
| </span><span class="kw">pub fn </span>new(val: T) -> <span class="self">Self |
| </span><span class="kw">where |
| </span>S: Default, |
| { |
| <span class="self">Self</span>::from(val) |
| } |
| |
| <span class="doccomment">/// Constructs a new storage while customizing the protection strategy. |
| </span><span class="kw">pub fn </span>with_strategy(val: T, strategy: S) -> <span class="self">Self </span>{ |
| <span class="comment">// The AtomicPtr requires *mut in its interface. We are more like *const, so we cast it. |
| // However, we always go back to *const right away when we get the pointer on the other |
| // side, so it should be fine. |
| </span><span class="kw">let </span>ptr = T::into_ptr(val); |
| <span class="self">Self </span>{ |
| ptr: AtomicPtr::new(ptr), |
| _phantom_arc: PhantomData, |
| strategy, |
| } |
| } |
| |
| <span class="doccomment">/// Extracts the value inside. |
| </span><span class="kw">pub fn </span>into_inner(<span class="kw-2">mut </span><span class="self">self</span>) -> T { |
| <span class="kw">let </span>ptr = <span class="kw-2">*</span><span class="self">self</span>.ptr.get_mut(); |
| <span class="comment">// To pay all the debts |
| </span><span class="kw">unsafe </span>{ <span class="self">self</span>.strategy.wait_for_readers(ptr, <span class="kw-2">&</span><span class="self">self</span>.ptr) }; |
| mem::forget(<span class="self">self</span>); |
| <span class="kw">unsafe </span>{ T::from_ptr(ptr) } |
| } |
| |
| <span class="doccomment">/// Loads the value. |
| /// |
| /// This makes another copy of the held pointer and returns it, atomically (it is |
| /// safe even when other thread stores into the same instance at the same time). |
| /// |
| /// The method is lock-free and wait-free, but usually more expensive than |
| /// [`load`](#method.load). |
| </span><span class="kw">pub fn </span>load_full(<span class="kw-2">&</span><span class="self">self</span>) -> T { |
| Guard::into_inner(<span class="self">self</span>.load()) |
| } |
| |
| <span class="doccomment">/// Provides a temporary borrow of the object inside. |
| /// |
| /// This returns a proxy object allowing access to the thing held inside. However, there's |
| /// only limited amount of possible cheap proxies in existence for each thread ‒ if more are |
| /// created, it falls back to equivalent of [`load_full`](#method.load_full) internally. |
| /// |
| /// This is therefore a good choice to use for eg. searching a data structure or juggling the |
| /// pointers around a bit, but not as something to store in larger amounts. The rule of thumb |
| /// is this is suited for local variables on stack, but not in long-living data structures. |
| /// |
| /// # Consistency |
| /// |
| /// In case multiple related operations are to be done on the loaded value, it is generally |
| /// recommended to call `load` just once and keep the result over calling it multiple times. |
| /// First, keeping it is usually faster. But more importantly, the value can change between the |
| /// calls to load, returning different objects, which could lead to logical inconsistency. |
| /// Keeping the result makes sure the same object is used. |
| /// |
| /// ```rust |
| /// # use arc_swap::ArcSwap; |
| /// struct Point { |
| /// x: usize, |
| /// y: usize, |
| /// } |
| /// |
| /// fn print_broken(p: &ArcSwap<Point>) { |
| /// // This is broken, because the x and y may come from different points, |
| /// // combining into an invalid point that never existed. |
| /// println!("X: {}", p.load().x); |
| /// // If someone changes the content now, between these two loads, we |
| /// // have a problem |
| /// println!("Y: {}", p.load().y); |
| /// } |
| /// |
| /// fn print_correct(p: &ArcSwap<Point>) { |
| /// // Here we take a snapshot of one specific point so both x and y come |
| /// // from the same one. |
| /// let point = p.load(); |
| /// println!("X: {}", point.x); |
| /// println!("Y: {}", point.y); |
| /// } |
| /// # let p = ArcSwap::from_pointee(Point { x: 10, y: 20 }); |
| /// # print_correct(&p); |
| /// # print_broken(&p); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>load(<span class="kw-2">&</span><span class="self">self</span>) -> Guard<T, S> { |
| <span class="kw">let </span>protected = <span class="kw">unsafe </span>{ <span class="self">self</span>.strategy.load(<span class="kw-2">&</span><span class="self">self</span>.ptr) }; |
| Guard { inner: protected } |
| } |
| |
| <span class="doccomment">/// Replaces the value inside this instance. |
| /// |
| /// Further loads will yield the new value. Uses [`swap`](#method.swap) internally. |
| </span><span class="kw">pub fn </span>store(<span class="kw-2">&</span><span class="self">self</span>, val: T) { |
| drop(<span class="self">self</span>.swap(val)); |
| } |
| |
| <span class="doccomment">/// Exchanges the value inside this instance. |
| </span><span class="kw">pub fn </span>swap(<span class="kw-2">&</span><span class="self">self</span>, new: T) -> T { |
| <span class="kw">let </span>new = T::into_ptr(new); |
| <span class="comment">// AcqRel needed to publish the target of the new pointer and get the target of the old |
| // one. |
| // |
| // SeqCst to synchronize the time lines with the group counters. |
| </span><span class="kw">let </span>old = <span class="self">self</span>.ptr.swap(new, Ordering::SeqCst); |
| <span class="kw">unsafe </span>{ |
| <span class="self">self</span>.strategy.wait_for_readers(old, <span class="kw-2">&</span><span class="self">self</span>.ptr); |
| T::from_ptr(old) |
| } |
| } |
| |
| <span class="doccomment">/// Swaps the stored Arc if it equals to `current`. |
| /// |
| /// If the current value of the `ArcSwapAny` equals to `current`, the `new` is stored inside. |
| /// If not, nothing happens. |
| /// |
| /// The previous value (no matter if the swap happened or not) is returned. Therefore, if the |
| /// returned value is equal to `current`, the swap happened. You want to do a pointer-based |
| /// comparison to determine it. |
| /// |
| /// In other words, if the caller „guesses“ the value of current correctly, it acts like |
| /// [`swap`](#method.swap), otherwise it acts like [`load_full`](#method.load_full) (including |
| /// the limitations). |
| /// |
| /// The `current` can be specified as `&Arc`, [`Guard`](struct.Guard.html), |
| /// [`&Guards`](struct.Guards.html) or as a raw pointer (but _not_ owned `Arc`). See the |
| /// [`AsRaw`] trait. |
| </span><span class="kw">pub fn </span>compare_and_swap<C>(<span class="kw-2">&</span><span class="self">self</span>, current: C, new: T) -> Guard<T, S> |
| <span class="kw">where |
| </span>C: AsRaw<T::Base>, |
| S: CaS<T>, |
| { |
| <span class="kw">let </span>protected = <span class="kw">unsafe </span>{ <span class="self">self</span>.strategy.compare_and_swap(<span class="kw-2">&</span><span class="self">self</span>.ptr, current, new) }; |
| Guard { inner: protected } |
| } |
| |
| <span class="doccomment">/// Read-Copy-Update of the pointer inside. |
| /// |
| /// This is useful in read-heavy situations with several threads that sometimes update the data |
| /// pointed to. The readers can just repeatedly use [`load`](#method.load) without any locking. |
| /// The writer uses this method to perform the update. |
| /// |
| /// In case there's only one thread that does updates or in case the next version is |
| /// independent of the previous one, simple [`swap`](#method.swap) or [`store`](#method.store) |
| /// is enough. Otherwise, it may be needed to retry the update operation if some other thread |
| /// made an update in between. This is what this method does. |
| /// |
| /// # Examples |
| /// |
| /// This will *not* work as expected, because between loading and storing, some other thread |
| /// might have updated the value. |
| /// |
| /// ```rust |
| /// # use std::sync::Arc; |
| /// # |
| /// # use arc_swap::ArcSwap; |
| /// # use crossbeam_utils::thread; |
| /// # |
| /// let cnt = ArcSwap::from_pointee(0); |
| /// thread::scope(|scope| { |
| /// for _ in 0..10 { |
| /// scope.spawn(|_| { |
| /// let inner = cnt.load_full(); |
| /// // Another thread might have stored some other number than what we have |
| /// // between the load and store. |
| /// cnt.store(Arc::new(*inner + 1)); |
| /// }); |
| /// } |
| /// }).unwrap(); |
| /// // This will likely fail: |
| /// // assert_eq!(10, *cnt.load_full()); |
| /// ``` |
| /// |
| /// This will, but it can call the closure multiple times to retry: |
| /// |
| /// ```rust |
| /// # use arc_swap::ArcSwap; |
| /// # use crossbeam_utils::thread; |
| /// # |
| /// let cnt = ArcSwap::from_pointee(0); |
| /// thread::scope(|scope| { |
| /// for _ in 0..10 { |
| /// scope.spawn(|_| cnt.rcu(|inner| **inner + 1)); |
| /// } |
| /// }).unwrap(); |
| /// assert_eq!(10, *cnt.load_full()); |
| /// ``` |
| /// |
| /// Due to the retries, you might want to perform all the expensive operations *before* the |
| /// rcu. As an example, if there's a cache of some computations as a map, and the map is cheap |
| /// to clone but the computations are not, you could do something like this: |
| /// |
| /// ```rust |
| /// # use std::collections::HashMap; |
| /// # |
| /// # use arc_swap::ArcSwap; |
| /// # use once_cell::sync::Lazy; |
| /// # |
| /// fn expensive_computation(x: usize) -> usize { |
| /// x * 2 // Let's pretend multiplication is *really expensive expensive* |
| /// } |
| /// |
| /// type Cache = HashMap<usize, usize>; |
| /// |
| /// static CACHE: Lazy<ArcSwap<Cache>> = Lazy::new(|| ArcSwap::default()); |
| /// |
| /// fn cached_computation(x: usize) -> usize { |
| /// let cache = CACHE.load(); |
| /// if let Some(result) = cache.get(&x) { |
| /// return *result; |
| /// } |
| /// // Not in cache. Compute and store. |
| /// // The expensive computation goes outside, so it is not retried. |
| /// let result = expensive_computation(x); |
| /// CACHE.rcu(|cache| { |
| /// // The cheaper clone of the cache can be retried if need be. |
| /// let mut cache = HashMap::clone(&cache); |
| /// cache.insert(x, result); |
| /// cache |
| /// }); |
| /// result |
| /// } |
| /// |
| /// assert_eq!(42, cached_computation(21)); |
| /// assert_eq!(42, cached_computation(21)); |
| /// ``` |
| /// |
| /// # The cost of cloning |
| /// |
| /// Depending on the size of cache above, the cloning might not be as cheap. You can however |
| /// use persistent data structures ‒ each modification creates a new data structure, but it |
| /// shares most of the data with the old one (which is usually accomplished by using `Arc`s |
| /// inside to share the unchanged values). Something like |
| /// [`rpds`](https://crates.io/crates/rpds) or [`im`](https://crates.io/crates/im) might do |
| /// what you need. |
| </span><span class="kw">pub fn </span>rcu<R, F>(<span class="kw-2">&</span><span class="self">self</span>, <span class="kw-2">mut </span>f: F) -> T |
| <span class="kw">where |
| </span>F: FnMut(<span class="kw-2">&</span>T) -> R, |
| R: Into<T>, |
| S: CaS<T>, |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>cur = <span class="self">self</span>.load(); |
| <span class="kw">loop </span>{ |
| <span class="kw">let </span>new = f(<span class="kw-2">&</span>cur).into(); |
| <span class="kw">let </span>prev = <span class="self">self</span>.compare_and_swap(<span class="kw-2">&*</span>cur, new); |
| <span class="kw">let </span>swapped = ptr_eq(<span class="kw-2">&*</span>cur, <span class="kw-2">&*</span>prev); |
| <span class="kw">if </span>swapped { |
| <span class="kw">return </span>Guard::into_inner(prev); |
| } <span class="kw">else </span>{ |
| cur = prev; |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Provides an access to an up to date projection of the carried data. |
| /// |
| /// # Motivation |
| /// |
| /// Sometimes, an application consists of components. Each component has its own configuration |
| /// structure. The whole configuration contains all the smaller config parts. |
| /// |
| /// For the sake of separation and abstraction, it is not desirable to pass the whole |
| /// configuration to each of the components. This allows the component to take only access to |
| /// its own part. |
| /// |
| /// # Lifetimes & flexibility |
| /// |
| /// This method is not the most flexible way, as the returned type borrows into the `ArcSwap`. |
| /// To provide access into eg. `Arc<ArcSwap<T>>`, you can create the [`Map`] type directly. See |
| /// the [`access`] module. |
| /// |
| /// # Performance |
| /// |
| /// As the provided function is called on each load from the shared storage, it should |
| /// generally be cheap. It is expected this will usually be just referencing of a field inside |
| /// the structure. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// use std::sync::Arc; |
| /// |
| /// use arc_swap::ArcSwap; |
| /// use arc_swap::access::Access; |
| /// |
| /// struct Cfg { |
| /// value: usize, |
| /// } |
| /// |
| /// fn print_many_times<V: Access<usize>>(value: V) { |
| /// for _ in 0..25 { |
| /// let value = value.load(); |
| /// println!("{}", *value); |
| /// } |
| /// } |
| /// |
| /// let shared = ArcSwap::from_pointee(Cfg { value: 0 }); |
| /// let mapped = shared.map(|c: &Cfg| &c.value); |
| /// crossbeam_utils::thread::scope(|s| { |
| /// // Will print some zeroes and some twos |
| /// s.spawn(|_| print_many_times(mapped)); |
| /// s.spawn(|_| shared.store(Arc::new(Cfg { value: 2 }))); |
| /// }).expect("Something panicked in a thread"); |
| /// ``` |
| </span><span class="kw">pub fn </span>map<I, R, F>(<span class="kw-2">&</span><span class="self">self</span>, f: F) -> Map<<span class="kw-2">&</span><span class="self">Self</span>, I, F> |
| <span class="kw">where |
| </span>F: Fn(<span class="kw-2">&</span>I) -> <span class="kw-2">&</span>R + Clone, |
| <span class="self">Self</span>: Access<I>, |
| { |
| Map::new(<span class="self">self</span>, f) |
| } |
| } |
| |
| <span class="doccomment">/// An atomic storage for `Arc`. |
| /// |
| /// This is a type alias only. Most of its methods are described on |
| /// [`ArcSwapAny`](struct.ArcSwapAny.html). |
| </span><span class="kw">pub type </span>ArcSwap<T> = ArcSwapAny<Arc<T>>; |
| |
| <span class="kw">impl</span><T, S: Strategy<Arc<T>>> ArcSwapAny<Arc<T>, S> { |
| <span class="doccomment">/// A convenience constructor directly from the pointed-to value. |
| /// |
| /// Direct equivalent for `ArcSwap::new(Arc::new(val))`. |
| </span><span class="kw">pub fn </span>from_pointee(val: T) -> <span class="self">Self |
| </span><span class="kw">where |
| </span>S: Default, |
| { |
| <span class="self">Self</span>::from(Arc::new(val)) |
| } |
| } |
| |
| <span class="doccomment">/// An atomic storage for `Option<Arc>`. |
| /// |
| /// This is very similar to [`ArcSwap`](type.ArcSwap.html), but allows storing NULL values, which |
| /// is useful in some situations. |
| /// |
| /// This is a type alias only. Most of the methods are described on |
| /// [`ArcSwapAny`](struct.ArcSwapAny.html). Even though the examples there often use `ArcSwap`, |
| /// they are applicable to `ArcSwapOption` with appropriate changes. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use std::sync::Arc; |
| /// use arc_swap::ArcSwapOption; |
| /// |
| /// let shared = ArcSwapOption::from(None); |
| /// assert!(shared.load_full().is_none()); |
| /// assert!(shared.swap(Some(Arc::new(42))).is_none()); |
| /// assert_eq!(42, **shared.load_full().as_ref().unwrap()); |
| /// ``` |
| </span><span class="kw">pub type </span>ArcSwapOption<T> = ArcSwapAny<<span class="prelude-ty">Option</span><Arc<T>>>; |
| |
| <span class="kw">impl</span><T, S: Strategy<<span class="prelude-ty">Option</span><Arc<T>>>> ArcSwapAny<<span class="prelude-ty">Option</span><Arc<T>>, S> { |
| <span class="doccomment">/// A convenience constructor directly from a pointed-to value. |
| /// |
| /// This just allocates the `Arc` under the hood. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// use arc_swap::ArcSwapOption; |
| /// |
| /// let empty: ArcSwapOption<usize> = ArcSwapOption::from_pointee(None); |
| /// assert!(empty.load().is_none()); |
| /// let non_empty: ArcSwapOption<usize> = ArcSwapOption::from_pointee(42); |
| /// assert_eq!(42, **non_empty.load().as_ref().unwrap()); |
| /// ``` |
| </span><span class="kw">pub fn </span>from_pointee<V: Into<<span class="prelude-ty">Option</span><T>>>(val: V) -> <span class="self">Self |
| </span><span class="kw">where |
| </span>S: Default, |
| { |
| <span class="self">Self</span>::new(val.into().map(Arc::new)) |
| } |
| |
| <span class="doccomment">/// A convenience constructor for an empty value. |
| /// |
| /// This is equivalent to `ArcSwapOption::new(None)`. |
| </span><span class="kw">pub fn </span>empty() -> <span class="self">Self |
| </span><span class="kw">where |
| </span>S: Default, |
| { |
| <span class="self">Self</span>::new(<span class="prelude-val">None</span>) |
| } |
| } |
| |
| <span class="kw">impl</span><T> ArcSwapOption<T> { |
| <span class="doccomment">/// A const-fn equivalent of [empty]. |
| /// |
| /// Just like [empty], this creates an `None`-holding `ArcSwapOption`. The [empty] is, however, |
| /// more general ‒ this is available only for the default strategy, while [empty] is for any |
| /// [Default]-constructible strategy (current or future one). |
| /// |
| /// [empty]: ArcSwapAny::empty |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use std::sync::Arc; |
| /// # use arc_swap::ArcSwapOption; |
| /// static GLOBAL_DATA: ArcSwapOption<usize> = ArcSwapOption::const_empty(); |
| /// |
| /// assert!(GLOBAL_DATA.load().is_none()); |
| /// GLOBAL_DATA.store(Some(Arc::new(42))); |
| /// assert_eq!(42, **GLOBAL_DATA.load().as_ref().unwrap()); |
| /// ``` |
| </span><span class="kw">pub const fn </span>const_empty() -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| ptr: AtomicPtr::new(ptr::null_mut()), |
| _phantom_arc: PhantomData, |
| strategy: HybridStrategy { |
| _config: DefaultConfig, |
| }, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// An atomic storage that doesn't share the internal generation locks with others. |
| /// |
| /// This makes it bigger and it also might suffer contention (on the HW level) if used from many |
| /// threads at once. On the other hand, it can't block writes in other instances. |
| /// |
| /// See the [`IndependentStrategy`] for further details. |
| </span><span class="comment">// Being phased out. Will deprecate once we verify in production that the new strategy works fine. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub type </span>IndependentArcSwap<T> = ArcSwapAny<Arc<T>, IndependentStrategy>; |
| |
| <span class="doccomment">/// Arc swap for the [Weak] pointer. |
| /// |
| /// This is similar to [ArcSwap], but it doesn't store [Arc], it stores [Weak]. It doesn't keep the |
| /// data alive when pointed to. |
| /// |
| /// This is a type alias only. Most of the methods are described on the |
| /// [`ArcSwapAny`](struct.ArcSwapAny.html). |
| /// |
| /// Needs the `weak` feature turned on. |
| /// |
| /// [Weak]: std::sync::Weak |
| </span><span class="attribute">#[cfg(feature = <span class="string">"weak"</span>)] |
| </span><span class="kw">pub type </span>ArcSwapWeak<T> = ArcSwapAny<std::sync::Weak<T>>; |
| |
| <span class="macro">macro_rules! </span>t { |
| (<span class="macro-nonterminal">$name</span>: ident, <span class="macro-nonterminal">$strategy</span>: ty) => { |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span><span class="macro-nonterminal">$name </span>{ |
| <span class="kw">use </span>std::panic; |
| <span class="kw">use </span>std::sync::atomic::{<span class="self">self</span>, AtomicUsize}; |
| |
| <span class="kw">use </span>adaptive_barrier::{Barrier, PanicMode}; |
| <span class="kw">use </span>crossbeam_utils::thread; |
| |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="kw">const </span>ITERATIONS: usize = <span class="number">10</span>; |
| |
| <span class="attribute">#[allow(deprecated)] </span><span class="comment">// We use "deprecated" testing strategies in here. |
| </span><span class="kw">type </span>As<T> = ArcSwapAny<Arc<T>, <span class="macro-nonterminal">$strategy</span>>; |
| <span class="attribute">#[allow(deprecated)] </span><span class="comment">// We use "deprecated" testing strategies in here. |
| </span><span class="kw">type </span>Aso<T> = ArcSwapAny<<span class="prelude-ty">Option</span><Arc<T>>, <span class="macro-nonterminal">$strategy</span>>; |
| |
| <span class="doccomment">/// Similar to the one in doc tests of the lib, but more times and more intensive (we |
| /// want to torture it a bit). |
| </span><span class="attribute">#[test] |
| #[cfg_attr(miri, ignore)] </span><span class="comment">// Takes like 1 or 2 infinities to run under miri |
| </span><span class="kw">fn </span>publish() { |
| <span class="kw">const </span>READERS: usize = <span class="number">2</span>; |
| <span class="kw">for _ in </span><span class="number">0</span>..ITERATIONS { |
| <span class="kw">let </span>config = As::<String>::default(); |
| <span class="kw">let </span>ended = AtomicUsize::new(<span class="number">0</span>); |
| thread::scope(|scope| { |
| <span class="kw">for _ in </span><span class="number">0</span>..READERS { |
| scope.spawn(|<span class="kw">_</span>| <span class="kw">loop </span>{ |
| <span class="kw">let </span>cfg = config.load_full(); |
| <span class="kw">if </span>!cfg.is_empty() { |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>cfg, <span class="string">"New configuration"</span>); |
| ended.fetch_add(<span class="number">1</span>, Ordering::Relaxed); |
| <span class="kw">return</span>; |
| } |
| atomic::spin_loop_hint(); |
| }); |
| } |
| scope.spawn(|<span class="kw">_</span>| { |
| <span class="kw">let </span>new_conf = Arc::new(<span class="string">"New configuration"</span>.to_owned()); |
| config.store(new_conf); |
| }); |
| }) |
| .unwrap(); |
| <span class="macro">assert_eq!</span>(READERS, ended.load(Ordering::Relaxed)); |
| <span class="kw">let </span>arc = config.load_full(); |
| <span class="macro">assert_eq!</span>(<span class="number">2</span>, Arc::strong_count(<span class="kw-2">&</span>arc)); |
| <span class="macro">assert_eq!</span>(<span class="number">0</span>, Arc::weak_count(<span class="kw-2">&</span>arc)); |
| } |
| } |
| |
| <span class="doccomment">/// Similar to the doc tests of ArcSwap, but happens more times. |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>swap_load() { |
| <span class="kw">for _ in </span><span class="number">0</span>..<span class="number">100 </span>{ |
| <span class="kw">let </span>arc = Arc::new(<span class="number">42</span>); |
| <span class="kw">let </span>arc_swap = As::from(Arc::clone(<span class="kw-2">&</span>arc)); |
| <span class="macro">assert_eq!</span>(<span class="number">42</span>, <span class="kw-2">**</span>arc_swap.load()); |
| <span class="comment">// It can be read multiple times |
| </span><span class="macro">assert_eq!</span>(<span class="number">42</span>, <span class="kw-2">**</span>arc_swap.load()); |
| |
| <span class="comment">// Put a new one in there |
| </span><span class="kw">let </span>new_arc = Arc::new(<span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">42</span>, <span class="kw-2">*</span>arc_swap.swap(Arc::clone(<span class="kw-2">&</span>new_arc))); |
| <span class="macro">assert_eq!</span>(<span class="number">0</span>, <span class="kw-2">**</span>arc_swap.load()); |
| <span class="comment">// One loaded here, one in the arc_swap, one in new_arc |
| </span><span class="kw">let </span>loaded = arc_swap.load_full(); |
| <span class="macro">assert_eq!</span>(<span class="number">3</span>, Arc::strong_count(<span class="kw-2">&</span>loaded)); |
| <span class="macro">assert_eq!</span>(<span class="number">0</span>, Arc::weak_count(<span class="kw-2">&</span>loaded)); |
| <span class="comment">// The original got released from the arc_swap |
| </span><span class="macro">assert_eq!</span>(<span class="number">1</span>, Arc::strong_count(<span class="kw-2">&</span>arc)); |
| <span class="macro">assert_eq!</span>(<span class="number">0</span>, Arc::weak_count(<span class="kw-2">&</span>arc)); |
| } |
| } |
| |
| <span class="doccomment">/// Two different writers publish two series of values. The readers check that it is |
| /// always increasing in each serie. |
| /// |
| /// For performance, we try to reuse the threads here. |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>multi_writers() { |
| <span class="kw">let </span>first_value = Arc::new((<span class="number">0</span>, <span class="number">0</span>)); |
| <span class="kw">let </span>shared = As::from(Arc::clone(<span class="kw-2">&</span>first_value)); |
| <span class="kw">const </span>WRITER_CNT: usize = <span class="number">2</span>; |
| <span class="kw">const </span>READER_CNT: usize = <span class="number">3</span>; |
| <span class="attribute">#[cfg(miri)] |
| </span><span class="kw">const </span>ITERATIONS: usize = <span class="number">5</span>; |
| <span class="attribute">#[cfg(not(miri))] |
| </span><span class="kw">const </span>ITERATIONS: usize = <span class="number">100</span>; |
| <span class="kw">const </span>SEQ: usize = <span class="number">50</span>; |
| <span class="kw">let </span>barrier = Barrier::new(PanicMode::Poison); |
| thread::scope(|scope| { |
| <span class="kw">for </span>w <span class="kw">in </span><span class="number">0</span>..WRITER_CNT { |
| <span class="comment">// We need to move w into the closure. But we want to just reference the |
| // other things. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>barrier = barrier.clone(); |
| <span class="kw">let </span>shared = <span class="kw-2">&</span>shared; |
| <span class="kw">let </span>first_value = <span class="kw-2">&</span>first_value; |
| scope.spawn(<span class="kw">move </span>|<span class="kw">_</span>| { |
| <span class="kw">for _ in </span><span class="number">0</span>..ITERATIONS { |
| barrier.wait(); |
| shared.store(Arc::clone(<span class="kw-2">&</span>first_value)); |
| barrier.wait(); |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..SEQ { |
| shared.store(Arc::new((w, i + <span class="number">1</span>))); |
| } |
| } |
| }); |
| } |
| <span class="kw">for _ in </span><span class="number">0</span>..READER_CNT { |
| <span class="kw">let </span><span class="kw-2">mut </span>barrier = barrier.clone(); |
| <span class="kw">let </span>shared = <span class="kw-2">&</span>shared; |
| <span class="kw">let </span>first_value = <span class="kw-2">&</span>first_value; |
| scope.spawn(<span class="kw">move </span>|<span class="kw">_</span>| { |
| <span class="kw">for _ in </span><span class="number">0</span>..ITERATIONS { |
| barrier.wait(); |
| barrier.wait(); |
| <span class="kw">let </span><span class="kw-2">mut </span>previous = [<span class="number">0</span>; WRITER_CNT]; |
| <span class="kw">let </span><span class="kw-2">mut </span>last = Arc::clone(<span class="kw-2">&</span>first_value); |
| <span class="kw">loop </span>{ |
| <span class="kw">let </span>cur = shared.load(); |
| <span class="kw">if </span>Arc::ptr_eq(<span class="kw-2">&</span>last, <span class="kw-2">&</span>cur) { |
| atomic::spin_loop_hint(); |
| <span class="kw">continue</span>; |
| } |
| <span class="kw">let </span>(w, s) = <span class="kw-2">**</span>cur; |
| <span class="macro">assert!</span>(previous[w] < s, <span class="string">"{:?} vs {:?}"</span>, previous, cur); |
| previous[w] = s; |
| last = Guard::into_inner(cur); |
| <span class="kw">if </span>s == SEQ { |
| <span class="kw">break</span>; |
| } |
| } |
| } |
| }); |
| } |
| |
| drop(barrier); |
| }) |
| .unwrap(); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>load_null() { |
| <span class="kw">let </span>shared = Aso::<usize>::default(); |
| <span class="kw">let </span>guard = shared.load(); |
| <span class="macro">assert!</span>(guard.is_none()); |
| shared.store(<span class="prelude-val">Some</span>(Arc::new(<span class="number">42</span>))); |
| <span class="macro">assert_eq!</span>(<span class="number">42</span>, <span class="kw-2">**</span>shared.load().as_ref().unwrap()); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>from_into() { |
| <span class="kw">let </span>a = Arc::new(<span class="number">42</span>); |
| <span class="kw">let </span>shared = As::new(a); |
| <span class="kw">let </span>guard = shared.load(); |
| <span class="kw">let </span>a = shared.into_inner(); |
| <span class="macro">assert_eq!</span>(<span class="number">42</span>, <span class="kw-2">*</span>a); |
| <span class="macro">assert_eq!</span>(<span class="number">2</span>, Arc::strong_count(<span class="kw-2">&</span>a)); |
| drop(guard); |
| <span class="macro">assert_eq!</span>(<span class="number">1</span>, Arc::strong_count(<span class="kw-2">&</span>a)); |
| } |
| |
| <span class="comment">// Note on the Relaxed order here. This should be enough, because there's that |
| // barrier.wait in between that should do the synchronization of happens-before for us. |
| // And using SeqCst would probably not help either, as there's nothing else with SeqCst |
| // here in this test to relate it to. |
| </span><span class="attribute">#[derive(Default)] |
| </span><span class="kw">struct </span>ReportDrop(Arc<AtomicUsize>); |
| <span class="kw">impl </span>Drop <span class="kw">for </span>ReportDrop { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.<span class="number">0</span>.fetch_add(<span class="number">1</span>, Ordering::Relaxed); |
| } |
| } |
| |
| <span class="doccomment">/// Interaction of two threads about a guard and dropping it. |
| /// |
| /// We make sure everything works in timely manner (eg. dropping of stuff) even if multiple |
| /// threads interact. |
| /// |
| /// The idea is: |
| /// * Thread 1 loads a value. |
| /// * Thread 2 replaces the shared value. The original value is not destroyed. |
| /// * Thread 1 drops the guard. The value is destroyed and this is observable in both threads. |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>guard_drop_in_thread() { |
| <span class="kw">for _ in </span><span class="number">0</span>..ITERATIONS { |
| <span class="kw">let </span>cnt = Arc::new(AtomicUsize::new(<span class="number">0</span>)); |
| |
| <span class="kw">let </span>shared = As::from_pointee(ReportDrop(cnt.clone())); |
| <span class="macro">assert_eq!</span>(cnt.load(Ordering::Relaxed), <span class="number">0</span>, <span class="string">"Dropped prematurely"</span>); |
| <span class="comment">// We need the threads to wait for each other at places. |
| </span><span class="kw">let </span>sync = Barrier::new(PanicMode::Poison); |
| |
| thread::scope(|scope| { |
| scope.spawn({ |
| <span class="kw">let </span>sync = sync.clone(); |
| |<span class="kw">_</span>| { |
| <span class="kw">let </span><span class="kw-2">mut </span>sync = sync; <span class="comment">// Move into the closure |
| </span><span class="kw">let </span>guard = shared.load(); |
| sync.wait(); |
| <span class="comment">// Thread 2 replaces the shared value. We wait for it to confirm. |
| </span>sync.wait(); |
| drop(guard); |
| <span class="macro">assert_eq!</span>(cnt.load(Ordering::Relaxed), <span class="number">1</span>, <span class="string">"Value not dropped"</span>); |
| <span class="comment">// Let thread 2 know we already dropped it. |
| </span>sync.wait(); |
| } |
| }); |
| |
| scope.spawn(|<span class="kw">_</span>| { |
| <span class="kw">let </span><span class="kw-2">mut </span>sync = sync; |
| <span class="comment">// Thread 1 loads, we wait for that |
| </span>sync.wait(); |
| shared.store(Default::default()); |
| <span class="macro">assert_eq!</span>( |
| cnt.load(Ordering::Relaxed), |
| <span class="number">0</span>, |
| <span class="string">"Dropped while still in use" |
| </span>); |
| <span class="comment">// Let thread 2 know we replaced it |
| </span>sync.wait(); |
| <span class="comment">// Thread 1 drops its guard. We wait for it to confirm. |
| </span>sync.wait(); |
| <span class="macro">assert_eq!</span>(cnt.load(Ordering::Relaxed), <span class="number">1</span>, <span class="string">"Value not dropped"</span>); |
| }); |
| }) |
| .unwrap(); |
| } |
| } |
| |
| <span class="doccomment">/// Check dropping a lease in a different thread than it was created doesn't cause any |
| /// problems. |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>guard_drop_in_another_thread() { |
| <span class="kw">for _ in </span><span class="number">0</span>..ITERATIONS { |
| <span class="kw">let </span>cnt = Arc::new(AtomicUsize::new(<span class="number">0</span>)); |
| <span class="kw">let </span>shared = As::from_pointee(ReportDrop(cnt.clone())); |
| <span class="macro">assert_eq!</span>(cnt.load(Ordering::Relaxed), <span class="number">0</span>, <span class="string">"Dropped prematurely"</span>); |
| <span class="kw">let </span>guard = shared.load(); |
| |
| drop(shared); |
| <span class="macro">assert_eq!</span>(cnt.load(Ordering::Relaxed), <span class="number">0</span>, <span class="string">"Dropped prematurely"</span>); |
| |
| thread::scope(|scope| { |
| scope.spawn(|<span class="kw">_</span>| { |
| drop(guard); |
| }); |
| }) |
| .unwrap(); |
| |
| <span class="macro">assert_eq!</span>(cnt.load(Ordering::Relaxed), <span class="number">1</span>, <span class="string">"Not dropped"</span>); |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>load_option() { |
| <span class="kw">let </span>shared = Aso::from_pointee(<span class="number">42</span>); |
| <span class="comment">// The type here is not needed in real code, it's just addition test the type matches. |
| </span><span class="kw">let </span>opt: <span class="prelude-ty">Option</span><<span class="kw">_</span>> = Guard::into_inner(shared.load()); |
| <span class="macro">assert_eq!</span>(<span class="number">42</span>, <span class="kw-2">*</span>opt.unwrap()); |
| |
| shared.store(<span class="prelude-val">None</span>); |
| <span class="macro">assert!</span>(shared.load().is_none()); |
| } |
| |
| <span class="comment">// Check stuff can get formatted |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>debug_impl() { |
| <span class="kw">let </span>shared = As::from_pointee(<span class="number">42</span>); |
| <span class="macro">assert_eq!</span>(<span class="string">"ArcSwapAny(42)"</span>, <span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"{:?}"</span>, shared)); |
| <span class="macro">assert_eq!</span>(<span class="string">"42"</span>, <span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"{:?}"</span>, shared.load())); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>display_impl() { |
| <span class="kw">let </span>shared = As::from_pointee(<span class="number">42</span>); |
| <span class="macro">assert_eq!</span>(<span class="string">"42"</span>, <span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"{}"</span>, shared)); |
| <span class="macro">assert_eq!</span>(<span class="string">"42"</span>, <span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"{}"</span>, shared.load())); |
| } |
| |
| <span class="comment">// The following "tests" are not run, only compiled. They check that things that should be |
| // Send/Sync actually are. |
| </span><span class="kw">fn </span>_check_stuff_is_send_sync() { |
| <span class="kw">let </span>shared = As::from_pointee(<span class="number">42</span>); |
| <span class="kw">let </span>moved = As::from_pointee(<span class="number">42</span>); |
| <span class="kw">let </span>shared_ref = <span class="kw-2">&</span>shared; |
| <span class="kw">let </span>lease = shared.load(); |
| <span class="kw">let </span>lease_ref = <span class="kw-2">&</span>lease; |
| <span class="kw">let </span>lease = shared.load(); |
| thread::scope(|s| { |
| s.spawn(<span class="kw">move </span>|<span class="kw">_</span>| { |
| <span class="kw">let _ </span>= lease; |
| <span class="kw">let _ </span>= lease_ref; |
| <span class="kw">let _ </span>= shared_ref; |
| <span class="kw">let _ </span>= moved; |
| }); |
| }) |
| .unwrap(); |
| } |
| |
| <span class="doccomment">/// We have a callback in RCU. Check what happens if we access the value from within. |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>recursive() { |
| <span class="kw">let </span>shared = ArcSwap::from(Arc::new(<span class="number">0</span>)); |
| |
| shared.rcu(|i| { |
| <span class="kw">if </span><span class="kw-2">**</span>i < <span class="number">10 </span>{ |
| shared.rcu(|i| <span class="kw-2">**</span>i + <span class="number">1</span>); |
| } |
| <span class="kw-2">**</span>i |
| }); |
| <span class="macro">assert_eq!</span>(<span class="number">10</span>, <span class="kw-2">**</span>shared.load()); |
| <span class="macro">assert_eq!</span>(<span class="number">2</span>, Arc::strong_count(<span class="kw-2">&</span>shared.load_full())); |
| } |
| |
| <span class="doccomment">/// A panic from within the rcu callback should not change anything. |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>rcu_panic() { |
| <span class="kw">let </span>shared = ArcSwap::from(Arc::new(<span class="number">0</span>)); |
| <span class="macro">assert!</span>(panic::catch_unwind(|| shared.rcu(|<span class="kw">_</span>| -> usize { <span class="macro">panic!</span>() })).is_err()); |
| <span class="macro">assert_eq!</span>(<span class="number">1</span>, Arc::strong_count(<span class="kw-2">&</span>shared.swap(Arc::new(<span class="number">42</span>)))); |
| } |
| |
| <span class="doccomment">/// Handling null/none values |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>nulls() { |
| <span class="kw">let </span>shared = ArcSwapOption::from(<span class="prelude-val">Some</span>(Arc::new(<span class="number">0</span>))); |
| <span class="kw">let </span>orig = shared.swap(<span class="prelude-val">None</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1</span>, Arc::strong_count(<span class="kw-2">&</span>orig.unwrap())); |
| <span class="kw">let </span>null = shared.load(); |
| <span class="macro">assert!</span>(null.is_none()); |
| <span class="kw">let </span>a = Arc::new(<span class="number">42</span>); |
| <span class="kw">let </span>orig = shared.compare_and_swap(ptr::null(), <span class="prelude-val">Some</span>(Arc::clone(<span class="kw-2">&</span>a))); |
| <span class="macro">assert!</span>(orig.is_none()); |
| <span class="macro">assert_eq!</span>(<span class="number">2</span>, Arc::strong_count(<span class="kw-2">&</span>a)); |
| <span class="kw">let </span>orig = Guard::into_inner(shared.compare_and_swap(<span class="kw-2">&</span><span class="prelude-val">None</span>::<Arc<<span class="kw">_</span>>>, <span class="prelude-val">None</span>)); |
| <span class="macro">assert_eq!</span>(<span class="number">3</span>, Arc::strong_count(<span class="kw-2">&</span>a)); |
| <span class="macro">assert!</span>(ptr_eq(<span class="kw-2">&</span>a, <span class="kw-2">&</span>orig)); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="doccomment">/// Multiple RCUs interacting. |
| </span><span class="kw">fn </span>rcu() { |
| <span class="kw">const </span>ITERATIONS: usize = <span class="number">50</span>; |
| <span class="kw">const </span>THREADS: usize = <span class="number">10</span>; |
| <span class="kw">let </span>shared = ArcSwap::from(Arc::new(<span class="number">0</span>)); |
| thread::scope(|scope| { |
| <span class="kw">for _ in </span><span class="number">0</span>..THREADS { |
| scope.spawn(|<span class="kw">_</span>| { |
| <span class="kw">for _ in </span><span class="number">0</span>..ITERATIONS { |
| shared.rcu(|old| <span class="kw-2">**</span>old + <span class="number">1</span>); |
| } |
| }); |
| } |
| }) |
| .unwrap(); |
| <span class="macro">assert_eq!</span>(THREADS * ITERATIONS, <span class="kw-2">**</span>shared.load()); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="doccomment">/// Make sure the reference count and compare_and_swap works as expected. |
| </span><span class="kw">fn </span>cas_ref_cnt() { |
| <span class="attribute">#[cfg(miri)] |
| </span><span class="kw">const </span>ITERATIONS: usize = <span class="number">10</span>; |
| <span class="attribute">#[cfg(not(miri))] |
| </span><span class="kw">const </span>ITERATIONS: usize = <span class="number">50</span>; |
| <span class="kw">let </span>shared = ArcSwap::from(Arc::new(<span class="number">0</span>)); |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..ITERATIONS { |
| <span class="kw">let </span>orig = shared.load_full(); |
| <span class="macro">assert_eq!</span>(i, <span class="kw-2">*</span>orig); |
| <span class="kw">if </span>i % <span class="number">2 </span>== <span class="number">1 </span>{ |
| <span class="comment">// One for orig, one for shared |
| </span><span class="macro">assert_eq!</span>(<span class="number">2</span>, Arc::strong_count(<span class="kw-2">&</span>orig)); |
| } |
| <span class="kw">let </span>n1 = Arc::new(i + <span class="number">1</span>); |
| <span class="comment">// Fill up the slots sometimes |
| </span><span class="kw">let </span>fillup = || { |
| <span class="kw">if </span>i % <span class="number">2 </span>== <span class="number">0 </span>{ |
| <span class="prelude-val">Some</span>((<span class="number">0</span>..ITERATIONS).map(|<span class="kw">_</span>| shared.load()).collect::<Vec<<span class="kw">_</span>>>()) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">None |
| </span>} |
| }; |
| <span class="kw">let </span>guards = fillup(); |
| <span class="comment">// Success |
| </span><span class="kw">let </span>prev = shared.compare_and_swap(<span class="kw-2">&</span>orig, Arc::clone(<span class="kw-2">&</span>n1)); |
| <span class="macro">assert!</span>(ptr_eq(<span class="kw-2">&</span>orig, <span class="kw-2">&</span>prev)); |
| drop(guards); |
| <span class="comment">// One for orig, one for prev |
| </span><span class="macro">assert_eq!</span>(<span class="number">2</span>, Arc::strong_count(<span class="kw-2">&</span>orig)); |
| <span class="comment">// One for n1, one for shared |
| </span><span class="macro">assert_eq!</span>(<span class="number">2</span>, Arc::strong_count(<span class="kw-2">&</span>n1)); |
| <span class="macro">assert_eq!</span>(i + <span class="number">1</span>, <span class="kw-2">**</span>shared.load()); |
| <span class="kw">let </span>n2 = Arc::new(i); |
| drop(prev); |
| <span class="kw">let </span>guards = fillup(); |
| <span class="comment">// Failure |
| </span><span class="kw">let </span>prev = Guard::into_inner(shared.compare_and_swap(<span class="kw-2">&</span>orig, Arc::clone(<span class="kw-2">&</span>n2))); |
| drop(guards); |
| <span class="macro">assert!</span>(ptr_eq(<span class="kw-2">&</span>n1, <span class="kw-2">&</span>prev)); |
| <span class="comment">// One for orig |
| </span><span class="macro">assert_eq!</span>(<span class="number">1</span>, Arc::strong_count(<span class="kw-2">&</span>orig)); |
| <span class="comment">// One for n1, one for shared, one for prev |
| </span><span class="macro">assert_eq!</span>(<span class="number">3</span>, Arc::strong_count(<span class="kw-2">&</span>n1)); |
| <span class="comment">// n2 didn't get increased |
| </span><span class="macro">assert_eq!</span>(<span class="number">1</span>, Arc::strong_count(<span class="kw-2">&</span>n2)); |
| <span class="macro">assert_eq!</span>(i + <span class="number">1</span>, <span class="kw-2">**</span>shared.load()); |
| } |
| |
| <span class="kw">let </span>a = shared.load_full(); |
| <span class="comment">// One inside shared, one for a |
| </span><span class="macro">assert_eq!</span>(<span class="number">2</span>, Arc::strong_count(<span class="kw-2">&</span>a)); |
| drop(shared); |
| <span class="comment">// Only a now |
| </span><span class="macro">assert_eq!</span>(<span class="number">1</span>, Arc::strong_count(<span class="kw-2">&</span>a)); |
| } |
| } |
| }; |
| } |
| |
| <span class="macro">t!</span>(tests_default, DefaultStrategy); |
| <span class="attribute">#[cfg(all(feature = <span class="string">"internal-test-strategies"</span>, test))] |
| #[allow(deprecated)] |
| </span><span class="kw">mod </span>internal_strategies { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| <span class="macro">t!</span>( |
| tests_full_slots, |
| <span class="kw">crate</span>::strategy::test_strategies::FillFastSlots |
| ); |
| } |
| |
| <span class="doccomment">/// These tests assume details about the used strategy. |
| </span><span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="doccomment">/// Accessing the value inside ArcSwap with Guards (and checks for the reference |
| /// counts). |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>load_cnt() { |
| <span class="kw">let </span>a = Arc::new(<span class="number">0</span>); |
| <span class="kw">let </span>shared = ArcSwap::from(Arc::clone(<span class="kw-2">&</span>a)); |
| <span class="comment">// One in shared, one in a |
| </span><span class="macro">assert_eq!</span>(<span class="number">2</span>, Arc::strong_count(<span class="kw-2">&</span>a)); |
| <span class="kw">let </span>guard = shared.load(); |
| <span class="macro">assert_eq!</span>(<span class="number">0</span>, <span class="kw-2">**</span>guard); |
| <span class="comment">// The guard doesn't have its own ref count now |
| </span><span class="macro">assert_eq!</span>(<span class="number">2</span>, Arc::strong_count(<span class="kw-2">&</span>a)); |
| <span class="kw">let </span>guard_2 = shared.load(); |
| <span class="comment">// Unlike with guard, this does not deadlock |
| </span>shared.store(Arc::new(<span class="number">1</span>)); |
| <span class="comment">// But now, each guard got a full Arc inside it |
| </span><span class="macro">assert_eq!</span>(<span class="number">3</span>, Arc::strong_count(<span class="kw-2">&</span>a)); |
| <span class="comment">// And when we get rid of them, they disappear |
| </span>drop(guard_2); |
| <span class="macro">assert_eq!</span>(<span class="number">2</span>, Arc::strong_count(<span class="kw-2">&</span>a)); |
| <span class="kw">let </span>_b = Arc::clone(<span class="kw-2">&</span>guard); |
| <span class="macro">assert_eq!</span>(<span class="number">3</span>, Arc::strong_count(<span class="kw-2">&</span>a)); |
| <span class="comment">// We can drop the guard it came from |
| </span>drop(guard); |
| <span class="macro">assert_eq!</span>(<span class="number">2</span>, Arc::strong_count(<span class="kw-2">&</span>a)); |
| <span class="kw">let </span>guard = shared.load(); |
| <span class="macro">assert_eq!</span>(<span class="number">1</span>, <span class="kw-2">**</span>guard); |
| drop(shared); |
| <span class="comment">// We can still use the guard after the shared disappears |
| </span><span class="macro">assert_eq!</span>(<span class="number">1</span>, <span class="kw-2">**</span>guard); |
| <span class="kw">let </span>ptr = Arc::clone(<span class="kw-2">&</span>guard); |
| <span class="comment">// One in shared, one in guard |
| </span><span class="macro">assert_eq!</span>(<span class="number">2</span>, Arc::strong_count(<span class="kw-2">&</span>ptr)); |
| drop(guard); |
| <span class="macro">assert_eq!</span>(<span class="number">1</span>, Arc::strong_count(<span class="kw-2">&</span>ptr)); |
| } |
| |
| <span class="doccomment">/// There can be only limited amount of leases on one thread. Following ones are |
| /// created, but contain full Arcs. |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>lease_overflow() { |
| <span class="attribute">#[cfg(miri)] |
| </span><span class="kw">const </span>GUARD_COUNT: usize = <span class="number">100</span>; |
| <span class="attribute">#[cfg(not(miri))] |
| </span><span class="kw">const </span>GUARD_COUNT: usize = <span class="number">1000</span>; |
| <span class="kw">let </span>a = Arc::new(<span class="number">0</span>); |
| <span class="kw">let </span>shared = ArcSwap::from(Arc::clone(<span class="kw-2">&</span>a)); |
| <span class="macro">assert_eq!</span>(<span class="number">2</span>, Arc::strong_count(<span class="kw-2">&</span>a)); |
| <span class="kw">let </span><span class="kw-2">mut </span>guards = (<span class="number">0</span>..GUARD_COUNT).map(|<span class="kw">_</span>| shared.load()).collect::<Vec<<span class="kw">_</span>>>(); |
| <span class="kw">let </span>count = Arc::strong_count(<span class="kw-2">&</span>a); |
| <span class="macro">assert!</span>(count > <span class="number">2</span>); |
| <span class="kw">let </span>guard = shared.load(); |
| <span class="macro">assert_eq!</span>(count + <span class="number">1</span>, Arc::strong_count(<span class="kw-2">&</span>a)); |
| drop(guard); |
| <span class="macro">assert_eq!</span>(count, Arc::strong_count(<span class="kw-2">&</span>a)); |
| <span class="comment">// When we delete the first one, it didn't have an Arc in it, so the ref count |
| // doesn't drop |
| </span>guards.swap_remove(<span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(count, Arc::strong_count(<span class="kw-2">&</span>a)); |
| <span class="comment">// But new one reuses now vacant the slot and doesn't create a new Arc |
| </span><span class="kw">let </span>_guard = shared.load(); |
| <span class="macro">assert_eq!</span>(count, Arc::strong_count(<span class="kw-2">&</span>a)); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="arc_swap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |