154 lines
46 KiB
HTML
154 lines
46 KiB
HTML
<!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="An attribute like `#[repr(transparent)]`."><meta name="keywords" content="rust, rustlang, rust-lang, Attribute"><title>Attribute in syn - Rust</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" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.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 struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../syn/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../syn/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Attribute</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#fields">Fields</a></h3><ul><li><a href="#structfield.bracket_token">bracket_token</a></li><li><a href="#structfield.path">path</a></li><li><a href="#structfield.pound_token">pound_token</a></li><li><a href="#structfield.style">style</a></li><li><a href="#structfield.tokens">tokens</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul><li><a href="#method.parse_args">parse_args</a></li><li><a href="#method.parse_args_with">parse_args_with</a></li><li><a href="#method.parse_inner">parse_inner</a></li><li><a href="#method.parse_meta">parse_meta</a></li><li><a href="#method.parse_outer">parse_outer</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><ul><li><a href="#impl-Clone-for-Attribute">Clone</a></li><li><a href="#impl-ToTokens-for-Attribute">ToTokens</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul><li><a href="#impl-RefUnwindSafe-for-Attribute">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Attribute">!Send</a></li><li><a href="#impl-Sync-for-Attribute">!Sync</a></li><li><a href="#impl-Unpin-for-Attribute">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Attribute">UnwindSafe</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><ul><li><a href="#impl-Any-for-Attribute">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Attribute">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Attribute">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Attribute">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Attribute">Into<U></a></li><li><a href="#impl-Spanned-for-Attribute">Spanned</a></li><li><a href="#impl-ToOwned-for-Attribute">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Attribute">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Attribute">TryInto<U></a></li></ul></div></section><h2 class="location"><a href="index.html">In syn</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../syn/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">syn</a>::<wbr><a class="struct" href="#">Attribute</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/syn/attr.rs.html#12-156">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust struct"><code>pub struct Attribute {
|
||
pub pound_token: <a class="struct" href="token/struct.Pound.html" title="struct syn::token::Pound">Pound</a>,
|
||
pub style: <a class="enum" href="enum.AttrStyle.html" title="enum syn::AttrStyle">AttrStyle</a>,
|
||
pub bracket_token: <a class="struct" href="token/struct.Bracket.html" title="struct syn::token::Bracket">Bracket</a>,
|
||
pub path: <a class="struct" href="struct.Path.html" title="struct syn::Path">Path</a>,
|
||
pub tokens: <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>,
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An attribute like <code>#[repr(transparent)]</code>.</p>
|
||
<p><em>This type is available only if Syn is built with the <code>"derive"</code> or <code>"full"</code>
|
||
feature.</em></p>
|
||
<br>
|
||
<h2 id="syntax"><a href="#syntax">Syntax</a></h2>
|
||
<p>Rust has six types of attributes.</p>
|
||
<ul>
|
||
<li>Outer attributes like <code>#[repr(transparent)]</code>. These appear outside or
|
||
in front of the item they describe.</li>
|
||
<li>Inner attributes like <code>#![feature(proc_macro)]</code>. These appear inside
|
||
of the item they describe, usually a module.</li>
|
||
<li>Outer doc comments like <code>/// # Example</code>.</li>
|
||
<li>Inner doc comments like <code>//! Please file an issue</code>.</li>
|
||
<li>Outer block comments <code>/** # Example */</code>.</li>
|
||
<li>Inner block comments <code>/*! Please file an issue */</code>.</li>
|
||
</ul>
|
||
<p>The <code>style</code> field of type <code>AttrStyle</code> distinguishes whether an attribute
|
||
is outer or inner. Doc comments and block comments are promoted to
|
||
attributes, as this is how they are processed by the compiler and by
|
||
<code>macro_rules!</code> macros.</p>
|
||
<p>The <code>path</code> field gives the possibly colon-delimited path against which
|
||
the attribute is resolved. It is equal to <code>"doc"</code> for desugared doc
|
||
comments. The <code>tokens</code> field contains the rest of the attribute body as
|
||
tokens.</p>
|
||
<div class="example-wrap"><pre class="language-text"><code>#[derive(Copy)] #[crate::precondition x < 5]
|
||
^^^^^^~~~~~~ ^^^^^^^^^^^^^^^^^^^ ~~~~~
|
||
path tokens path tokens</code></pre></div><br>
|
||
<h2 id="parsing-from-tokens-to-attribute"><a href="#parsing-from-tokens-to-attribute">Parsing from tokens to Attribute</a></h2>
|
||
<p>This type does not implement the <a href="parse/trait.Parse.html"><code>Parse</code></a> trait and thus cannot be
|
||
parsed directly by <a href="parse/struct.ParseBuffer.html#method.parse"><code>ParseStream::parse</code></a>. Instead use
|
||
<a href="parse/struct.ParseBuffer.html#method.call"><code>ParseStream::call</code></a> with one of the two parser functions
|
||
<a href="struct.Attribute.html#method.parse_outer" title="Attribute::parse_outer"><code>Attribute::parse_outer</code></a> or <a href="struct.Attribute.html#method.parse_inner" title="Attribute::parse_inner"><code>Attribute::parse_inner</code></a> depending on
|
||
which you intend to parse.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">Attribute</span>, <span class="ident">Ident</span>, <span class="prelude-ty">Result</span>, <span class="ident">Token</span>};
|
||
<span class="kw">use</span> <span class="ident">syn::parse</span>::{<span class="ident">Parse</span>, <span class="ident">ParseStream</span>};
|
||
|
||
<span class="comment">// Parses a unit struct with attributes.</span>
|
||
<span class="comment">//</span>
|
||
<span class="comment">// #[path = "s.tmpl"]</span>
|
||
<span class="comment">// struct S;</span>
|
||
<span class="kw">struct</span> <span class="ident">UnitStruct</span> {
|
||
<span class="ident">attrs</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">Attribute</span><span class="op">></span>,
|
||
<span class="ident">struct_token</span>: <span class="macro">Token!</span>[<span class="kw">struct</span>],
|
||
<span class="ident">name</span>: <span class="ident">Ident</span>,
|
||
<span class="ident">semi_token</span>: <span class="macro">Token!</span>[;],
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">Parse</span> <span class="kw">for</span> <span class="ident">UnitStruct</span> {
|
||
<span class="kw">fn</span> <span class="ident">parse</span>(<span class="ident">input</span>: <span class="ident">ParseStream</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span><span class="op">></span> {
|
||
<span class="prelude-val">Ok</span>(<span class="ident">UnitStruct</span> {
|
||
<span class="ident">attrs</span>: <span class="ident">input</span>.<span class="ident">call</span>(<span class="ident">Attribute::parse_outer</span>)<span class="question-mark">?</span>,
|
||
<span class="ident">struct_token</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||
<span class="ident">name</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||
<span class="ident">semi_token</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||
})
|
||
}
|
||
}</code></pre></div>
|
||
<p><br></p>
|
||
<h2 id="parsing-from-attribute-to-structured-arguments"><a href="#parsing-from-attribute-to-structured-arguments">Parsing from Attribute to structured arguments</a></h2>
|
||
<p>The grammar of attributes in Rust is very flexible, which makes the
|
||
syntax tree not that useful on its own. In particular, arguments of the
|
||
attribute are held in an arbitrary <code>tokens: TokenStream</code>. Macros are
|
||
expected to check the <code>path</code> of the attribute, decide whether they
|
||
recognize it, and then parse the remaining tokens according to whatever
|
||
grammar they wish to require for that kind of attribute.</p>
|
||
<p>If the attribute you are parsing is expected to conform to the
|
||
conventional structured form of attribute, use <a href="struct.Attribute.html#method.parse_meta"><code>parse_meta()</code></a> to
|
||
obtain that structured representation. If the attribute follows some
|
||
other grammar of its own, use <a href="struct.Attribute.html#method.parse_args"><code>parse_args()</code></a> to parse that into the
|
||
expected data structure.</p>
|
||
<p><br></p>
|
||
<h2 id="doc-comments"><a href="#doc-comments">Doc comments</a></h2>
|
||
<p>The compiler transforms doc comments, such as <code>/// comment</code> and <code>/*! comment */</code>, into attributes before macros are expanded. Each comment is
|
||
expanded into an attribute of the form <code>#[doc = r"comment"]</code>.</p>
|
||
<p>As an example, the following <code>mod</code> items are expanded identically:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">doc</span>: <span class="ident">ItemMod</span> <span class="op">=</span> <span class="macro">parse_quote!</span> {
|
||
<span class="doccomment">/// Single line doc comments</span>
|
||
<span class="doccomment">/// We write so many!</span>
|
||
<span class="doccomment">/**
|
||
* Multi-line comments...
|
||
* May span many lines
|
||
*/</span>
|
||
<span class="kw">mod</span> <span class="ident">example</span> {
|
||
<span class="doccomment">//! Of course, they can be inner too</span>
|
||
<span class="doccomment">/*! And fit in a single line */</span>
|
||
}
|
||
};
|
||
<span class="kw">let</span> <span class="ident">attr</span>: <span class="ident">ItemMod</span> <span class="op">=</span> <span class="macro">parse_quote!</span> {
|
||
<span class="attribute">#[<span class="ident">doc</span> <span class="op">=</span> <span class="string">r" Single line doc comments"</span>]</span>
|
||
<span class="attribute">#[<span class="ident">doc</span> <span class="op">=</span> <span class="string">r" We write so many!"</span>]</span>
|
||
<span class="attribute">#[<span class="ident">doc</span> <span class="op">=</span> <span class="string">r"
|
||
* Multi-line comments...
|
||
* May span many lines
|
||
"</span>]</span>
|
||
<span class="kw">mod</span> <span class="ident">example</span> {
|
||
<span class="attribute">#![<span class="ident">doc</span> <span class="op">=</span> <span class="string">r" Of course, they can be inner too"</span>]</span>
|
||
<span class="attribute">#![<span class="ident">doc</span> <span class="op">=</span> <span class="string">r" And fit in a single line "</span>]</span>
|
||
}
|
||
};
|
||
<span class="macro">assert_eq!</span>(<span class="ident">doc</span>, <span class="ident">attr</span>);</code></pre></div>
|
||
</div></details><h2 id="fields" class="fields small-section-header">Fields<a href="#fields" class="anchor"></a></h2><span id="structfield.pound_token" class="structfield small-section-header"><a href="#structfield.pound_token" class="anchor field"></a><code>pound_token: <a class="struct" href="token/struct.Pound.html" title="struct syn::token::Pound">Pound</a></code></span><span id="structfield.style" class="structfield small-section-header"><a href="#structfield.style" class="anchor field"></a><code>style: <a class="enum" href="enum.AttrStyle.html" title="enum syn::AttrStyle">AttrStyle</a></code></span><span id="structfield.bracket_token" class="structfield small-section-header"><a href="#structfield.bracket_token" class="anchor field"></a><code>bracket_token: <a class="struct" href="token/struct.Bracket.html" title="struct syn::token::Bracket">Bracket</a></code></span><span id="structfield.path" class="structfield small-section-header"><a href="#structfield.path" class="anchor field"></a><code>path: <a class="struct" href="struct.Path.html" title="struct syn::Path">Path</a></code></span><span id="structfield.tokens" class="structfield small-section-header"><a href="#structfield.tokens" class="anchor field"></a><code>tokens: <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a></code></span><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Attribute" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/syn/attr.rs.html#158-257">source</a></span><a href="#impl-Attribute" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.Attribute.html" title="struct syn::Attribute">Attribute</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse_meta" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/syn/attr.rs.html#166-195">source</a></span><h4 class="code-header">pub fn <a href="#method.parse_meta" class="fnname">parse_meta</a>(&self) -> <a class="type" href="parse/type.Result.html" title="type syn::parse::Result">Result</a><<a class="enum" href="enum.Meta.html" title="enum syn::Meta">Meta</a>></h4></section></summary><div class="docblock"><p>Parses the content of the attribute, consisting of the path and tokens,
|
||
as a <a href="enum.Meta.html" title="Meta"><code>Meta</code></a> if possible.</p>
|
||
<p><em>This function is available only if Syn is built with the <code>"parsing"</code>
|
||
feature.</em></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse_args" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/syn/attr.rs.html#214-216">source</a></span><h4 class="code-header">pub fn <a href="#method.parse_args" class="fnname">parse_args</a><T: <a class="trait" href="parse/trait.Parse.html" title="trait syn::parse::Parse">Parse</a>>(&self) -> <a class="type" href="parse/type.Result.html" title="type syn::parse::Result">Result</a><T></h4></section></summary><div class="docblock"><p>Parse the arguments to the attribute as a syntax tree.</p>
|
||
<p>This is similar to <code>syn::parse2::<T>(attr.tokens)</code> except that:</p>
|
||
<ul>
|
||
<li>the surrounding delimiters are <em>not</em> included in the input to the
|
||
parser; and</li>
|
||
<li>the error message has a more useful span when <code>tokens</code> is empty.</li>
|
||
</ul>
|
||
<div class="example-wrap"><pre class="language-text"><code>#[my_attr(value < 5)]
|
||
^^^^^^^^^ what gets parsed</code></pre></div>
|
||
<p><em>This function is available only if Syn is built with the <code>"parsing"</code>
|
||
feature.</em></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse_args_with" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/syn/attr.rs.html#224-230">source</a></span><h4 class="code-header">pub fn <a href="#method.parse_args_with" class="fnname">parse_args_with</a><F: <a class="trait" href="parse/trait.Parser.html" title="trait syn::parse::Parser">Parser</a>>(&self, parser: F) -> <a class="type" href="parse/type.Result.html" title="type syn::parse::Result">Result</a><F::<a class="associatedtype" href="parse/trait.Parser.html#associatedtype.Output" title="type syn::parse::Parser::Output">Output</a>></h4></section></summary><div class="docblock"><p>Parse the arguments to the attribute using the given parser.</p>
|
||
<p><em>This function is available only if Syn is built with the <code>"parsing"</code>
|
||
feature.</em></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse_outer" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/syn/attr.rs.html#238-244">source</a></span><h4 class="code-header">pub fn <a href="#method.parse_outer" class="fnname">parse_outer</a>(input: <a class="type" href="parse/type.ParseStream.html" title="type syn::parse::ParseStream">ParseStream</a><'_>) -> <a class="type" href="parse/type.Result.html" title="type syn::parse::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><Self>></h4></section></summary><div class="docblock"><p>Parses zero or more outer attributes from the stream.</p>
|
||
<p><em>This function is available only if Syn is built with the <code>"parsing"</code>
|
||
feature.</em></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse_inner" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/syn/attr.rs.html#252-256">source</a></span><h4 class="code-header">pub fn <a href="#method.parse_inner" class="fnname">parse_inner</a>(input: <a class="type" href="parse/type.ParseStream.html" title="type syn::parse::ParseStream">ParseStream</a><'_>) -> <a class="type" href="parse/type.Result.html" title="type syn::parse::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><Self>></h4></section></summary><div class="docblock"><p>Parses zero or more inner attributes from the stream.</p>
|
||
<p><em>This function is available only if Syn is built with the <code>"parsing"</code>
|
||
feature.</em></p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-Attribute" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/syn/gen/clone.rs.html#54-64">source</a></span><a href="#impl-Clone-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.Attribute.html" title="struct syn::Attribute">Attribute</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/syn/gen/clone.rs.html#55-63">source</a></span><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> Self</h4></section></summary><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/clone.rs.html#132-134">source</a></span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>Self)</h4></section></summary><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ToTokens-for-Attribute" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/syn/attr.rs.html#631-642">source</a></span><a href="#impl-ToTokens-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a> for <a class="struct" href="struct.Attribute.html" title="struct syn::Attribute">Attribute</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_tokens" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/syn/attr.rs.html#632-641">source</a></span><a href="#method.to_tokens" class="anchor"></a><h4 class="code-header">fn <a href="../quote/to_tokens/trait.ToTokens.html#tymethod.to_tokens" class="fnname">to_tokens</a>(&self, tokens: &mut <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>)</h4></section></summary><div class='docblock'><p>Write <code>self</code> to the given <code>TokenStream</code>. <a href="../quote/to_tokens/trait.ToTokens.html#tymethod.to_tokens">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_token_stream" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/quote/to_tokens.rs.html#59">source</a></span><a href="#method.to_token_stream" class="anchor"></a><h4 class="code-header">fn <a href="../quote/to_tokens/trait.ToTokens.html#method.to_token_stream" class="fnname">to_token_stream</a>(&self) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a></h4></section></summary><div class='docblock'><p>Convert <code>self</code> directly into a <code>TokenStream</code> object. <a href="../quote/to_tokens/trait.ToTokens.html#method.to_token_stream">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_token_stream" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/quote/to_tokens.rs.html#69-71">source</a></span><a href="#method.into_token_stream" class="anchor"></a><h4 class="code-header">fn <a href="../quote/to_tokens/trait.ToTokens.html#method.into_token_stream" class="fnname">into_token_stream</a>(self) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a></h4></section></summary><div class='docblock'><p>Convert <code>self</code> directly into a <code>TokenStream</code> object. <a href="../quote/to_tokens/trait.ToTokens.html#method.into_token_stream">Read more</a></p>
|
||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Attribute" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Attribute.html" title="struct syn::Attribute">Attribute</a></h3></section><section id="impl-Send-for-Attribute" class="impl has-srclink"><a href="#impl-Send-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl !<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Attribute.html" title="struct syn::Attribute">Attribute</a></h3></section><section id="impl-Sync-for-Attribute" class="impl has-srclink"><a href="#impl-Sync-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl !<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Attribute.html" title="struct syn::Attribute">Attribute</a></h3></section><section id="impl-Unpin-for-Attribute" class="impl has-srclink"><a href="#impl-Unpin-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Attribute.html" title="struct syn::Attribute">Attribute</a></h3></section><section id="impl-UnwindSafe-for-Attribute" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Attribute.html" title="struct syn::Attribute">Attribute</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Attribute" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/any.rs.html#203">source</a></span><a href="#impl-Any-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/any.rs.html#204">source</a></span><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Attribute" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#209">source</a></span><a href="#impl-Borrow%3CT%3E-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#211">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Attribute" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#218">source</a></span><a href="#impl-BorrowMut%3CT%3E-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#219">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Attribute" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#557">source</a></span><a href="#impl-From%3CT%3E-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#559">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Attribute" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#541">source</a></span><a href="#impl-Into%3CU%3E-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#549">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Spanned-for-Attribute" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/syn/spanned.rs.html#110-114">source</a></span><a href="#impl-Spanned-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="spanned/trait.Spanned.html" title="trait syn::spanned::Spanned">Spanned</a> for T <span class="where fmt-newline">where<br> T: Spanned + ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.span" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/syn/spanned.rs.html#111-113">source</a></span><a href="#method.span" class="anchor"></a><h4 class="code-header">fn <a href="spanned/trait.Spanned.html#tymethod.span" class="fnname">span</a>(&self) -> <a class="struct" href="../proc_macro2/struct.Span.html" title="struct proc_macro2::Span">Span</a></h4></section></summary><div class='docblock'><p>Returns a <code>Span</code> covering the complete contents of this syntax tree
|
||
node, or <a href="../proc_macro2/struct.Span.html#method.call_site"><code>Span::call_site()</code></a> if this node is empty. <a href="spanned/trait.Spanned.html#tymethod.span">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-Attribute" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/borrow.rs.html#83">source</a></span><a href="#impl-ToOwned-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/borrow.rs.html#88">source</a></span><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/borrow.rs.html#92">source</a></span><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>T)</h4></section></summary><div class='docblock'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Attribute" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#598">source</a></span><a href="#impl-TryFrom%3CU%3E-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#604">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Attribute" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#583">source</a></span><a href="#impl-TryInto%3CU%3E-for-Attribute" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#589">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="syn" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |