<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/sangenya/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-epoch-0.9.5/src/default.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>default.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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"><div class="sidebar-menu" role="button">☰</div><a href='../../crossbeam_epoch/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><div class="example-wrap"><pre class="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>
</pre><pre class="rust">
<span class="doccomment">//! The default garbage collector.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! For each thread, a participant is lazily initialized on its first use, when the current thread</span>
<span class="doccomment">//! is registered in the default collector. If initialized, the thread's participant will get</span>
<span class="doccomment">//! destructed on thread exit, which in turn unregisters the thread.</span>
<span class="kw">use</span> <span class="kw">crate</span><span class="ident">::collector</span>::{<span class="ident">Collector</span>, <span class="ident">LocalHandle</span>};
<span class="kw">use</span> <span class="kw">crate</span><span class="ident">::guard::Guard</span>;
<span class="kw">use</span> <span class="kw">crate</span><span class="ident">::primitive</span>::{<span class="ident">lazy_static</span>, <span class="ident">thread_local</span>};
<span class="macro">lazy_static!</span> {
<span class="doccomment">/// The global data for the default garbage collector.</span>
<span class="kw">static</span> <span class="kw-2">ref</span> <span class="ident">COLLECTOR</span>: <span class="ident">Collector</span> <span class="op">=</span> <span class="ident">Collector::new</span>();
}
<span class="macro">thread_local!</span> {
<span class="doccomment">/// The per-thread participant for the default garbage collector.</span>
<span class="kw">static</span> <span class="ident">HANDLE</span>: <span class="ident">LocalHandle</span> <span class="op">=</span> <span class="ident">COLLECTOR</span>.<span class="ident">register</span>();
}
<span class="doccomment">/// Pins the current thread.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">pin</span>() <span class="op">-</span><span class="op">></span> <span class="ident">Guard</span> {
<span class="ident">with_handle</span>(<span class="op">|</span><span class="ident">handle</span><span class="op">|</span> <span class="ident">handle</span>.<span class="ident">pin</span>())
}
<span class="doccomment">/// Returns `true` if the current thread is pinned.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_pinned</span>() <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="ident">with_handle</span>(<span class="op">|</span><span class="ident">handle</span><span class="op">|</span> <span class="ident">handle</span>.<span class="ident">is_pinned</span>())
}
<span class="doccomment">/// Returns the default global collector.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">default_collector</span>() <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">Collector</span> {
<span class="kw-2">&</span><span class="ident">COLLECTOR</span>
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">with_handle</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">R</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-</span><span class="op">></span> <span class="ident">R</span>
<span class="kw">where</span>
<span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="kw-2">&</span><span class="ident">LocalHandle</span>) <span class="op">-</span><span class="op">></span> <span class="ident">R</span>,
{
<span class="ident">HANDLE</span>
.<span class="ident">try_with</span>(<span class="op">|</span><span class="ident">h</span><span class="op">|</span> <span class="ident">f</span>(<span class="ident">h</span>))
.<span class="ident">unwrap_or_else</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">f</span>(<span class="kw-2">&</span><span class="ident">COLLECTOR</span>.<span class="ident">register</span>()))
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">test</span>, <span class="ident">not</span>(<span class="ident">crossbeam_loom</span>)))]</span>
<span class="kw">mod</span> <span class="ident">tests</span> {
<span class="kw">use</span> <span class="ident">crossbeam_utils::thread</span>;
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">pin_while_exiting</span>() {
<span class="kw">struct</span> <span class="ident">Foo</span>;
<span class="kw">impl</span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">Foo</span> {
<span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) {
<span class="comment">// Pin after `HANDLE` has been dropped. This must not panic.</span>
<span class="kw">super</span><span class="ident">::pin</span>();
}
}
<span class="macro">thread_local!</span> {
<span class="kw">static</span> <span class="ident">FOO</span>: <span class="ident">Foo</span> <span class="op">=</span> <span class="ident">Foo</span>;
}
<span class="ident">thread::scope</span>(<span class="op">|</span><span class="ident">scope</span><span class="op">|</span> {
<span class="ident">scope</span>.<span class="ident">spawn</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> {
<span class="comment">// Initialize `FOO` and then `HANDLE`.</span>
<span class="ident">FOO</span>.<span class="ident">with</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> ());
<span class="kw">super</span><span class="ident">::pin</span>();
<span class="comment">// At thread exit, `HANDLE` gets dropped first and `FOO` second.</span>
});
})
.<span class="ident">unwrap</span>();
}
}
</pre></div>
</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="crossbeam_epoch" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>