| <!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/inventory-0.1.11/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="../../inventory/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="../../inventory/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> |
| </pre><pre class="rust"><code><span class="doccomment">//! [![github]](https://github.com/dtolnay/inventory)&ensp;[![crates-io]](https://crates.io/crates/inventory)&ensp;[![docs-rs]](https://docs.rs/inventory) |
| //! |
| //! [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github |
| //! [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust |
| //! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K |
| //! |
| //! <br> |
| //! |
| //! **Typed distributed plugin registration.** |
| //! |
| //! This crate provides a way to set up a plugin registry into which plugins |
| //! can be registered from any source file linked into your application. There |
| //! does not need to be a central list of all the plugins. |
| //! |
| //! # Examples |
| //! |
| //! Suppose we are writing a command line flags library and want to allow any |
| //! source file in the application to register command line flags that are |
| //! relevant to it. |
| //! |
| //! This is the flag registration style used by [gflags] and is better suited |
| //! for large scale development than maintaining a single central list of flags, |
| //! as the central list would become an endless source of merge conflicts in an |
| //! application developed simultaneously by thousands of developers. |
| //! |
| //! [gflags]: https://gflags.github.io/gflags/ |
| //! |
| //! ## Instantiating the plugin registry |
| //! |
| //! Let's use a `struct Flag` as the plugin type, which will contain the short |
| //! name of the flag like `-v`, the full name like `--verbose`, and maybe other |
| //! information like argument type and help text. We instantiate a plugin |
| //! registry with an invocation of `inventory::collect!`. |
| //! |
| //! ``` |
| //! pub struct Flag { |
| //! short: char, |
| //! name: &'static str, |
| //! /* ... */ |
| //! } |
| //! |
| //! impl Flag { |
| //! pub fn new(short: char, name: &'static str) -> Self { |
| //! Flag { short, name } |
| //! } |
| //! } |
| //! |
| //! inventory::collect!(Flag); |
| //! ``` |
| //! |
| //! This `collect!` call must be in the same crate that defines the plugin type. |
| //! This macro does not "run" anything so place it outside of any function body. |
| //! |
| //! ## Registering plugins |
| //! |
| //! Now any crate with access to the `Flag` type can register flags as a plugin. |
| //! Plugins can be registered by the same crate that declares the plugin type, |
| //! or by any downstream crate. |
| //! |
| //! ``` |
| //! # struct Flag; |
| //! # |
| //! # impl Flag { |
| //! # fn new(short: char, name: &'static str) -> Self { |
| //! # Flag |
| //! # } |
| //! # } |
| //! # |
| //! # inventory::collect!(Flag); |
| //! # |
| //! inventory::submit! { |
| //! Flag::new('v', "verbose") |
| //! } |
| //! # |
| //! # fn main() {} |
| //! ``` |
| //! |
| //! The `submit!` macro does not "run" anything so place it outside of any |
| //! function body. In particular, note that all `submit!` invocations across all |
| //! source files linked into your application all take effect simultaneously. A |
| //! `submit!` invocation is not a statement that needs to be called from `main` |
| //! in order to execute. |
| //! |
| //! ## Iterating over plugins |
| //! |
| //! The value `inventory::iter::<T>` is an iterator with element type `&'static |
| //! T` that iterates over all plugins registered of type `T`. |
| //! |
| //! ``` |
| //! # struct Flag { |
| //! # short: char, |
| //! # name: &'static str, |
| //! # } |
| //! # |
| //! # inventory::collect!(Flag); |
| //! # |
| //! for flag in inventory::iter::<Flag> { |
| //! println!("-{}, --{}", flag.short, flag.name); |
| //! } |
| //! ``` |
| //! |
| //! There is no guarantee about the order that plugins of the same type are |
| //! visited by the iterator. They may be visited in any order. |
| |
| </span><span class="attribute">#![doc(html_root_url = <span class="string">"https://docs.rs/inventory/0.1.11"</span>)] |
| #![cfg_attr(not(inventory_require_std), no_std)] |
| #![allow( |
| clippy::doc_markdown, |
| clippy::empty_enum, |
| clippy::expl_impl_clone_on_copy, |
| clippy::let_unit_value, |
| clippy::must_use_candidate, |
| clippy::semicolon_if_nothing_returned, <span class="comment">// https://github.com/rust-lang/rust-clippy/issues/7324 |
| </span>)] |
| |
| #[cfg(not(inventory_require_std))] |
| </span><span class="kw">extern crate </span>alloc; |
| <span class="attribute">#[cfg(not(inventory_require_std))] |
| </span><span class="kw">use </span>alloc::boxed::Box; |
| |
| <span class="comment">// Not public API. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub use </span>ctor::ctor; |
| |
| <span class="comment">// Not public API. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub use </span>inventory_impl <span class="kw">as </span>r#impl; |
| |
| <span class="kw">use </span>core::ops::Deref; |
| <span class="kw">use </span>core::ptr; |
| <span class="kw">use </span>core::sync::atomic::{AtomicPtr, Ordering}; |
| |
| <span class="comment">// Not public API. Used by generated code. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub struct </span>Registry<T: <span class="lifetime">'static</span>> { |
| head: AtomicPtr<Node<T>>, |
| } |
| |
| <span class="kw">struct </span>Node<T: <span class="lifetime">'static</span>> { |
| value: T, |
| next: <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'static </span>Node<T>>, |
| } |
| |
| <span class="doccomment">/// Trait bound corresponding to types that can be iterated by inventory::iter. |
| /// |
| /// This trait cannot be implemented manually. Instead use the [`collect`] macro |
| /// which expands to an implementation of this trait for the given type. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use inventory::Collect; |
| /// |
| /// fn count_plugins<T: Collect>() -> usize { |
| /// inventory::iter::<T>.into_iter().count() |
| /// } |
| /// ``` |
| </span><span class="kw">pub trait </span>Collect: Sized + <span class="lifetime">'static </span>{ |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">fn </span>registry() -> <span class="kw-2">&</span><span class="lifetime">'static </span>Registry<<span class="self">Self</span>>; |
| } |
| |
| <span class="comment">// Not public API. Used by generated code. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub fn </span>submit<T: Collect>(value: T) { |
| <span class="comment">// TODO: Avoid allocation by storing node in a static mut Option<Node<T>> |
| // after existential type is stable. See comment in inventory-impl. |
| </span>T::registry().submit(Box::new(Node { value, next: <span class="prelude-val">None </span>})); |
| } |
| |
| <span class="kw">impl</span><T: <span class="lifetime">'static</span>> Registry<T> { |
| <span class="comment">// Not public API. Used by generated code. |
| </span><span class="kw">pub const fn </span>new() -> <span class="self">Self </span>{ |
| Registry { |
| head: AtomicPtr::new(ptr::null_mut()), |
| } |
| } |
| |
| <span class="kw">fn </span>submit(<span class="kw-2">&</span><span class="lifetime">'static </span><span class="self">self</span>, new: Box<Node<T>>) { |
| <span class="kw">let </span><span class="kw-2">mut </span>new = ptr::NonNull::from(Box::leak(new)); |
| <span class="kw">let </span><span class="kw-2">mut </span>head = <span class="self">self</span>.head.load(Ordering::SeqCst); |
| <span class="kw">loop </span>{ |
| <span class="comment">// `new` is always a valid Node<T>, and is not yet visible through the registry. |
| // `head` is always null or valid &'static Node<T>. |
| </span><span class="kw">unsafe </span>{ new.as_mut().next = head.as_ref() }; |
| <span class="kw">match </span><span class="self">self |
| </span>.head |
| .compare_exchange(head, new.as_ptr(), Ordering::SeqCst, Ordering::SeqCst) |
| { |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => <span class="kw">return</span>, |
| <span class="prelude-val">Err</span>(prev) => head = prev, |
| } |
| } |
| } |
| } |
| |
| <span class="attribute">#[allow(non_camel_case_types)] |
| </span><span class="kw">mod </span>private { |
| <span class="kw">use </span>ghost::phantom; |
| |
| <span class="attribute">#[phantom] |
| </span><span class="kw">pub struct </span>iter<T>; |
| } |
| |
| <span class="doccomment">/// An iterator over plugins registered of a given type. |
| /// |
| /// The value `inventory::iter::<T>` is an iterator with element type `&'static |
| /// T`. |
| /// |
| /// There is no guarantee about the order that plugins of the same type are |
| /// visited by the iterator. They may be visited in any order. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # struct Flag { |
| /// # short: char, |
| /// # name: &'static str, |
| /// # } |
| /// # |
| /// # inventory::collect!(Flag); |
| /// # |
| /// # const IGNORE: &str = stringify! { |
| /// use my_flags::Flag; |
| /// # }; |
| /// |
| /// fn main() { |
| /// for flag in inventory::iter::<Flag> { |
| /// println!("-{}, --{}", flag.short, flag.name); |
| /// } |
| /// } |
| /// ``` |
| /// |
| /// Refer to the [crate level documentation](index.html) for a complete example |
| /// of instantiating a plugin registry and submitting plugins. |
| </span><span class="attribute">#[allow(non_camel_case_types)] |
| </span><span class="kw">pub type </span>iter<T> = private::iter<T>; |
| |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::private::<span class="kw-2">*</span>; |
| |
| <span class="kw">const </span>ITER: () = { |
| <span class="kw">fn </span>into_iter<T: Collect>() -> Iter<T> { |
| <span class="kw">let </span>head = T::registry().head.load(Ordering::SeqCst); |
| Iter { |
| <span class="comment">// Head pointer is always null or valid &'static Node<T>. |
| </span>node: <span class="kw">unsafe </span>{ head.as_ref() }, |
| } |
| } |
| |
| <span class="kw">impl</span><T: Collect> IntoIterator <span class="kw">for </span>iter<T> { |
| <span class="kw">type </span>Item = <span class="kw-2">&</span><span class="lifetime">'static </span>T; |
| <span class="kw">type </span>IntoIter = Iter<T>; |
| |
| <span class="kw">fn </span>into_iter(<span class="self">self</span>) -> <span class="self">Self</span>::IntoIter { |
| into_iter() |
| } |
| } |
| |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">impl</span><T: Collect> Deref <span class="kw">for </span>iter<T> { |
| <span class="kw">type </span>Target = <span class="kw">fn</span>() -> Iter<T>; |
| <span class="kw">fn </span>deref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="self">Self</span>::Target { |
| <span class="kw-2">&</span>(into_iter <span class="kw">as fn</span>() -> Iter<T>) |
| } |
| } |
| |
| <span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>Iter<T: <span class="lifetime">'static</span>> { |
| node: <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'static </span>Node<T>>, |
| } |
| |
| <span class="kw">impl</span><T: <span class="lifetime">'static</span>> Iterator <span class="kw">for </span>Iter<T> { |
| <span class="kw">type </span>Item = <span class="kw-2">&</span><span class="lifetime">'static </span>T; |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <span class="kw">let </span>node = <span class="self">self</span>.node<span class="question-mark">?</span>; |
| <span class="kw">let </span>value = <span class="kw-2">&</span>node.value; |
| <span class="self">self</span>.node = node.next; |
| <span class="prelude-val">Some</span>(value) |
| } |
| } |
| }; |
| |
| <span class="doccomment">/// Associate a plugin registry with the specified type. |
| /// |
| /// This call must be in the same crate that defines the plugin type. This macro |
| /// does not "run" anything so place it outside of any function body. |
| /// |
| /// # Examples |
| /// |
| /// Suppose we are writing a command line flags library and want to allow any |
| /// source file in the application to register command line flags that are |
| /// relevant to it. |
| /// |
| /// This is the flag registration style used by [gflags] and is better suited |
| /// for large scale development than maintaining a single central list of flags, |
| /// as the central list would become an endless source of merge conflicts. |
| /// |
| /// [gflags]: https://gflags.github.io/gflags/ |
| /// |
| /// ``` |
| /// pub struct Flag { |
| /// short: char, |
| /// name: &'static str, |
| /// /* ... */ |
| /// } |
| /// |
| /// inventory::collect!(Flag); |
| /// ``` |
| /// |
| /// Refer to the [crate level documentation](index.html) for a complete example |
| /// of submitting plugins and iterating a plugin registry. |
| </span><span class="attribute">#[macro_export] |
| </span><span class="macro">macro_rules! </span>collect { |
| (<span class="macro-nonterminal">$ty</span>:ty) => { |
| <span class="kw">impl </span><span class="macro-nonterminal">$crate::Collect </span><span class="kw">for </span><span class="macro-nonterminal">$ty </span>{ |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>registry() -> <span class="kw-2">&</span><span class="lifetime">'static </span><span class="macro-nonterminal">$crate::Registry</span><<span class="self">Self</span>> { |
| <span class="kw">static </span>REGISTRY: <span class="macro-nonterminal">$crate::Registry</span><<span class="macro-nonterminal">$ty</span>> = <span class="macro-nonterminal">$crate::Registry::new</span>(); |
| <span class="kw-2">&</span>REGISTRY |
| } |
| } |
| }; |
| } |
| |
| <span class="doccomment">/// Enter an element into the plugin registry corresponding to its type. |
| /// |
| /// This call may be in the same crate that defines the type, or downstream in |
| /// any crate that depends on that crate. |
| /// |
| /// This macro does not "run" anything so place it outside of any function body. |
| /// In particular, note that all `submit!` invocations across all source files |
| /// linked into your application all take effect simultaneously. A `submit!` |
| /// invocation is not a statement that needs to be called from `main` in order |
| /// to execute. |
| /// |
| /// # Examples |
| /// |
| /// Put `submit!` invocations outside of any function body. |
| /// |
| /// ``` |
| /// # struct Flag; |
| /// # |
| /// # impl Flag { |
| /// # fn new(short: char, name: &'static str) -> Self { |
| /// # Flag |
| /// # } |
| /// # } |
| /// # |
| /// # inventory::collect!(Flag); |
| /// # |
| /// inventory::submit! { |
| /// Flag::new('v', "verbose") |
| /// } |
| /// # |
| /// # fn main() {} |
| /// ``` |
| /// |
| /// Do not try to invoke `submit!` from inside of a function body as it does not |
| /// do what you want. |
| /// |
| /// ```compile_fail |
| /// // Do not do this. |
| /// fn submit_flags(has_verbose_flag: bool) { |
| /// if has_verbose_flag { |
| /// inventory::submit! { |
| /// Flag::new('v', "verbose") |
| /// } |
| /// } |
| /// } |
| /// ``` |
| /// |
| /// Refer to the [crate level documentation](index.html) for a complete example |
| /// of instantiating and iterating a plugin registry. |
| </span><span class="attribute">#[macro_export] |
| </span><span class="macro">macro_rules! </span>submit { |
| ($(<span class="macro-nonterminal">$value</span>:tt)<span class="kw-2">*</span>) => { |
| <span class="macro-nonterminal">$</span><span class="kw">crate</span>::r#impl<span class="macro">::submit! </span>{ |
| $(<span class="macro-nonterminal">$value</span>)* |
| } |
| } |
| } |
| |
| <span class="attribute">#[allow(dead_code)] |
| </span><span class="kw">fn </span>unused() { |
| <span class="kw">let _ </span>= ITER; |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="inventory" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |