RONCC
/
HPC-Tools-for-Quantum-Computing


			
				
					
						
						
							12345678910111213141516171819202122232425262728
							<!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 `decl_derive` macro in crate `synstructure`."><meta name="keywords" content="rust, rustlang, rust-lang, decl_derive"><title>synstructure::decl_derive - 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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></head><body class="rustdoc macro"><!--[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">&#9776;</div><div class="sidebar-elems"><p class='location'><a href='index.html'>synstructure</a></p><script>window.sidebarCurrent = {name: 'decl_derive', ty: 'macro', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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='in-band'>Macro <a href='index.html'>synstructure</a>::<wbr><a class="macro" href=''>decl_derive</a></span><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'>&#x2212;</span>]</a></span><a class='srclink' href='../src/synstructure/macros.rs.html#57-73' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class="rust macro">
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">decl_derive</span> {
    ([<span class="macro-nonterminal">$</span><span class="macro-nonterminal">derives</span>:<span class="ident">ident</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">derive_t</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>] <span class="op">=&gt;</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">inner</span>:<span class="ident">path</span>) <span class="op">=&gt;</span> { ... };
}</pre>
</div><div class='docblock'><p>The <code>decl_derive!</code> macro declares a custom derive wrapper. It will parse the
incoming <code>TokenStream</code> into a <code>synstructure::Structure</code> object, and pass it
into the inner function.</p>
<p>Your inner function should have the following type:</p>

<pre class="rust rust-example-rendered">
<span class="kw">fn</span> <span class="ident">derive</span>(<span class="ident">input</span>: <span class="ident">synstructure</span>::<span class="ident">Structure</span>) <span class="op">-&gt;</span> <span class="ident">proc_macro2</span>::<span class="ident">TokenStream</span> {
    <span class="macro">unimplemented</span><span class="macro">!</span>()
}</pre>
<h1 id="usage" class="section-header"><a href="#usage">Usage</a></h1><h3 id="without-attributes" class="section-header"><a href="#without-attributes">Without Attributes</a></h3>
<pre class="rust rust-example-rendered">
<span class="kw">fn</span> <span class="ident">derive_interesting</span>(<span class="ident">_input</span>: <span class="ident">synstructure</span>::<span class="ident">Structure</span>) <span class="op">-&gt;</span> <span class="ident">proc_macro2</span>::<span class="ident">TokenStream</span> {
    <span class="macro">quote</span><span class="macro">!</span> { ... }
}

<span class="macro">decl_derive</span><span class="macro">!</span>([<span class="ident">Interesting</span>] <span class="op">=&gt;</span> <span class="ident">derive_interesting</span>);</pre>
<h3 id="with-attributes" class="section-header"><a href="#with-attributes">With Attributes</a></h3>
<pre class="rust rust-example-rendered">
<span class="kw">fn</span> <span class="ident">derive_interesting</span>(<span class="ident">_input</span>: <span class="ident">synstructure</span>::<span class="ident">Structure</span>) <span class="op">-&gt;</span> <span class="ident">proc_macro2</span>::<span class="ident">TokenStream</span> {
    <span class="macro">quote</span><span class="macro">!</span> { ... }
}

<span class="macro">decl_derive</span><span class="macro">!</span>([<span class="ident">Interesting</span>, <span class="ident">attributes</span>(<span class="ident">interesting_ignore</span>)] <span class="op">=&gt;</span> <span class="ident">derive_interesting</span>);</pre>
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "synstructure";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>