blob: e4571e1b5898bfadfb9d683fb5b00163c6d33555 [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/attribute.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>attribute.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>
</pre><pre class="rust"><code><span class="kw">use </span>proc_macro2::TokenStream;
<span class="kw">use </span>quote::quote;
<span class="kw">use </span>syn::{
parse::{Parse, ParseStream},
Attribute, <span class="prelude-ty">Result</span>, Token, Visibility,
};
<span class="kw">use </span><span class="kw">super</span>::PIN;
<span class="kw">use </span><span class="kw">crate</span>::utils::SliceExt;
<span class="comment">// To generate the correct `Unpin` implementation and the projection methods,
// we need to collect the types of the pinned fields.
// However, since proc-macro-attribute is applied before `cfg` and `cfg_attr`
// on fields, we cannot be collecting field types properly at this timing.
// So instead of generating the `Unpin` implementation and the projection
// methods here, delegate their processing to proc-macro-derive.
//
// At this stage, only attributes are parsed and the following attributes are
// added to the attributes of the item.
// - `#[derive(InternalDerive)]` - An internal helper macro that does the above
// processing.
// - `#[pin(__private(#args))]` - Pass the argument of `#[pin_project]` to
// proc-macro-derive (`InternalDerive`).
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>parse_attribute(args: <span class="kw-2">&amp;</span>TokenStream, input: TokenStream) -&gt; <span class="prelude-ty">Result</span>&lt;TokenStream&gt; {
<span class="kw">let </span>Input { attrs, body } = syn::parse2(input)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="macro">quote! </span>{
#(#attrs)*
<span class="attribute">#[derive(::pin_project::__private::__PinProjectInternalDerive)]
</span><span class="comment">// Use `__private` to prevent users from trying to control `InternalDerive`
// manually. `__private` does not guarantee compatibility between patch
// versions, so it should be sufficient for this purpose in most cases.
</span><span class="attribute">#[pin(__private(#args))]
</span>#body
})
}
<span class="attribute">#[allow(dead_code)] </span><span class="comment">// false positive that fixed in Rust 1.39
</span><span class="kw">struct </span>Input {
attrs: Vec&lt;Attribute&gt;,
body: TokenStream,
}
<span class="kw">impl </span>Parse <span class="kw">for </span>Input {
<span class="kw">fn </span>parse(input: ParseStream&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>&gt; {
<span class="kw">let </span>attrs = input.call(Attribute::parse_outer)<span class="question-mark">?</span>;
<span class="kw">let </span>ahead = input.fork();
<span class="kw">let </span>_vis: Visibility = ahead.parse()<span class="question-mark">?</span>;
<span class="kw">if </span>!ahead.peek(<span class="macro">Token!</span>[<span class="kw">struct</span>]) &amp;&amp; !ahead.peek(<span class="macro">Token!</span>[<span class="kw">enum</span>]) {
<span class="comment">// If we check this only on proc-macro-derive, it may generate unhelpful error
// messages. So it is preferable to be able to detect it here.
</span><span class="macro">bail!</span>(
input.parse::&lt;TokenStream&gt;()<span class="question-mark">?</span>,
<span class="string">&quot;#[pin_project] attribute may only be used on structs or enums&quot;
</span>);
} <span class="kw">else if let </span><span class="prelude-val">Some</span>(attr) = 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 let </span><span class="prelude-val">Some</span>(attr) = attrs.find(<span class="string">&quot;pin_project&quot;</span>) {
<span class="macro">bail!</span>(attr, <span class="string">&quot;duplicate #[pin_project] attribute&quot;</span>);
}
<span class="prelude-val">Ok</span>(<span class="self">Self </span>{ attrs, body: input.parse()<span class="question-mark">? </span>})
}
}
</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>