| <!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/cache.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>cache.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> |
| </pre><pre class="rust"><code><span class="attribute">#![deny(unsafe_code)] |
| |
| </span><span class="doccomment">//! Caching handle into the [ArcSwapAny]. |
| //! |
| //! The [Cache] keeps a copy of the internal [Arc] for faster access. |
| //! |
| //! [Arc]: std::sync::Arc |
| |
| </span><span class="kw">use </span>std::ops::Deref; |
| <span class="kw">use </span>std::sync::atomic::Ordering; |
| |
| <span class="kw">use </span><span class="kw">super</span>::ref_cnt::RefCnt; |
| <span class="kw">use </span><span class="kw">super</span>::strategy::Strategy; |
| <span class="kw">use </span><span class="kw">super</span>::ArcSwapAny; |
| |
| <span class="doccomment">/// Generalization of caches providing access to `T`. |
| /// |
| /// This abstracts over all kinds of caches that can provide a cheap access to values of type `T`. |
| /// This is useful in cases where some code doesn't care if the `T` is the whole structure or just |
| /// a part of it. |
| /// |
| /// See the example at [`Cache::map`]. |
| </span><span class="kw">pub trait </span>Access<T> { |
| <span class="doccomment">/// Loads the value from cache. |
| /// |
| /// This revalidates the value in the cache, then provides the access to the cached value. |
| </span><span class="kw">fn </span>load(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&</span>T; |
| } |
| |
| <span class="doccomment">/// Caching handle for [`ArcSwapAny`][ArcSwapAny]. |
| /// |
| /// Instead of loading the [`Arc`][Arc] on every request from the shared storage, this keeps |
| /// another copy inside itself. Upon request it only cheaply revalidates it is up to |
| /// date. If it is, access is significantly faster. If it is stale, the [load_full] is done and the |
| /// cache value is replaced. Under a read-heavy loads, the measured speedup are 10-25 times, |
| /// depending on the architecture. |
| /// |
| /// There are, however, downsides: |
| /// |
| /// * The handle needs to be kept around by the caller (usually, one per thread). This is fine if |
| /// there's one global `ArcSwapAny`, but starts being tricky with eg. data structures build from |
| /// them. |
| /// * As it keeps a copy of the [Arc] inside the cache, the old value may be kept alive for longer |
| /// period of time ‒ it is replaced by the new value on [load][Cache::load]. You may not want to |
| /// use this if dropping the old value in timely manner is important (possibly because of |
| /// releasing large amount of RAM or because of closing file handles). |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # fn do_something<V>(_v: V) { } |
| /// use std::sync::Arc; |
| /// use std::sync::atomic::{AtomicBool, Ordering}; |
| /// |
| /// use arc_swap::{ArcSwap, Cache}; |
| /// |
| /// let shared = Arc::new(ArcSwap::from_pointee(42)); |
| /// # let mut threads = Vec::new(); |
| /// let terminate = Arc::new(AtomicBool::new(false)); |
| /// // Start 10 worker threads... |
| /// for _ in 0..10 { |
| /// let mut cache = Cache::new(Arc::clone(&shared)); |
| /// let terminate = Arc::clone(&terminate); |
| /// # let thread = |
| /// std::thread::spawn(move || { |
| /// // Keep loading it like mad.. |
| /// while !terminate.load(Ordering::Relaxed) { |
| /// let value = cache.load(); |
| /// do_something(value); |
| /// } |
| /// }); |
| /// # threads.push(thread); |
| /// } |
| /// shared.store(Arc::new(12)); |
| /// # terminate.store(true, Ordering::Relaxed); |
| /// # for thread in threads { thread.join().unwrap() } |
| /// ``` |
| /// |
| /// Another one with using a thread local storage and explicit types: |
| /// |
| /// ```rust |
| /// # use std::sync::Arc; |
| /// # use std::ops::Deref; |
| /// # use std::cell::RefCell; |
| /// # |
| /// # use arc_swap::ArcSwap; |
| /// # use arc_swap::cache::Cache; |
| /// # use once_cell::sync::Lazy; |
| /// # |
| /// # #[derive(Debug, Default)] |
| /// # struct Config; |
| /// # |
| /// static CURRENT_CONFIG: Lazy<ArcSwap<Config>> = Lazy::new(|| ArcSwap::from_pointee(Config::default())); |
| /// |
| /// thread_local! { |
| /// static CACHE: RefCell<Cache<&'static ArcSwap<Config>, Arc<Config>>> = RefCell::new(Cache::from(CURRENT_CONFIG.deref())); |
| /// } |
| /// |
| /// CACHE.with(|c| { |
| /// // * RefCell needed, because load on cache is `&mut`. |
| /// // * You want to operate inside the `with` ‒ cloning the Arc is comparably expensive as |
| /// // ArcSwap::load itself and whatever you'd save by the cache would be lost on that. |
| /// println!("{:?}", c.borrow_mut().load()); |
| /// }); |
| /// ``` |
| /// |
| /// [Arc]: std::sync::Arc |
| /// [load_full]: ArcSwapAny::load_full |
| </span><span class="attribute">#[derive(Clone, Debug)] |
| </span><span class="kw">pub struct </span>Cache<A, T> { |
| arc_swap: A, |
| cached: T, |
| } |
| |
| <span class="kw">impl</span><A, T, S> Cache<A, T> |
| <span class="kw">where |
| </span>A: Deref<Target = ArcSwapAny<T, S>>, |
| T: RefCnt, |
| S: Strategy<T>, |
| { |
| <span class="doccomment">/// Creates a new caching handle. |
| /// |
| /// The parameter is something dereferencing into an [`ArcSwapAny`] (eg. either to [`ArcSwap`] |
| /// or [`ArcSwapOption`]). That can be [`ArcSwapAny`] itself, but that's not very useful. But |
| /// it also can be a reference to it or `Arc`, which makes it possible to share the |
| /// [`ArcSwapAny`] with multiple caches or access it in non-cached way too. |
| /// |
| /// [`ArcSwapOption`]: crate::ArcSwapOption |
| /// [`ArcSwap`]: crate::ArcSwap |
| </span><span class="kw">pub fn </span>new(arc_swap: A) -> <span class="self">Self </span>{ |
| <span class="kw">let </span>cached = arc_swap.load_full(); |
| <span class="self">Self </span>{ arc_swap, cached } |
| } |
| |
| <span class="doccomment">/// Gives access to the (possibly shared) cached [`ArcSwapAny`]. |
| </span><span class="kw">pub fn </span>arc_swap(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>A::Target { |
| <span class="kw-2">&</span><span class="self">self</span>.arc_swap |
| } |
| |
| <span class="doccomment">/// Loads the currently held value. |
| /// |
| /// This first checks if the cached value is up to date. This check is very cheap. |
| /// |
| /// If it is up to date, the cached value is simply returned without additional costs. If it is |
| /// outdated, a load is done on the underlying shared storage. The newly loaded value is then |
| /// stored in the cache and returned. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>load(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&</span>T { |
| <span class="self">self</span>.revalidate(); |
| <span class="self">self</span>.load_no_revalidate() |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>load_no_revalidate(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>T { |
| <span class="kw-2">&</span><span class="self">self</span>.cached |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>revalidate(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="kw">let </span>cached_ptr = RefCnt::as_ptr(<span class="kw-2">&</span><span class="self">self</span>.cached); |
| <span class="comment">// Node: Relaxed here is fine. We do not synchronize any data through this, we already have |
| // it synchronized in self.cache. We just want to check if it changed, if it did, the |
| // load_full will be responsible for any synchronization needed. |
| </span><span class="kw">let </span>shared_ptr = <span class="self">self</span>.arc_swap.ptr.load(Ordering::Relaxed); |
| <span class="kw">if </span>cached_ptr != shared_ptr { |
| <span class="self">self</span>.cached = <span class="self">self</span>.arc_swap.load_full(); |
| } |
| } |
| |
| <span class="doccomment">/// Turns this cache into a cache with a projection inside the cached value. |
| /// |
| /// You'd use this in case when some part of code needs access to fresh values of `U`, however |
| /// a bigger structure containing `U` is provided by this cache. The possibility of giving the |
| /// whole structure to the part of the code falls short in terms of reusability (the part of |
| /// the code could be used within multiple contexts, each with a bigger different structure |
| /// containing `U`) and code separation (the code shouldn't needs to know about the big |
| /// structure). |
| /// |
| /// # Warning |
| /// |
| /// As the provided `f` is called inside every [`load`][Access::load], this one should be |
| /// cheap. Most often it is expected to be just a closure taking reference of some inner field. |
| /// |
| /// For the same reasons, it should not have side effects and should never panic (these will |
| /// not break Rust's safety rules, but might produce behaviour you don't expect). |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// use arc_swap::ArcSwap; |
| /// use arc_swap::cache::{Access, Cache}; |
| /// |
| /// struct InnerCfg { |
| /// answer: usize, |
| /// } |
| /// |
| /// struct FullCfg { |
| /// inner: InnerCfg, |
| /// } |
| /// |
| /// fn use_inner<A: Access<InnerCfg>>(cache: &mut A) { |
| /// let value = cache.load(); |
| /// println!("The answer is: {}", value.answer); |
| /// } |
| /// |
| /// let full_cfg = ArcSwap::from_pointee(FullCfg { |
| /// inner: InnerCfg { |
| /// answer: 42, |
| /// } |
| /// }); |
| /// let cache = Cache::new(&full_cfg); |
| /// use_inner(&mut cache.map(|full| &full.inner)); |
| /// |
| /// let inner_cfg = ArcSwap::from_pointee(InnerCfg { answer: 24 }); |
| /// let mut inner_cache = Cache::new(&inner_cfg); |
| /// use_inner(&mut inner_cache); |
| /// ``` |
| </span><span class="kw">pub fn </span>map<F, U>(<span class="self">self</span>, f: F) -> MapCache<A, T, F> |
| <span class="kw">where |
| </span>F: FnMut(<span class="kw-2">&</span>T) -> <span class="kw-2">&</span>U, |
| { |
| MapCache { |
| inner: <span class="self">self</span>, |
| projection: f, |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><A, T, S> Access<T::Target> <span class="kw">for </span>Cache<A, T> |
| <span class="kw">where |
| </span>A: Deref<Target = ArcSwapAny<T, S>>, |
| T: Deref<Target = <T <span class="kw">as </span>RefCnt>::Base> + RefCnt, |
| S: Strategy<T>, |
| { |
| <span class="kw">fn </span>load(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&</span>T::Target { |
| <span class="self">self</span>.load().deref() |
| } |
| } |
| |
| <span class="kw">impl</span><A, T, S> From<A> <span class="kw">for </span>Cache<A, T> |
| <span class="kw">where |
| </span>A: Deref<Target = ArcSwapAny<T, S>>, |
| T: RefCnt, |
| S: Strategy<T>, |
| { |
| <span class="kw">fn </span>from(arc_swap: A) -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::new(arc_swap) |
| } |
| } |
| |
| <span class="doccomment">/// An implementation of a cache with a projection into the accessed value. |
| /// |
| /// This is the implementation structure for [`Cache::map`]. It can't be created directly and it |
| /// should be used through the [`Access`] trait. |
| </span><span class="attribute">#[derive(Clone, Debug)] |
| </span><span class="kw">pub struct </span>MapCache<A, T, F> { |
| inner: Cache<A, T>, |
| projection: F, |
| } |
| |
| <span class="kw">impl</span><A, T, S, F, U> Access<U> <span class="kw">for </span>MapCache<A, T, F> |
| <span class="kw">where |
| </span>A: Deref<Target = ArcSwapAny<T, S>>, |
| T: RefCnt, |
| S: Strategy<T>, |
| F: FnMut(<span class="kw-2">&</span>T) -> <span class="kw-2">&</span>U, |
| { |
| <span class="kw">fn </span>load(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&</span>U { |
| (<span class="self">self</span>.projection)(<span class="self">self</span>.inner.load()) |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span>std::sync::Arc; |
| |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| <span class="kw">use crate</span>::{ArcSwap, ArcSwapOption}; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>cached_value() { |
| <span class="kw">let </span>a = ArcSwap::from_pointee(<span class="number">42</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>c1 = Cache::new(<span class="kw-2">&</span>a); |
| <span class="kw">let </span><span class="kw-2">mut </span>c2 = Cache::new(<span class="kw-2">&</span>a); |
| |
| <span class="macro">assert_eq!</span>(<span class="number">42</span>, <span class="kw-2">**</span>c1.load()); |
| <span class="macro">assert_eq!</span>(<span class="number">42</span>, <span class="kw-2">**</span>c2.load()); |
| |
| a.store(Arc::new(<span class="number">43</span>)); |
| <span class="macro">assert_eq!</span>(<span class="number">42</span>, <span class="kw-2">**</span>c1.load_no_revalidate()); |
| <span class="macro">assert_eq!</span>(<span class="number">43</span>, <span class="kw-2">**</span>c1.load()); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>cached_through_arc() { |
| <span class="kw">let </span>a = Arc::new(ArcSwap::from_pointee(<span class="number">42</span>)); |
| <span class="kw">let </span><span class="kw-2">mut </span>c = Cache::new(Arc::clone(<span class="kw-2">&</span>a)); |
| <span class="macro">assert_eq!</span>(<span class="number">42</span>, <span class="kw-2">**</span>c.load()); |
| a.store(Arc::new(<span class="number">0</span>)); |
| drop(a); <span class="comment">// A is just one handle, the ArcSwap is kept alive by the cache. |
| </span>} |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>cache_option() { |
| <span class="kw">let </span>a = ArcSwapOption::from_pointee(<span class="number">42</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>c = Cache::new(<span class="kw-2">&</span>a); |
| |
| <span class="macro">assert_eq!</span>(<span class="number">42</span>, <span class="kw-2">**</span>c.load().as_ref().unwrap()); |
| a.store(<span class="prelude-val">None</span>); |
| <span class="macro">assert!</span>(c.load().is_none()); |
| } |
| |
| <span class="kw">struct </span>Inner { |
| answer: usize, |
| } |
| |
| <span class="kw">struct </span>Outer { |
| inner: Inner, |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>map_cache() { |
| <span class="kw">let </span>a = ArcSwap::from_pointee(Outer { |
| inner: Inner { answer: <span class="number">42 </span>}, |
| }); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>cache = Cache::new(<span class="kw-2">&</span>a); |
| <span class="kw">let </span><span class="kw-2">mut </span>inner = cache.clone().map(|outer| <span class="kw-2">&</span>outer.inner); |
| <span class="kw">let </span><span class="kw-2">mut </span>answer = cache.clone().map(|outer| <span class="kw-2">&</span>outer.inner.answer); |
| |
| <span class="macro">assert_eq!</span>(<span class="number">42</span>, cache.load().inner.answer); |
| <span class="macro">assert_eq!</span>(<span class="number">42</span>, inner.load().answer); |
| <span class="macro">assert_eq!</span>(<span class="number">42</span>, <span class="kw-2">*</span>answer.load()); |
| |
| a.store(Arc::new(Outer { |
| inner: Inner { answer: <span class="number">24 </span>}, |
| })); |
| |
| <span class="macro">assert_eq!</span>(<span class="number">24</span>, cache.load().inner.answer); |
| <span class="macro">assert_eq!</span>(<span class="number">24</span>, inner.load().answer); |
| <span class="macro">assert_eq!</span>(<span class="number">24</span>, <span class="kw-2">*</span>answer.load()); |
| } |
| } |
| </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> |