blob: 50749c134c6241a4bdd7ff8e0b397dd62b823e53 [file] [log] [blame]
<!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/pin-project-internal-1.1.0/src/pin_project/derive.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>derive.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="../../../pin_project_internal/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="../../../pin_project_internal/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>
</pre><pre class="rust"><code><span class="kw">use </span>proc_macro2::{Delimiter, Group, Span, TokenStream};
<span class="kw">use </span>quote::{format_ident, quote, quote_spanned, ToTokens};
<span class="kw">use </span>syn::{
parse_quote, punctuated::Punctuated, token, visit_mut::VisitMut, Attribute, Data, DataEnum,
DeriveInput, Error, Field, Fields, FieldsNamed, FieldsUnnamed, Generics, Ident, Index,
Lifetime, LifetimeParam, Meta, <span class="prelude-ty">Result</span>, Token, Type, Variant, Visibility, WhereClause,
};
<span class="kw">use super</span>::{
args::{parse_args, Args, ProjReplace, UnpinImpl},
PIN,
};
<span class="kw">use </span><span class="kw">crate</span>::utils::{
determine_lifetime_name, determine_visibility, insert_lifetime_and_bound, ReplaceReceiver,
SliceExt, Variants,
};
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>parse_derive(input: TokenStream) -&gt; <span class="prelude-ty">Result</span>&lt;TokenStream&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>input: DeriveInput = syn::parse2(input)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>cx;
<span class="kw">let </span><span class="kw-2">mut </span>generate = GenerateTokens::default();
<span class="kw">let </span>ident = <span class="kw-2">&amp;</span>input.ident;
<span class="kw">let </span>ty_generics = input.generics.split_for_impl().<span class="number">1</span>;
<span class="kw">let </span>self_ty = <span class="macro">parse_quote!</span>(#ident #ty_generics);
<span class="kw">let </span><span class="kw-2">mut </span>visitor = ReplaceReceiver(<span class="kw-2">&amp;</span>self_ty);
visitor.visit_generics_mut(<span class="kw-2">&amp;mut </span>input.generics);
visitor.visit_data_mut(<span class="kw-2">&amp;mut </span>input.data);
<span class="kw">match </span><span class="kw-2">&amp;</span>input.data {
Data::Struct(data) =&gt; {
cx = Context::new(<span class="kw-2">&amp;</span>input.attrs, <span class="kw-2">&amp;</span>input.vis, ident, <span class="kw-2">&amp;mut </span>input.generics, Struct)<span class="question-mark">?</span>;
parse_struct(<span class="kw-2">&amp;mut </span>cx, <span class="kw-2">&amp;</span>data.fields, <span class="kw-2">&amp;mut </span>generate)<span class="question-mark">?</span>;
}
Data::Enum(data) =&gt; {
cx = Context::new(<span class="kw-2">&amp;</span>input.attrs, <span class="kw-2">&amp;</span>input.vis, ident, <span class="kw-2">&amp;mut </span>input.generics, Enum)<span class="question-mark">?</span>;
parse_enum(<span class="kw-2">&amp;mut </span>cx, data, <span class="kw-2">&amp;mut </span>generate)<span class="question-mark">?</span>;
}
Data::Union(<span class="kw">_</span>) =&gt; {
<span class="macro">bail!</span>(input, <span class="string">&quot;#[pin_project] attribute may only be used on structs or enums&quot;</span>);
}
}
<span class="prelude-val">Ok</span>(generate.into_tokens(<span class="kw-2">&amp;</span>cx))
}
<span class="attribute">#[derive(Default)]
</span><span class="kw">struct </span>GenerateTokens {
exposed: TokenStream,
scoped: TokenStream,
}
<span class="kw">impl </span>GenerateTokens {
<span class="kw">fn </span>extend(<span class="kw-2">&amp;mut </span><span class="self">self</span>, expose: bool, tokens: TokenStream) {
<span class="kw">if </span>expose {
<span class="self">self</span>.exposed.extend(tokens);
} <span class="kw">else </span>{
<span class="self">self</span>.scoped.extend(tokens);
}
}
<span class="kw">fn </span>into_tokens(<span class="self">self</span>, cx: <span class="kw-2">&amp;</span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; TokenStream {
<span class="kw">let </span><span class="kw-2">mut </span>tokens = <span class="self">self</span>.exposed;
<span class="kw">let </span>scoped = <span class="self">self</span>.scoped;
<span class="kw">let </span>unpin_impl = make_unpin_impl(cx);
<span class="kw">let </span>drop_impl = make_drop_impl(cx);
<span class="kw">let </span>allowed_lints = global_allowed_lints();
tokens.extend(<span class="macro">quote! </span>{
<span class="comment">// All items except projected types are generated inside a `const` scope.
// This makes it impossible for user code to refer to these types.
// However, this prevents Rustdoc from displaying docs for any
// of our types. In particular, users cannot see the
// automatically generated `Unpin` impl for the &#39;__UnpinStruct&#39; types
//
// Previously, we provided a flag to correctly document the
// automatically generated `Unpin` impl by using def-site hygiene,
// but it is now removed.
//
// Refs:
// - https://github.com/rust-lang/rust/issues/63281
// - https://github.com/taiki-e/pin-project/pull/53#issuecomment-525906867
// - https://github.com/taiki-e/pin-project/pull/70
</span>#allowed_lints
<span class="attribute">#[allow(unused_qualifications)]
#[allow(clippy::semicolon_if_nothing_returned)]
#[allow(clippy::use_self)]
#[allow(clippy::used_underscore_binding)]
</span><span class="kw">const _</span>: () = {
<span class="attribute">#[allow(unused_extern_crates)]
</span><span class="kw">extern crate </span>pin_project <span class="kw">as </span>_pin_project;
#scoped
#unpin_impl
#drop_impl
};
});
tokens
}
}
<span class="doccomment">/// Returns attributes that should be applied to all generated code.
</span><span class="kw">fn </span>global_allowed_lints() -&gt; TokenStream {
<span class="macro">quote! </span>{
<span class="attribute">#[allow(box_pointers)] </span><span class="comment">// This lint warns use of the `Box` type.
</span><span class="attribute">#[allow(deprecated)]
#[allow(explicit_outlives_requirements)] </span><span class="comment">// https://github.com/rust-lang/rust/issues/60993
</span><span class="attribute">#[allow(single_use_lifetimes)] </span><span class="comment">// https://github.com/rust-lang/rust/issues/55058
</span><span class="attribute">#[allow(unreachable_pub)] </span><span class="comment">// This lint warns `pub` field in private struct.
</span><span class="attribute">#[allow(unused_tuple_struct_fields)]
</span><span class="comment">// This lint warns of `clippy::*` generated by external macros.
// We allow this lint for compatibility with older compilers.
</span><span class="attribute">#[allow(clippy::unknown_clippy_lints)]
#[allow(clippy::pattern_type_mismatch)]
#[allow(clippy::redundant_pub_crate)] </span><span class="comment">// This lint warns `pub(crate)` field in private struct.
</span><span class="attribute">#[allow(clippy::type_repetition_in_bounds)] </span><span class="comment">// https://github.com/rust-lang/rust-clippy/issues/4326
</span>}
}
<span class="doccomment">/// Returns attributes used on projected types.
</span><span class="kw">fn </span>proj_allowed_lints(cx: <span class="kw-2">&amp;</span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; (TokenStream, TokenStream, TokenStream) {
<span class="kw">let </span>large_enum_variant = <span class="kw">if </span>cx.kind == Enum {
<span class="prelude-val">Some</span>(<span class="macro">quote! </span>{
<span class="attribute">#[allow(variant_size_differences)]
#[allow(clippy::large_enum_variant)]
</span>})
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>};
<span class="kw">let </span>global_allowed_lints = global_allowed_lints();
<span class="kw">let </span>proj_mut_allowed_lints = <span class="kw">if </span>cx.project { <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>global_allowed_lints) } <span class="kw">else </span>{ <span class="prelude-val">None </span>};
<span class="kw">let </span>proj_mut = <span class="macro">quote! </span>{
#proj_mut_allowed_lints
<span class="attribute">#[allow(dead_code)] </span><span class="comment">// This lint warns unused fields/variants.
</span><span class="attribute">#[allow(clippy::mut_mut)] </span><span class="comment">// This lint warns `&amp;mut &amp;mut &lt;ty&gt;`.
</span>};
<span class="kw">let </span>proj_ref_allowed_lints = <span class="kw">if </span>cx.project_ref { <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>global_allowed_lints) } <span class="kw">else </span>{ <span class="prelude-val">None </span>};
<span class="kw">let </span>proj_ref = <span class="macro">quote! </span>{
#proj_ref_allowed_lints
<span class="attribute">#[allow(dead_code)] </span><span class="comment">// This lint warns unused fields/variants.
</span><span class="attribute">#[allow(clippy::ref_option_ref)] </span><span class="comment">// This lint warns `&amp;Option&lt;&amp;&lt;ty&gt;&gt;`.
</span>};
<span class="kw">let </span>proj_own_allowed_lints =
<span class="kw">if </span>cx.project_replace.ident().is_some() { <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>global_allowed_lints) } <span class="kw">else </span>{ <span class="prelude-val">None </span>};
<span class="kw">let </span>proj_own = <span class="macro">quote! </span>{
#proj_own_allowed_lints
<span class="attribute">#[allow(dead_code)] </span><span class="comment">// This lint warns unused fields/variants.
</span>#large_enum_variant
};
(proj_mut, proj_ref, proj_own)
}
<span class="kw">struct </span>Context&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// The original type.
</span>orig: OriginalType&lt;<span class="lifetime">&#39;a</span>&gt;,
<span class="doccomment">/// The projected types.
</span>proj: ProjectedType,
<span class="doccomment">/// Types of the pinned fields.
</span>pinned_fields: Vec&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Type&gt;,
<span class="doccomment">/// Kind of the original type: struct or enum
</span>kind: TypeKind,
<span class="doccomment">/// `PinnedDrop` argument.
</span>pinned_drop: <span class="prelude-ty">Option</span>&lt;Span&gt;,
<span class="doccomment">/// `UnsafeUnpin` or `!Unpin` argument.
</span>unpin_impl: UnpinImpl,
<span class="doccomment">/// `project` argument.
</span>project: bool,
<span class="doccomment">/// `project_ref` argument.
</span>project_ref: bool,
<span class="doccomment">/// `project_replace [= &lt;ident&gt;]` argument.
</span>project_replace: ProjReplace,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Context&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">fn </span>new(
attrs: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[Attribute],
vis: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Visibility,
ident: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Ident,
generics: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>Generics,
kind: TypeKind,
) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>&gt; {
<span class="kw">let </span>Args { pinned_drop, unpin_impl, project, project_ref, project_replace } =
parse_args(attrs)<span class="question-mark">?</span>;
<span class="kw">if let </span><span class="prelude-val">Some</span>(name) = [project.as_ref(), project_ref.as_ref(), project_replace.ident()]
.iter()
.filter_map(Option::as_ref)
.find(|name| <span class="kw-2">**</span>name == ident)
{
<span class="macro">bail!</span>(name, <span class="string">&quot;name `{}` is the same as the original type name&quot;</span>, name);
}
<span class="kw">let </span><span class="kw-2">mut </span>lifetime_name = String::from(<span class="string">&quot;&#39;pin&quot;</span>);
determine_lifetime_name(<span class="kw-2">&amp;mut </span>lifetime_name, generics);
<span class="kw">let </span>lifetime = Lifetime::new(<span class="kw-2">&amp;</span>lifetime_name, Span::call_site());
<span class="kw">let </span>ty_generics = generics.split_for_impl().<span class="number">1</span>;
<span class="kw">let </span>ty_generics_as_generics = <span class="macro">parse_quote!</span>(#ty_generics);
<span class="kw">let </span><span class="kw-2">mut </span>proj_generics = generics.clone();
<span class="kw">let </span>pred = insert_lifetime_and_bound(
<span class="kw-2">&amp;mut </span>proj_generics,
lifetime.clone(),
<span class="kw-2">&amp;</span>ty_generics_as_generics,
ident,
);
<span class="kw">let </span><span class="kw-2">mut </span>where_clause = generics.make_where_clause().clone();
where_clause.predicates.push(pred);
<span class="kw">let </span>own_ident = project_replace
.ident()
.cloned()
.unwrap_or_else(|| <span class="macro">format_ident!</span>(<span class="string">&quot;__{}ProjectionOwned&quot;</span>, ident));
<span class="prelude-val">Ok</span>(<span class="self">Self </span>{
kind,
pinned_drop,
unpin_impl,
project: project.is_some(),
project_ref: project_ref.is_some(),
project_replace,
proj: ProjectedType {
vis: determine_visibility(vis),
mut_ident: project.unwrap_or_else(|| <span class="macro">format_ident!</span>(<span class="string">&quot;__{}Projection&quot;</span>, ident)),
ref_ident: project_ref.unwrap_or_else(|| <span class="macro">format_ident!</span>(<span class="string">&quot;__{}ProjectionRef&quot;</span>, ident)),
own_ident,
lifetime,
generics: proj_generics,
where_clause,
},
orig: OriginalType { attrs, vis, ident, generics },
pinned_fields: Vec::new(),
})
}
}
<span class="attribute">#[derive(Copy, Clone, PartialEq)]
</span><span class="kw">enum </span>TypeKind {
Enum,
Struct,
}
<span class="kw">use </span>TypeKind::{Enum, Struct};
<span class="kw">struct </span>OriginalType&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// Attributes of the original type.
</span>attrs: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[Attribute],
<span class="doccomment">/// Visibility of the original type.
</span>vis: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Visibility,
<span class="doccomment">/// Name of the original type.
</span>ident: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Ident,
<span class="doccomment">/// Generics of the original type.
</span>generics: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Generics,
}
<span class="kw">struct </span>ProjectedType {
<span class="doccomment">/// Visibility of the projected types.
</span>vis: Visibility,
<span class="doccomment">/// Name of the projected type returned by `project` method.
</span>mut_ident: Ident,
<span class="doccomment">/// Name of the projected type returned by `project_ref` method.
</span>ref_ident: Ident,
<span class="doccomment">/// Name of the projected type returned by `project_replace` method.
</span>own_ident: Ident,
<span class="doccomment">/// Lifetime on the generated projected types.
</span>lifetime: Lifetime,
<span class="doccomment">/// Generics of the projected types.
</span>generics: Generics,
<span class="doccomment">/// `where` clause of the projected types. This has an additional
/// bound generated by `insert_lifetime_and_bound`
</span>where_clause: WhereClause,
}
<span class="kw">struct </span>ProjectedVariants {
proj_variants: TokenStream,
proj_ref_variants: TokenStream,
proj_own_variants: TokenStream,
proj_arms: TokenStream,
proj_ref_arms: TokenStream,
proj_own_arms: TokenStream,
}
<span class="attribute">#[derive(Default)]
</span><span class="kw">struct </span>ProjectedFields {
proj_pat: TokenStream,
proj_body: TokenStream,
proj_own_body: TokenStream,
proj_fields: TokenStream,
proj_ref_fields: TokenStream,
proj_own_fields: TokenStream,
}
<span class="kw">fn </span>validate_struct(ident: <span class="kw-2">&amp;</span>Ident, fields: <span class="kw-2">&amp;</span>Fields) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="kw">if </span>fields.is_empty() {
<span class="kw">let </span>msg = <span class="string">&quot;#[pin_project] attribute may not be used on structs with zero fields&quot;</span>;
<span class="kw">if let </span>Fields::Unit = fields {
<span class="macro">bail!</span>(ident, msg)
}
<span class="macro">bail!</span>(fields, msg)
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>validate_enum(brace_token: token::Brace, variants: <span class="kw-2">&amp;</span>Variants) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="kw">if </span>variants.is_empty() {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new(
brace_token.span.join(),
<span class="string">&quot;#[pin_project] attribute may not be used on enums without variants&quot;</span>,
));
}
<span class="kw">let </span>has_field = variants.iter().try_fold(<span class="bool-val">false</span>, |has_field, v| {
<span class="kw">if let </span><span class="prelude-val">Some</span>((<span class="kw">_</span>, e)) = <span class="kw-2">&amp;</span>v.discriminant {
<span class="macro">bail!</span>(e, <span class="string">&quot;#[pin_project] attribute may not be used on enums with discriminants&quot;</span>);
} <span class="kw">else if let </span><span class="prelude-val">Some</span>(attr) = v.attrs.find(PIN) {
<span class="macro">bail!</span>(attr, <span class="string">&quot;#[pin] attribute may only be used on fields of structs or variants&quot;</span>);
} <span class="kw">else if </span>v.fields.is_empty() {
<span class="prelude-val">Ok</span>(has_field)
} <span class="kw">else </span>{
<span class="prelude-val">Ok</span>(<span class="bool-val">true</span>)
}
})<span class="question-mark">?</span>;
<span class="kw">if </span>has_field {
<span class="prelude-val">Ok</span>(())
} <span class="kw">else </span>{
<span class="macro">bail!</span>(variants, <span class="string">&quot;#[pin_project] attribute may not be used on enums with zero fields&quot;</span>);
}
}
<span class="kw">fn </span>parse_struct&lt;<span class="lifetime">&#39;a</span>&gt;(
cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;a</span>&gt;,
fields: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Fields,
generate: <span class="kw-2">&amp;mut </span>GenerateTokens,
) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="comment">// Do this first for a better error message.
</span><span class="kw">let </span>packed_check = ensure_not_packed(<span class="kw-2">&amp;</span>cx.orig, <span class="prelude-val">Some</span>(fields))<span class="question-mark">?</span>;
validate_struct(cx.orig.ident, fields)<span class="question-mark">?</span>;
<span class="kw">let </span>ProjectedFields {
proj_pat,
proj_body,
proj_fields,
proj_ref_fields,
proj_own_fields,
proj_own_body,
} = <span class="kw">match </span>fields {
Fields::Named(<span class="kw">_</span>) =&gt; visit_fields(cx, <span class="prelude-val">None</span>, fields, Delimiter::Brace)<span class="question-mark">?</span>,
Fields::Unnamed(<span class="kw">_</span>) =&gt; visit_fields(cx, <span class="prelude-val">None</span>, fields, Delimiter::Parenthesis)<span class="question-mark">?</span>,
Fields::Unit =&gt; <span class="macro">unreachable!</span>(),
};
<span class="kw">let </span>proj_ident = <span class="kw-2">&amp;</span>cx.proj.mut_ident;
<span class="kw">let </span>proj_ref_ident = <span class="kw-2">&amp;</span>cx.proj.ref_ident;
<span class="kw">let </span>proj_own_ident = <span class="kw-2">&amp;</span>cx.proj.own_ident;
<span class="kw">let </span>vis = <span class="kw-2">&amp;</span>cx.proj.vis;
<span class="kw">let </span><span class="kw-2">mut </span>orig_generics = cx.orig.generics.clone();
<span class="kw">let </span>orig_where_clause = orig_generics.where_clause.take();
<span class="kw">let </span>proj_generics = <span class="kw-2">&amp;</span>cx.proj.generics;
<span class="kw">let </span>proj_where_clause = <span class="kw-2">&amp;</span>cx.proj.where_clause;
<span class="comment">// For tuple structs, we need to generate `(T1, T2) where Foo: Bar`
// For non-tuple structs, we need to generate `where Foo: Bar { field1: T }`
</span><span class="kw">let </span>(where_clause_fields, where_clause_ref_fields, where_clause_own_fields) = <span class="kw">match </span>fields {
Fields::Named(<span class="kw">_</span>) =&gt; (
<span class="macro">quote!</span>(#proj_where_clause #proj_fields),
<span class="macro">quote!</span>(#proj_where_clause #proj_ref_fields),
<span class="macro">quote!</span>(#orig_where_clause #proj_own_fields),
),
Fields::Unnamed(<span class="kw">_</span>) =&gt; (
<span class="macro">quote!</span>(#proj_fields #proj_where_clause;),
<span class="macro">quote!</span>(#proj_ref_fields #proj_where_clause;),
<span class="macro">quote!</span>(#proj_own_fields #orig_where_clause;),
),
Fields::Unit =&gt; <span class="macro">unreachable!</span>(),
};
<span class="kw">let </span>(proj_attrs, proj_ref_attrs, proj_own_attrs) = proj_allowed_lints(cx);
generate.extend(cx.project, <span class="macro">quote! </span>{
#proj_attrs
#vis <span class="kw">struct </span>#proj_ident #proj_generics #where_clause_fields
});
generate.extend(cx.project_ref, <span class="macro">quote! </span>{
#proj_ref_attrs
#vis <span class="kw">struct </span>#proj_ref_ident #proj_generics #where_clause_ref_fields
});
<span class="kw">if </span>cx.project_replace.span().is_some() {
generate.extend(cx.project_replace.ident().is_some(), <span class="macro">quote! </span>{
#proj_own_attrs
#vis <span class="kw">struct </span>#proj_own_ident #orig_generics #where_clause_own_fields
});
}
<span class="kw">let </span>proj_mut_body = <span class="macro">quote! </span>{
<span class="kw">let </span><span class="self">Self </span>#proj_pat = <span class="self">self</span>.get_unchecked_mut();
#proj_ident #proj_body
};
<span class="kw">let </span>proj_ref_body = <span class="macro">quote! </span>{
<span class="kw">let </span><span class="self">Self </span>#proj_pat = <span class="self">self</span>.get_ref();
#proj_ref_ident #proj_body
};
<span class="kw">let </span>proj_own_body = <span class="macro">quote! </span>{
<span class="kw">let </span><span class="self">Self </span>#proj_pat = <span class="kw-2">&amp;mut *</span>__self_ptr;
#proj_own_body
};
generate.extend(<span class="bool-val">false</span>, make_proj_impl(cx, <span class="kw-2">&amp;</span>proj_mut_body, <span class="kw-2">&amp;</span>proj_ref_body, <span class="kw-2">&amp;</span>proj_own_body));
generate.extend(<span class="bool-val">false</span>, packed_check);
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>parse_enum&lt;<span class="lifetime">&#39;a</span>&gt;(
cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;a</span>&gt;,
DataEnum { brace_token, variants, .. }: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>DataEnum,
generate: <span class="kw-2">&amp;mut </span>GenerateTokens,
) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="kw">if let </span>ProjReplace::Unnamed { span } = <span class="kw-2">&amp;</span>cx.project_replace {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new(
<span class="kw-2">*</span>span,
<span class="string">&quot;`project_replace` argument requires a value when used on enums&quot;</span>,
));
}
<span class="comment">// #[repr(packed)] cannot be apply on enums and will be rejected by rustc.
// However, we should not rely on the behavior of rustc that rejects this.
// https://github.com/taiki-e/pin-project/pull/324#discussion_r612388001
//
// Do this first for a better error message.
</span>ensure_not_packed(<span class="kw-2">&amp;</span>cx.orig, <span class="prelude-val">None</span>)<span class="question-mark">?</span>;
validate_enum(<span class="kw-2">*</span>brace_token, variants)<span class="question-mark">?</span>;
<span class="kw">let </span>ProjectedVariants {
proj_variants,
proj_ref_variants,
proj_own_variants,
proj_arms,
proj_ref_arms,
proj_own_arms,
} = visit_variants(cx, variants)<span class="question-mark">?</span>;
<span class="kw">let </span>proj_ident = <span class="kw-2">&amp;</span>cx.proj.mut_ident;
<span class="kw">let </span>proj_ref_ident = <span class="kw-2">&amp;</span>cx.proj.ref_ident;
<span class="kw">let </span>proj_own_ident = <span class="kw-2">&amp;</span>cx.proj.own_ident;
<span class="kw">let </span>vis = <span class="kw-2">&amp;</span>cx.proj.vis;
<span class="kw">let </span><span class="kw-2">mut </span>orig_generics = cx.orig.generics.clone();
<span class="kw">let </span>orig_where_clause = orig_generics.where_clause.take();
<span class="kw">let </span>proj_generics = <span class="kw-2">&amp;</span>cx.proj.generics;
<span class="kw">let </span>proj_where_clause = <span class="kw-2">&amp;</span>cx.proj.where_clause;
<span class="kw">let </span>(proj_attrs, proj_ref_attrs, proj_own_attrs) = proj_allowed_lints(cx);
<span class="kw">if </span>cx.project {
generate.extend(<span class="bool-val">true</span>, <span class="macro">quote! </span>{
#proj_attrs
#vis <span class="kw">enum </span>#proj_ident #proj_generics #proj_where_clause {
#proj_variants
}
});
}
<span class="kw">if </span>cx.project_ref {
generate.extend(<span class="bool-val">true</span>, <span class="macro">quote! </span>{
#proj_ref_attrs
#vis <span class="kw">enum </span>#proj_ref_ident #proj_generics #proj_where_clause {
#proj_ref_variants
}
});
}
<span class="kw">if </span>cx.project_replace.ident().is_some() {
generate.extend(<span class="bool-val">true</span>, <span class="macro">quote! </span>{
#proj_own_attrs
#vis <span class="kw">enum </span>#proj_own_ident #orig_generics #orig_where_clause {
#proj_own_variants
}
});
}
<span class="kw">let </span>proj_mut_body = <span class="macro">quote! </span>{
<span class="kw">match </span><span class="self">self</span>.get_unchecked_mut() {
#proj_arms
}
};
<span class="kw">let </span>proj_ref_body = <span class="macro">quote! </span>{
<span class="kw">match </span><span class="self">self</span>.get_ref() {
#proj_ref_arms
}
};
<span class="kw">let </span>proj_own_body = <span class="macro">quote! </span>{
<span class="kw">match </span><span class="kw-2">&amp;mut *</span>__self_ptr {
#proj_own_arms
}
};
generate.extend(<span class="bool-val">false</span>, make_proj_impl(cx, <span class="kw-2">&amp;</span>proj_mut_body, <span class="kw-2">&amp;</span>proj_ref_body, <span class="kw-2">&amp;</span>proj_own_body));
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>visit_variants&lt;<span class="lifetime">&#39;a</span>&gt;(cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;a</span>&gt;, variants: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Variants) -&gt; <span class="prelude-ty">Result</span>&lt;ProjectedVariants&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>proj_variants = TokenStream::new();
<span class="kw">let </span><span class="kw-2">mut </span>proj_ref_variants = TokenStream::new();
<span class="kw">let </span><span class="kw-2">mut </span>proj_own_variants = TokenStream::new();
<span class="kw">let </span><span class="kw-2">mut </span>proj_arms = TokenStream::new();
<span class="kw">let </span><span class="kw-2">mut </span>proj_ref_arms = TokenStream::new();
<span class="kw">let </span><span class="kw-2">mut </span>proj_own_arms = TokenStream::new();
<span class="kw">for </span>Variant { ident, fields, .. } <span class="kw">in </span>variants {
<span class="kw">let </span>ProjectedFields {
proj_pat,
proj_body,
proj_fields,
proj_ref_fields,
proj_own_fields,
proj_own_body,
} = <span class="kw">match </span>fields {
Fields::Named(<span class="kw">_</span>) =&gt; visit_fields(cx, <span class="prelude-val">Some</span>(ident), fields, Delimiter::Brace)<span class="question-mark">?</span>,
Fields::Unnamed(<span class="kw">_</span>) =&gt; visit_fields(cx, <span class="prelude-val">Some</span>(ident), fields, Delimiter::Parenthesis)<span class="question-mark">?</span>,
Fields::Unit =&gt; ProjectedFields {
proj_own_body: proj_own_body(cx, <span class="prelude-val">Some</span>(ident), <span class="prelude-val">None</span>, <span class="kw-2">&amp;</span>[]),
..Default::default()
},
};
<span class="kw">let </span>proj_ident = <span class="kw-2">&amp;</span>cx.proj.mut_ident;
<span class="kw">let </span>proj_ref_ident = <span class="kw-2">&amp;</span>cx.proj.ref_ident;
proj_variants.extend(<span class="macro">quote! </span>{
#ident #proj_fields,
});
proj_ref_variants.extend(<span class="macro">quote! </span>{
#ident #proj_ref_fields,
});
proj_own_variants.extend(<span class="macro">quote! </span>{
#ident #proj_own_fields,
});
proj_arms.extend(<span class="macro">quote! </span>{
<span class="self">Self</span>::#ident #proj_pat =&gt; #proj_ident::#ident #proj_body,
});
proj_ref_arms.extend(<span class="macro">quote! </span>{
<span class="self">Self</span>::#ident #proj_pat =&gt; #proj_ref_ident::#ident #proj_body,
});
proj_own_arms.extend(<span class="macro">quote! </span>{
<span class="self">Self</span>::#ident #proj_pat =&gt; { #proj_own_body }
});
}
<span class="prelude-val">Ok</span>(ProjectedVariants {
proj_variants,
proj_ref_variants,
proj_own_variants,
proj_arms,
proj_ref_arms,
proj_own_arms,
})
}
<span class="kw">fn </span>visit_fields&lt;<span class="lifetime">&#39;a</span>&gt;(
cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;a</span>&gt;,
variant_ident: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>Ident&gt;,
fields: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Fields,
delim: Delimiter,
) -&gt; <span class="prelude-ty">Result</span>&lt;ProjectedFields&gt; {
<span class="kw">fn </span>surround(delim: Delimiter, tokens: TokenStream) -&gt; TokenStream {
Group::new(delim, tokens).into_token_stream()
}
<span class="kw">let </span><span class="kw-2">mut </span>proj_pat = TokenStream::new();
<span class="kw">let </span><span class="kw-2">mut </span>proj_body = TokenStream::new();
<span class="kw">let </span><span class="kw-2">mut </span>proj_fields = TokenStream::new();
<span class="kw">let </span><span class="kw-2">mut </span>proj_ref_fields = TokenStream::new();
<span class="kw">let </span><span class="kw-2">mut </span>proj_own_fields = TokenStream::new();
<span class="kw">let </span><span class="kw-2">mut </span>proj_move = TokenStream::new();
<span class="kw">let </span><span class="kw-2">mut </span>pinned_bindings = Vec::with_capacity(fields.len());
<span class="kw">for </span>(i, Field { attrs, vis, ident, colon_token, ty, mutability: <span class="kw">_ </span>}) <span class="kw">in
</span>fields.iter().enumerate()
{
<span class="kw">let </span>binding = ident.clone().unwrap_or_else(|| <span class="macro">format_ident!</span>(<span class="string">&quot;_{}&quot;</span>, i));
proj_pat.extend(<span class="macro">quote!</span>(#binding,));
<span class="kw">let </span>lifetime = <span class="kw-2">&amp;</span>cx.proj.lifetime;
<span class="kw">if </span>attrs.position_exact(PIN)<span class="question-mark">?</span>.is_some() {
proj_fields.extend(<span class="macro">quote! </span>{
#vis #ident #colon_token ::pin_project::__private::Pin&lt;<span class="kw-2">&amp;</span>#lifetime <span class="kw-2">mut </span>(#ty)&gt;,
});
proj_ref_fields.extend(<span class="macro">quote! </span>{
#vis #ident #colon_token ::pin_project::__private::Pin&lt;<span class="kw-2">&amp;</span>#lifetime (#ty)&gt;,
});
proj_own_fields.extend(<span class="macro">quote! </span>{
#vis #ident #colon_token ::pin_project::__private::PhantomData&lt;#ty&gt;,
});
proj_body.extend(<span class="macro">quote! </span>{
#ident #colon_token _pin_project::__private::Pin::new_unchecked(#binding),
});
proj_move.extend(<span class="macro">quote! </span>{
#ident #colon_token _pin_project::__private::PhantomData,
});
cx.pinned_fields.push(ty);
pinned_bindings.push(binding);
} <span class="kw">else </span>{
proj_fields.extend(<span class="macro">quote! </span>{
#vis #ident #colon_token <span class="kw-2">&amp;</span>#lifetime <span class="kw-2">mut </span>(#ty),
});
proj_ref_fields.extend(<span class="macro">quote! </span>{
#vis #ident #colon_token <span class="kw-2">&amp;</span>#lifetime (#ty),
});
proj_own_fields.extend(<span class="macro">quote! </span>{
#vis #ident #colon_token #ty,
});
proj_body.extend(<span class="macro">quote! </span>{
#binding,
});
proj_move.extend(<span class="macro">quote! </span>{
#ident #colon_token _pin_project::__private::ptr::read(#binding),
});
}
}
<span class="kw">let </span>proj_pat = surround(delim, proj_pat);
<span class="kw">let </span>proj_body = surround(delim, proj_body);
<span class="kw">let </span>proj_fields = surround(delim, proj_fields);
<span class="kw">let </span>proj_ref_fields = surround(delim, proj_ref_fields);
<span class="kw">let </span>proj_own_fields = surround(delim, proj_own_fields);
<span class="kw">let </span>proj_move = Group::new(delim, proj_move);
<span class="kw">let </span>proj_own_body = proj_own_body(cx, variant_ident, <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>proj_move), <span class="kw-2">&amp;</span>pinned_bindings);
<span class="prelude-val">Ok</span>(ProjectedFields {
proj_pat,
proj_body,
proj_own_body,
proj_fields,
proj_ref_fields,
proj_own_fields,
})
}
<span class="doccomment">/// Generates the processing that `project_replace` does for the struct or each variant.
///
/// Note: `pinned_fields` must be in declaration order.
</span><span class="kw">fn </span>proj_own_body(
cx: <span class="kw-2">&amp;</span>Context&lt;<span class="lifetime">&#39;_</span>&gt;,
variant_ident: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>Ident&gt;,
proj_move: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>Group&gt;,
pinned_fields: <span class="kw-2">&amp;</span>[Ident],
) -&gt; TokenStream {
<span class="kw">let </span>ident = <span class="kw-2">&amp;</span>cx.proj.own_ident;
<span class="kw">let </span>proj_own = <span class="kw">match </span>variant_ident {
<span class="prelude-val">Some</span>(variant_ident) =&gt; <span class="macro">quote!</span>(#ident::#variant_ident),
<span class="prelude-val">None </span>=&gt; <span class="macro">quote!</span>(#ident),
};
<span class="comment">// The fields of the struct and the active enum variant are dropped
// in declaration order.
// Refs: https://doc.rust-lang.org/reference/destructors.html
</span><span class="kw">let </span>pinned_fields = pinned_fields.iter().rev();
<span class="macro">quote! </span>{
<span class="comment">// First, extract all the unpinned fields.
</span><span class="kw">let </span>__result = #proj_own #proj_move;
<span class="comment">// Now create guards to drop all the pinned fields.
//
// Due to a compiler bug (https://github.com/rust-lang/rust/issues/47949)
// this must be in its own scope, or else `__result` will not be dropped
// if any of the destructors panic.
</span>{
#(
<span class="kw">let </span>__guard = _pin_project::__private::UnsafeDropInPlaceGuard::new(#pinned_fields);
)*
}
<span class="comment">// Finally, return the result.
</span>__result
}
}
<span class="doccomment">/// Creates `Unpin` implementation for the original type.
///
/// The kind of `Unpin` impl generated depends on `unpin_impl` field:
/// - `UnpinImpl::Unsafe` - Implements `Unpin` via `UnsafeUnpin` impl.
/// - `UnpinImpl::Negative` - Generates `Unpin` impl with bounds that will never be true.
/// - `UnpinImpl::Default` - Generates `Unpin` impl that requires `Unpin` for all pinned fields.
</span><span class="kw">fn </span>make_unpin_impl(cx: <span class="kw-2">&amp;</span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; TokenStream {
<span class="kw">match </span>cx.unpin_impl {
UnpinImpl::Unsafe(span) =&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>proj_generics = cx.proj.generics.clone();
<span class="kw">let </span>orig_ident = cx.orig.ident;
<span class="kw">let </span>lifetime = <span class="kw-2">&amp;</span>cx.proj.lifetime;
<span class="comment">// Make the error message highlight `UnsafeUnpin` argument.
</span>proj_generics.make_where_clause().predicates.push(<span class="macro">parse_quote_spanned! </span>{ span =&gt;
_pin_project::__private::Wrapper&lt;#lifetime, <span class="self">Self</span>&gt;: _pin_project::UnsafeUnpin
});
<span class="kw">let </span>(impl_generics, <span class="kw">_</span>, where_clause) = proj_generics.split_for_impl();
<span class="kw">let </span>ty_generics = cx.orig.generics.split_for_impl().<span class="number">1</span>;
<span class="macro">quote_spanned! </span>{ span =&gt;
<span class="kw">impl </span>#impl_generics _pin_project::__private::Unpin <span class="kw">for </span>#orig_ident #ty_generics
#where_clause
{
}
}
}
UnpinImpl::Negative(span) =&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>proj_generics = cx.proj.generics.clone();
<span class="kw">let </span>orig_ident = cx.orig.ident;
<span class="kw">let </span>lifetime = <span class="kw-2">&amp;</span>cx.proj.lifetime;
proj_generics.make_where_clause().predicates.push(<span class="macro">parse_quote! </span>{
_pin_project::__private::Wrapper&lt;
#lifetime, _pin_project::__private::PhantomPinned
&gt;: _pin_project::__private::Unpin
});
<span class="kw">let </span>(proj_impl_generics, <span class="kw">_</span>, proj_where_clause) = proj_generics.split_for_impl();
<span class="kw">let </span>ty_generics = cx.orig.generics.split_for_impl().<span class="number">1</span>;
<span class="comment">// For interoperability with `forbid(unsafe_code)`, `unsafe` token should be
// call-site span.
</span><span class="kw">let </span>unsafety = &lt;<span class="macro">Token!</span>[<span class="kw">unsafe</span>]&gt;::default();
<span class="macro">quote_spanned! </span>{ span =&gt;
<span class="kw">impl </span>#proj_impl_generics _pin_project::__private::Unpin
<span class="kw">for </span>#orig_ident #ty_generics
#proj_where_clause
{
}
<span class="comment">// Generate a dummy impl of `UnsafeUnpin`, to ensure that the user cannot implement it.
//
// To ensure that users don&#39;t accidentally write a non-functional `UnsafeUnpin`
// impls, we emit one ourselves. If the user ends up writing an `UnsafeUnpin`
// impl, they&#39;ll get a &quot;conflicting implementations of trait&quot; error when
// coherence checks are run.
</span><span class="attribute">#[doc(hidden)]
</span>#unsafety <span class="kw">impl </span>#proj_impl_generics _pin_project::UnsafeUnpin
<span class="kw">for </span>#orig_ident #ty_generics
#proj_where_clause
{
}
}
}
UnpinImpl::Default =&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>full_where_clause = cx.orig.generics.where_clause.clone().unwrap();
<span class="comment">// Generate a field in our new struct for every
// pinned field in the original type.
</span><span class="kw">let </span>fields = cx.pinned_fields.iter().enumerate().map(|(i, ty)| {
<span class="kw">let </span>field_ident = <span class="macro">format_ident!</span>(<span class="string">&quot;__field{}&quot;</span>, i);
<span class="macro">quote!</span>(#field_ident: #ty)
});
<span class="comment">// We could try to determine the subset of type parameters
// and lifetimes that are actually used by the pinned fields
// (as opposed to those only used by unpinned fields).
// However, this would be tricky and error-prone, since
// it&#39;s possible for users to create types that would alias
// with generic parameters (e.g. &#39;struct T&#39;).
//
// Instead, we generate a use of every single type parameter
// and lifetime used in the original struct. For type parameters,
// we generate code like this:
//
// ```rust
// struct AlwaysUnpin&lt;T: ?Sized&gt;(PhantomData&lt;T&gt;) {}
// impl&lt;T: ?Sized&gt; Unpin for AlwaysUnpin&lt;T&gt; {}
//
// ...
// _field: AlwaysUnpin&lt;(A, B, C)&gt;
// ```
//
// This ensures that any unused type parameters
// don&#39;t end up with `Unpin` bounds.
</span><span class="kw">let </span>lifetime_fields = cx.orig.generics.lifetimes().enumerate().map(
|(i, LifetimeParam { lifetime, .. })| {
<span class="kw">let </span>field_ident = <span class="macro">format_ident!</span>(<span class="string">&quot;__lifetime{}&quot;</span>, i);
<span class="macro">quote!</span>(#field_ident: <span class="kw-2">&amp;</span>#lifetime ())
},
);
<span class="kw">let </span>orig_ident = cx.orig.ident;
<span class="kw">let </span>struct_ident = <span class="macro">format_ident!</span>(<span class="string">&quot;__{}&quot;</span>, orig_ident);
<span class="kw">let </span>vis = cx.orig.vis;
<span class="kw">let </span>lifetime = <span class="kw-2">&amp;</span>cx.proj.lifetime;
<span class="kw">let </span>type_params = cx.orig.generics.type_params().map(|t| <span class="kw-2">&amp;</span>t.ident);
<span class="kw">let </span>proj_generics = <span class="kw-2">&amp;</span>cx.proj.generics;
<span class="kw">let </span>(proj_impl_generics, proj_ty_generics, <span class="kw">_</span>) = proj_generics.split_for_impl();
<span class="kw">let </span>(<span class="kw">_</span>, ty_generics, where_clause) = cx.orig.generics.split_for_impl();
full_where_clause.predicates.push(<span class="macro">parse_quote! </span>{
#struct_ident #proj_ty_generics: _pin_project::__private::Unpin
});
<span class="macro">quote! </span>{
<span class="comment">// This needs to have the same visibility as the original type,
// due to the limitations of the &#39;public in private&#39; error.
//
// Our goal is to implement the public trait `Unpin` for
// a potentially public user type. Because of this, rust
// requires that any types mentioned in the where clause of
// our `Unpin` impl also be public. This means that our generated
// `__UnpinStruct` type must also be public.
// However, we ensure that the user can never actually reference
// this &#39;public&#39; type by creating this type in the inside of `const`.
</span><span class="attribute">#[allow(missing_debug_implementations)]
</span>#vis <span class="kw">struct </span>#struct_ident #proj_generics #where_clause {
__pin_project_use_generics: _pin_project::__private::AlwaysUnpin&lt;
#lifetime, (#(_pin_project::__private::PhantomData&lt;#type_params&gt;),<span class="kw-2">*</span>)
&gt;,
#(#fields,)*
#(#lifetime_fields,)*
}
<span class="kw">impl </span>#proj_impl_generics _pin_project::__private::Unpin
<span class="kw">for </span>#orig_ident #ty_generics
#full_where_clause
{
}
<span class="comment">// Generate a dummy impl of `UnsafeUnpin`, to ensure that the user cannot implement it.
//
// To ensure that users don&#39;t accidentally write a non-functional `UnsafeUnpin`
// impls, we emit one ourselves. If the user ends up writing an `UnsafeUnpin`
// impl, they&#39;ll get a &quot;conflicting implementations of trait&quot; error when
// coherence checks are run.
</span><span class="attribute">#[doc(hidden)]
</span><span class="kw">unsafe impl </span>#proj_impl_generics _pin_project::UnsafeUnpin
<span class="kw">for </span>#orig_ident #ty_generics
#full_where_clause
{
}
}
}
}
}
<span class="doccomment">/// Creates `Drop` implementation for the original type.
///
/// The kind of `Drop` impl generated depends on `pinned_drop` field:
/// - `Some` - implements `Drop` via `PinnedDrop` impl.
/// - `None` - generates code that ensures that `Drop` trait is not implemented,
/// instead of generating `Drop` impl.
</span><span class="kw">fn </span>make_drop_impl(cx: <span class="kw-2">&amp;</span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; TokenStream {
<span class="kw">let </span>ident = cx.orig.ident;
<span class="kw">let </span>(impl_generics, ty_generics, where_clause) = cx.orig.generics.split_for_impl();
<span class="kw">if let </span><span class="prelude-val">Some</span>(span) = cx.pinned_drop {
<span class="comment">// For interoperability with `forbid(unsafe_code)`, `unsafe` token should be
// call-site span.
</span><span class="kw">let </span>unsafety = &lt;<span class="macro">Token!</span>[<span class="kw">unsafe</span>]&gt;::default();
<span class="macro">quote_spanned! </span>{ span =&gt;
<span class="kw">impl </span>#impl_generics _pin_project::__private::Drop <span class="kw">for </span>#ident #ty_generics
#where_clause
{
<span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
#unsafety {
<span class="comment">// Safety - we&#39;re in &#39;drop&#39;, so we know that &#39;self&#39; will
// never move again.
</span><span class="kw">let </span>__pinned_self = _pin_project::__private::Pin::new_unchecked(<span class="self">self</span>);
<span class="comment">// We call `pinned_drop` only once. Since `PinnedDrop::drop`
// is an unsafe method and a private API, it is never called again in safe
// code *unless the user uses a maliciously crafted macro*.
</span>_pin_project::__private::PinnedDrop::drop(__pinned_self);
}
}
}
}
} <span class="kw">else </span>{
<span class="comment">// If the user does not provide a `PinnedDrop` impl,
// we need to ensure that they don&#39;t provide a `Drop` impl of their
// own.
// Based on https://github.com/upsuper/assert-impl/blob/f503255b292ab0ba8d085b657f4065403cfa46eb/src/lib.rs#L80-L87
//
// We create a new identifier for each struct, so that the traits
// for different types do not conflict with each other.
//
// Another approach would be to provide an empty Drop impl,
// which would conflict with a user-provided Drop impl.
// However, this would trigger the compiler&#39;s special handling
// of Drop types (e.g. fields cannot be moved out of a Drop type).
// This approach prevents the creation of needless Drop impls,
// giving users more flexibility.
</span><span class="kw">let </span>trait_ident = <span class="macro">format_ident!</span>(<span class="string">&quot;{}MustNotImplDrop&quot;</span>, ident);
<span class="macro">quote! </span>{
<span class="comment">// There are two possible cases:
// 1. The user type does not implement Drop. In this case,
// the first blanked impl will not apply to it. This code
// will compile, as there is only one impl of MustNotImplDrop for the user type
// 2. The user type does impl Drop. This will make the blanket impl applicable,
// which will then conflict with the explicit MustNotImplDrop impl below.
// This will result in a compilation error, which is exactly what we want.
</span><span class="kw">trait </span>#trait_ident {}
<span class="attribute">#[allow(clippy::drop_bounds, drop_bounds)]
</span><span class="kw">impl</span>&lt;T: _pin_project::__private::Drop&gt; #trait_ident <span class="kw">for </span>T {}
<span class="kw">impl </span>#impl_generics #trait_ident <span class="kw">for </span>#ident #ty_generics #where_clause {}
<span class="comment">// Generate a dummy impl of `PinnedDrop`, to ensure that the user cannot implement it.
// Since the user did not pass `PinnedDrop` to `#[pin_project]`, any `PinnedDrop`
// impl will not actually be called. Unfortunately, we can&#39;t detect this situation
// directly from either the `#[pin_project]` or `#[pinned_drop]` attributes, since
// we don&#39;t know what other attributes/impl may exist.
//
// To ensure that users don&#39;t accidentally write a non-functional `PinnedDrop`
// impls, we emit one ourselves. If the user ends up writing a `PinnedDrop` impl,
// they&#39;ll get a &quot;conflicting implementations of trait&quot; error when coherence
// checks are run.
</span><span class="attribute">#[doc(hidden)]
</span><span class="kw">impl </span>#impl_generics _pin_project::__private::PinnedDrop <span class="kw">for </span>#ident #ty_generics
#where_clause
{
<span class="kw">unsafe fn </span>drop(<span class="self">self</span>: _pin_project::__private::Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;) {}
}
}
}
}
<span class="doccomment">/// Creates an implementation of the projection methods.
///
/// On structs, both the `project` and `project_ref` methods are always generated,
/// and the `project_replace` method is only generated if `ProjReplace::span` is `Some`.
///
/// On enums, only methods that the returned projected type is named will be generated.
</span><span class="kw">fn </span>make_proj_impl(
cx: <span class="kw-2">&amp;</span>Context&lt;<span class="lifetime">&#39;_</span>&gt;,
proj_body: <span class="kw-2">&amp;</span>TokenStream,
proj_ref_body: <span class="kw-2">&amp;</span>TokenStream,
proj_own_body: <span class="kw-2">&amp;</span>TokenStream,
) -&gt; TokenStream {
<span class="kw">let </span>vis = <span class="kw-2">&amp;</span>cx.proj.vis;
<span class="kw">let </span>lifetime = <span class="kw-2">&amp;</span>cx.proj.lifetime;
<span class="kw">let </span>orig_ident = cx.orig.ident;
<span class="kw">let </span>proj_ident = <span class="kw-2">&amp;</span>cx.proj.mut_ident;
<span class="kw">let </span>proj_ref_ident = <span class="kw-2">&amp;</span>cx.proj.ref_ident;
<span class="kw">let </span>proj_own_ident = <span class="kw-2">&amp;</span>cx.proj.own_ident;
<span class="kw">let </span>orig_ty_generics = cx.orig.generics.split_for_impl().<span class="number">1</span>;
<span class="kw">let </span>proj_ty_generics = cx.proj.generics.split_for_impl().<span class="number">1</span>;
<span class="kw">let </span>(impl_generics, ty_generics, where_clause) = cx.orig.generics.split_for_impl();
<span class="comment">// TODO: For enums and project_replace, dead_code warnings should not be
// allowed because methods are not generated unless explicitly specified.
// However, there is currently no good way to allow warnings for generated
// code, so we allow warnings for all methods for now.
</span><span class="kw">let </span>allow_dead_code = <span class="macro">quote! </span>{ <span class="attribute">#[allow(dead_code)] </span>};
<span class="kw">let </span><span class="kw-2">mut </span>project = <span class="prelude-val">Some</span>(<span class="macro">quote! </span>{
#allow_dead_code
#vis <span class="kw">fn </span>project&lt;#lifetime&gt;(
<span class="self">self</span>: _pin_project::__private::Pin&lt;<span class="kw-2">&amp;</span>#lifetime <span class="kw-2">mut </span><span class="self">Self</span>&gt;,
) -&gt; #proj_ident #proj_ty_generics {
<span class="kw">unsafe </span>{
#proj_body
}
}
});
<span class="kw">let </span><span class="kw-2">mut </span>project_ref = <span class="prelude-val">Some</span>(<span class="macro">quote! </span>{
#allow_dead_code
<span class="attribute">#[allow(clippy::missing_const_for_fn)]
</span>#vis <span class="kw">fn </span>project_ref&lt;#lifetime&gt;(
<span class="self">self</span>: _pin_project::__private::Pin&lt;<span class="kw-2">&amp;</span>#lifetime <span class="self">Self</span>&gt;,
) -&gt; #proj_ref_ident #proj_ty_generics {
<span class="kw">unsafe </span>{
#proj_ref_body
}
}
});
<span class="kw">let </span><span class="kw-2">mut </span>project_replace = cx.project_replace.span().map(|span| {
<span class="comment">// It is enough to only set the span of the signature.
</span><span class="kw">let </span>sig = <span class="macro">quote_spanned! </span>{ span =&gt;
#allow_dead_code
#vis <span class="kw">fn </span>project_replace(
<span class="self">self</span>: _pin_project::__private::Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;,
__replacement: <span class="self">Self</span>,
) -&gt; #proj_own_ident #orig_ty_generics
};
<span class="macro">quote! </span>{
#sig {
<span class="kw">unsafe </span>{
<span class="kw">let </span>__self_ptr: <span class="kw-2">*mut </span><span class="self">Self </span>= <span class="self">self</span>.get_unchecked_mut();
<span class="comment">// Destructors will run in reverse order, so next create a guard to overwrite
// `self` with the replacement value without calling destructors.
</span><span class="kw">let </span>__guard = _pin_project::__private::UnsafeOverwriteGuard::new(
__self_ptr,
__replacement,
);
#proj_own_body
}
}
}
});
<span class="kw">if </span>cx.kind == Enum {
<span class="kw">if </span>!cx.project {
project = <span class="prelude-val">None</span>;
}
<span class="kw">if </span>!cx.project_ref {
project_ref = <span class="prelude-val">None</span>;
}
<span class="kw">if </span>cx.project_replace.ident().is_none() {
project_replace = <span class="prelude-val">None</span>;
}
}
<span class="macro">quote! </span>{
<span class="kw">impl </span>#impl_generics #orig_ident #ty_generics #where_clause {
#project
#project_ref
#project_replace
}
}
}
<span class="doccomment">/// Checks that the `[repr(packed)]` attribute is not included.
///
/// This currently does two checks:
/// - Checks the attributes of structs to ensure there is no `[repr(packed)]`.
/// - Generates a function that borrows fields without an unsafe block and
/// forbidding `unaligned_references` lint.
</span><span class="kw">fn </span>ensure_not_packed(orig: <span class="kw-2">&amp;</span>OriginalType&lt;<span class="lifetime">&#39;_</span>&gt;, fields: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>Fields&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;TokenStream&gt; {
<span class="kw">for </span>attr <span class="kw">in </span>orig.attrs {
<span class="kw">if let </span>Meta::List(<span class="kw-2">ref </span>list) = attr.meta {
<span class="kw">if </span>list.path.is_ident(<span class="string">&quot;repr&quot;</span>) {
<span class="kw">for </span>repr <span class="kw">in </span>list.parse_args_with(Punctuated::&lt;Meta, <span class="macro">Token!</span>[,]&gt;::parse_terminated)<span class="question-mark">? </span>{
<span class="kw">if </span>repr.path().is_ident(<span class="string">&quot;packed&quot;</span>) {
<span class="kw">let </span>msg = <span class="kw">if </span>fields.is_none() {
<span class="comment">// #[repr(packed)] cannot be apply on enums and will be rejected by rustc.
// However, we should not rely on the behavior of rustc that rejects this.
// https://github.com/taiki-e/pin-project/pull/324#discussion_r612388001
</span><span class="string">&quot;#[repr(packed)] attribute should be applied to a struct or union&quot;
</span>} <span class="kw">else if </span>repr.require_name_value().is_ok() {
<span class="comment">// #[repr(packed = &quot;&quot;)] is not valid format of #[repr(packed)] and will be
// rejected by rustc.
// However, we should not rely on the behavior of rustc that rejects this.
// https://github.com/taiki-e/pin-project/pull/324#discussion_r612388001
</span><span class="string">&quot;#[repr(packed)] attribute should not be name-value pair&quot;
</span>} <span class="kw">else </span>{
<span class="string">&quot;#[pin_project] attribute may not be used on #[repr(packed)] types&quot;
</span>};
<span class="macro">bail!</span>(repr, msg);
}
}
}
}
}
<span class="kw">let </span>fields = <span class="kw">match </span>fields {
<span class="prelude-val">Some</span>(fields) =&gt; fields,
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="prelude-val">Ok</span>(TokenStream::new()),
};
<span class="comment">// Workaround for https://github.com/taiki-e/pin-project/issues/32
// Through the tricky use of proc macros, it&#39;s possible to bypass
// the above check for the `repr` attribute.
// To ensure that it&#39;s impossible to use pin projections on a `#[repr(packed)]`
// struct, we generate code like this:
//
// ```rust
// #[forbid(unaligned_references)]
// fn assert_not_repr_packed(val: &amp;MyStruct) {
// let _field_1 = &amp;val.field_1;
// let _field_2 = &amp;val.field_2;
// ...
// let _field_n = &amp;val.field_n;
// }
// ```
//
// Taking a reference to a packed field is UB, and applying
// `#[forbid(unaligned_references)]` makes sure that doing this is a hard error.
//
// If the struct ends up having `#[repr(packed)]` applied somehow,
// this will generate an (unfriendly) error message. Under all reasonable
// circumstances, we&#39;ll detect the `#[repr(packed)]` attribute, and generate
// a much nicer error above.
//
// There is one exception: If the type of a struct field has an alignment of 1
// (e.g. u8), it is always safe to take a reference to it, even if the struct
// is `#[repr(packed)]`. If the struct is composed entirely of types of
// alignment 1, our generated method will not trigger an error if the
// struct is `#[repr(packed)]`.
//
// Fortunately, this should have no observable consequence - `#[repr(packed)]`
// is essentially a no-op on such a type. Nevertheless, we include a test
// to ensure that the compiler doesn&#39;t ever try to copy the fields on
// such a struct when trying to drop it - which is reason we prevent
// `#[repr(packed)]` in the first place.
//
// See also https://github.com/taiki-e/pin-project/pull/34.
//
// Note:
// - Lint-based tricks aren&#39;t perfect, but they&#39;re much better than nothing:
// https://github.com/taiki-e/pin-project-lite/issues/26
//
// - Enable both unaligned_references and safe_packed_borrows lints
// because unaligned_references lint does not exist in older compilers:
// https://github.com/taiki-e/pin-project-lite/pull/55
// https://github.com/rust-lang/rust/pull/82525
</span><span class="kw">let </span><span class="kw-2">mut </span>field_refs = <span class="macro">vec!</span>[];
<span class="kw">match </span>fields {
Fields::Named(FieldsNamed { named, .. }) =&gt; {
<span class="kw">for </span>Field { ident, .. } <span class="kw">in </span>named {
field_refs.push(<span class="macro">quote!</span>(<span class="kw-2">&amp;</span>this.#ident));
}
}
Fields::Unnamed(FieldsUnnamed { unnamed, .. }) =&gt; {
<span class="kw">for </span>(index, <span class="kw">_</span>) <span class="kw">in </span>unnamed.iter().enumerate() {
<span class="kw">let </span>index = Index::from(index);
field_refs.push(<span class="macro">quote!</span>(<span class="kw-2">&amp;</span>this.#index));
}
}
Fields::Unit =&gt; {}
}
<span class="kw">let </span>(impl_generics, ty_generics, where_clause) = orig.generics.split_for_impl();
<span class="kw">let </span>ident = orig.ident;
<span class="prelude-val">Ok</span>(<span class="macro">quote! </span>{
<span class="attribute">#[forbid(unaligned_references, safe_packed_borrows)]
</span><span class="kw">fn </span>__assert_not_repr_packed #impl_generics (this: <span class="kw-2">&amp;</span>#ident #ty_generics) #where_clause {
#(<span class="kw">let _ </span>= #field_refs;)*
}
})
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="pin_project_internal" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>