28 lines
5.6 KiB
HTML
28 lines
5.6 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="API documentation for the Rust `AttributeArgs` type in crate `syn`."><meta name="keywords" content="rust, rustlang, rust-lang, AttributeArgs"><title>syn::AttributeArgs - Rust</title><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
|||
|
|
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
|||
|
|
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc type"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../syn/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Type Definition AttributeArgs</p><div class="sidebar-elems"><p class="location"><a href="index.html">syn</a></p><script>window.sidebarCurrent = {name: "AttributeArgs", ty: "type", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
|
|||
|
|
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/syn/attr.rs.html#465" title="goto source code">[src]</a></span><span class="in-band">Type Definition <a href="index.html">syn</a>::<wbr><a class="type" href="">AttributeArgs</a></span></h1><pre class="rust typedef">type AttributeArgs = <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="../syn/enum.NestedMeta.html" title="enum syn::NestedMeta">NestedMeta</a>>;</pre><div class="docblock"><p>Conventional argument type associated with an invocation of an attribute
|
|||
|
|
macro.</p>
|
|||
|
|
<p>For example if we are developing an attribute macro that is intended to be
|
|||
|
|
invoked on function items as follows:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="attribute">#[<span class="ident">my_attribute</span>(<span class="ident">path</span> <span class="op">=</span> <span class="string">"/v1/refresh"</span>)]</span>
|
|||
|
|
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">refresh</span>() {
|
|||
|
|
<span class="comment">/* ... */</span>
|
|||
|
|
}</pre></div>
|
|||
|
|
<p>The implementation of this macro would want to parse its attribute arguments
|
|||
|
|
as type <code>AttributeArgs</code>.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">proc_macro</span>::<span class="ident">TokenStream</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">parse_macro_input</span>, <span class="ident">AttributeArgs</span>, <span class="ident">ItemFn</span>};
|
|||
|
|
|
|||
|
|
<span class="attribute">#[<span class="ident">proc_macro_attribute</span>]</span>
|
|||
|
|
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">my_attribute</span>(<span class="ident">args</span>: <span class="ident">TokenStream</span>, <span class="ident">input</span>: <span class="ident">TokenStream</span>) <span class="op">-</span><span class="op">></span> <span class="ident">TokenStream</span> {
|
|||
|
|
<span class="kw">let</span> <span class="ident">args</span> <span class="op">=</span> <span class="macro">parse_macro_input</span><span class="macro">!</span>(<span class="ident">args</span> <span class="kw">as</span> <span class="ident">AttributeArgs</span>);
|
|||
|
|
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="macro">parse_macro_input</span><span class="macro">!</span>(<span class="ident">input</span> <span class="kw">as</span> <span class="ident">ItemFn</span>);
|
|||
|
|
|
|||
|
|
<span class="comment">/* ... */</span>
|
|||
|
|
}</pre></div>
|
|||
|
|
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "syn";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|