blob: 9b8508f3de567a6ec0625c3ad526b1f4b01b7ea9 [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/pinned_drop.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>pinned_drop.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>
</pre><pre class="rust"><code><span class="kw">use </span>proc_macro2::TokenStream;
<span class="kw">use </span>quote::{format_ident, quote, ToTokens};
<span class="kw">use </span>syn::{
parse_quote, spanned::Spanned, token::Colon, visit_mut::VisitMut, Error, FnArg,
GenericArgument, Ident, ImplItem, ItemImpl, Pat, PatIdent, PatType, Path, PathArguments,
<span class="prelude-ty">Result</span>, ReturnType, Signature, Token, Type, TypePath, TypeReference,
};
<span class="kw">use </span><span class="kw">crate</span>::utils::{ReplaceReceiver, SliceExt};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>attribute(args: <span class="kw-2">&amp;</span>TokenStream, <span class="kw-2">mut </span>input: ItemImpl) -&gt; TokenStream {
<span class="kw">let </span>res = (|| -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="kw">if </span>!args.is_empty() {
<span class="macro">bail!</span>(args, <span class="string">&quot;unexpected argument: `{}`&quot;</span>, args)
}
validate_impl(<span class="kw-2">&amp;</span>input)<span class="question-mark">?</span>;
expand_impl(<span class="kw-2">&amp;mut </span>input);
<span class="prelude-val">Ok</span>(())
})();
<span class="kw">if let </span><span class="prelude-val">Err</span>(e) = res {
<span class="kw">let </span><span class="kw-2">mut </span>tokens = e.to_compile_error();
<span class="kw">if let </span>Type::Path(self_ty) = <span class="kw-2">&amp;*</span>input.self_ty {
<span class="kw">let </span>(impl_generics, <span class="kw">_</span>, where_clause) = input.generics.split_for_impl();
<span class="comment">// Generate a dummy impl of `PinnedDrop`.
// In many cases, `#[pinned_drop] impl` is declared after `#[pin_project]`.
// Therefore, if `pinned_drop` compile fails, you will also get an error
// about `PinnedDrop` not being implemented.
// This can be prevented to some extent by generating a dummy
// `PinnedDrop` implementation.
// We already know that we will get a compile error, so this won&#39;t
// accidentally compile successfully.
//
// However, if `input.self_ty` is not Type::Path, there is a high possibility that
// the type does not exist (since #[pin_project] can only be used on struct/enum
// definitions), so do not generate a dummy impl.
</span>tokens.extend(<span class="macro">quote! </span>{
<span class="kw">impl </span>#impl_generics ::pin_project::__private::PinnedDrop <span class="kw">for </span>#self_ty
#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;) {}
}
});
}
tokens
} <span class="kw">else </span>{
input.into_token_stream()
}
}
<span class="doccomment">/// Validates the signature of given `PinnedDrop` impl.
</span><span class="kw">fn </span>validate_impl(item: <span class="kw-2">&amp;</span>ItemImpl) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="kw">const </span>INVALID_ITEM: <span class="kw-2">&amp;</span>str =
<span class="string">&quot;#[pinned_drop] may only be used on implementation for the `PinnedDrop` trait&quot;</span>;
<span class="kw">if let </span><span class="prelude-val">Some</span>(attr) = item.attrs.find(<span class="string">&quot;pinned_drop&quot;</span>) {
<span class="macro">bail!</span>(attr, <span class="string">&quot;duplicate #[pinned_drop] attribute&quot;</span>);
}
<span class="kw">if let </span><span class="prelude-val">Some</span>((<span class="kw">_</span>, path, <span class="kw">_</span>)) = <span class="kw-2">&amp;</span>item.trait_ {
<span class="kw">if </span>!path.is_ident(<span class="string">&quot;PinnedDrop&quot;</span>) {
<span class="macro">bail!</span>(path, INVALID_ITEM);
}
} <span class="kw">else </span>{
<span class="macro">bail!</span>(item.self_ty, INVALID_ITEM);
}
<span class="kw">if </span>item.unsafety.is_some() {
<span class="macro">bail!</span>(item.unsafety, <span class="string">&quot;implementing the trait `PinnedDrop` is not unsafe&quot;</span>);
}
<span class="kw">if </span>item.items.is_empty() {
<span class="macro">bail!</span>(item, <span class="string">&quot;not all trait items implemented, missing: `drop`&quot;</span>);
}
<span class="kw">match </span><span class="kw-2">&amp;*</span>item.self_ty {
Type::Path(<span class="kw">_</span>) =&gt; {}
ty =&gt; {
<span class="macro">bail!</span>(ty, <span class="string">&quot;implementing the trait `PinnedDrop` on this type is unsupported&quot;</span>);
}
}
item.items.iter().enumerate().try_for_each(|(i, item)| <span class="kw">match </span>item {
ImplItem::Const(item) =&gt; {
<span class="macro">bail!</span>(item, <span class="string">&quot;const `{}` is not a member of trait `PinnedDrop`&quot;</span>, item.ident)
}
ImplItem::Type(item) =&gt; {
<span class="macro">bail!</span>(item, <span class="string">&quot;type `{}` is not a member of trait `PinnedDrop`&quot;</span>, item.ident)
}
ImplItem::Fn(method) =&gt; {
validate_sig(<span class="kw-2">&amp;</span>method.sig)<span class="question-mark">?</span>;
<span class="kw">if </span>i == <span class="number">0 </span>{
<span class="prelude-val">Ok</span>(())
} <span class="kw">else </span>{
<span class="macro">bail!</span>(method, <span class="string">&quot;duplicate definitions with name `drop`&quot;</span>)
}
}
<span class="kw">_ </span>=&gt; <span class="macro">unreachable!</span>(<span class="string">&quot;unexpected ImplItem&quot;</span>),
})
}
<span class="doccomment">/// Validates the signature of given `PinnedDrop::drop` method.
///
/// The correct signature is: `(mut) self: (&lt;path&gt;::)Pin&lt;&amp;mut Self&gt;`
</span><span class="kw">fn </span>validate_sig(sig: <span class="kw-2">&amp;</span>Signature) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="kw">fn </span>get_ty_path(ty: <span class="kw-2">&amp;</span>Type) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>Path&gt; {
<span class="kw">if let </span>Type::Path(TypePath { qself: <span class="prelude-val">None</span>, path }) = ty {
<span class="prelude-val">Some</span>(path)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="kw">const </span>INVALID_ARGUMENT: <span class="kw-2">&amp;</span>str = <span class="string">&quot;method `drop` must take an argument `self: Pin&lt;&amp;mut Self&gt;`&quot;</span>;
<span class="kw">if </span>sig.ident != <span class="string">&quot;drop&quot; </span>{
<span class="macro">bail!</span>(sig.ident, <span class="string">&quot;method `{}` is not a member of trait `PinnedDrop&quot;</span>, sig.ident,);
}
<span class="kw">if let </span>ReturnType::Type(<span class="kw">_</span>, ty) = <span class="kw-2">&amp;</span>sig.output {
<span class="kw">match </span><span class="kw-2">&amp;**</span>ty {
Type::Tuple(ty) <span class="kw">if </span>ty.elems.is_empty() =&gt; {}
<span class="kw">_ </span>=&gt; <span class="macro">bail!</span>(ty, <span class="string">&quot;method `drop` must return the unit type&quot;</span>),
}
}
<span class="kw">match </span>sig.inputs.len() {
<span class="number">1 </span>=&gt; {}
<span class="number">0 </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::new(sig.paren_token.span.join(), INVALID_ARGUMENT)),
<span class="kw">_ </span>=&gt; <span class="macro">bail!</span>(sig.inputs, INVALID_ARGUMENT),
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(arg) = sig.receiver() {
<span class="comment">// (mut) self: &lt;path&gt;
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(path) = get_ty_path(<span class="kw-2">&amp;</span>arg.ty) {
<span class="kw">let </span>ty =
path.segments.last().expect(<span class="string">&quot;Type paths should always have at least one segment&quot;</span>);
<span class="kw">if let </span>PathArguments::AngleBracketed(args) = <span class="kw-2">&amp;</span>ty.arguments {
<span class="comment">// (mut) self: (&lt;path&gt;::)&lt;ty&gt;&lt;&amp;mut &lt;elem&gt;..&gt;
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(GenericArgument::Type(Type::Reference(TypeReference {
mutability: <span class="prelude-val">Some</span>(<span class="kw">_</span>),
elem,
..
}))) = args.args.first()
{
<span class="comment">// (mut) self: (&lt;path&gt;::)Pin&lt;&amp;mut Self&gt;
</span><span class="kw">if </span>args.args.len() == <span class="number">1
</span>&amp;&amp; ty.ident == <span class="string">&quot;Pin&quot;
</span>&amp;&amp; get_ty_path(elem).map_or(<span class="bool-val">false</span>, |path| path.is_ident(<span class="string">&quot;Self&quot;</span>))
{
<span class="kw">if </span>sig.unsafety.is_some() {
<span class="macro">bail!</span>(sig.unsafety, <span class="string">&quot;implementing the method `drop` is not unsafe&quot;</span>);
}
<span class="kw">return </span><span class="prelude-val">Ok</span>(());
}
}
}
}
}
<span class="macro">bail!</span>(sig.inputs[<span class="number">0</span>], INVALID_ARGUMENT)
}
<span class="comment">// from:
//
// fn drop(self: Pin&lt;&amp;mut Self&gt;) {
// // ...
// }
//
// into:
//
// unsafe fn drop(self: Pin&lt;&amp;mut Self&gt;) {
// fn __drop_inner&lt;T&gt;(__self: Pin&lt;&amp;mut Foo&lt;&#39;_, T&gt;&gt;) {
// fn __drop_inner() {}
// // ...
// }
// __drop_inner(self);
// }
//
</span><span class="kw">fn </span>expand_impl(item: <span class="kw-2">&amp;mut </span>ItemImpl) {
<span class="comment">// `PinnedDrop` is a private trait and should not appear in docs.
</span>item.attrs.push(<span class="macro">parse_quote!</span>(<span class="attribute">#[doc(hidden)]</span>));
<span class="kw">let </span>path = <span class="kw-2">&amp;mut </span>item.trait_.as_mut().expect(<span class="string">&quot;unexpected inherent impl&quot;</span>).<span class="number">1</span>;
<span class="kw-2">*</span>path = <span class="macro">parse_quote_spanned! </span>{ path.span() =&gt;
::pin_project::__private::PinnedDrop
};
<span class="kw">let </span>method =
<span class="kw">if let </span>ImplItem::Fn(method) = <span class="kw-2">&amp;mut </span>item.items[<span class="number">0</span>] { method } <span class="kw">else </span>{ <span class="macro">unreachable!</span>() };
<span class="comment">// `fn drop(mut self: Pin&lt;&amp;mut Self&gt;)` -&gt; `fn __drop_inner&lt;T&gt;(mut __self: Pin&lt;&amp;mut Receiver&gt;)`
</span><span class="kw">let </span>drop_inner = {
<span class="kw">let </span><span class="kw-2">mut </span>drop_inner = method.clone();
<span class="kw">let </span>ident = <span class="macro">format_ident!</span>(<span class="string">&quot;__drop_inner&quot;</span>);
<span class="comment">// Add a dummy `__drop_inner` function to prevent users call outer `__drop_inner`.
</span>drop_inner.block.stmts.insert(<span class="number">0</span>, <span class="macro">parse_quote!</span>(<span class="kw">fn </span>#ident() {}));
drop_inner.sig.ident = ident;
drop_inner.sig.generics = item.generics.clone();
<span class="kw">let </span>receiver = drop_inner.sig.receiver().expect(<span class="string">&quot;drop() should have a receiver&quot;</span>).clone();
<span class="kw">let </span>pat = Box::new(Pat::Ident(PatIdent {
attrs: Vec::new(),
by_ref: <span class="prelude-val">None</span>,
mutability: receiver.mutability,
ident: Ident::new(<span class="string">&quot;__self&quot;</span>, receiver.self_token.span()),
subpat: <span class="prelude-val">None</span>,
}));
drop_inner.sig.inputs[<span class="number">0</span>] = FnArg::Typed(PatType {
attrs: receiver.attrs,
pat,
colon_token: Colon::default(),
ty: receiver.ty,
});
<span class="kw">let </span>self_ty = <span class="kw">if let </span>Type::Path(ty) = <span class="kw-2">&amp;*</span>item.self_ty { ty } <span class="kw">else </span>{ <span class="macro">unreachable!</span>() };
<span class="kw">let </span><span class="kw-2">mut </span>visitor = ReplaceReceiver(self_ty);
visitor.visit_signature_mut(<span class="kw-2">&amp;mut </span>drop_inner.sig);
visitor.visit_block_mut(<span class="kw-2">&amp;mut </span>drop_inner.block);
drop_inner
};
<span class="comment">// `fn drop(mut self: Pin&lt;&amp;mut Self&gt;)` -&gt; `unsafe fn drop(self: Pin&lt;&amp;mut Self&gt;)`
</span>method.sig.unsafety = <span class="prelude-val">Some</span>(&lt;<span class="macro">Token!</span>[<span class="kw">unsafe</span>]&gt;::default());
<span class="kw">let </span>self_token = <span class="kw">if let </span>FnArg::Receiver(<span class="kw-2">ref mut </span>rec) = method.sig.inputs[<span class="number">0</span>] {
rec.mutability = <span class="prelude-val">None</span>;
<span class="kw-2">&amp;</span>rec.self_token
} <span class="kw">else </span>{
<span class="macro">panic!</span>(<span class="string">&quot;drop() should have a receiver&quot;</span>)
};
method.block.stmts = <span class="macro">parse_quote! </span>{
<span class="attribute">#[allow(clippy::needless_pass_by_value)] </span><span class="comment">// This lint does not warn the receiver.
</span>#drop_inner
__drop_inner(#self_token);
};
}
</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>