| 123456789101112131415161718192021222324252627282930 |
- <!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 `test_derive` macro in crate `synstructure`."><meta name="keywords" content="rust, rustlang, rust-lang, test_derive"><title>synstructure::test_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">☰</div><div class="sidebar-elems"><p class='location'><a href='index.html'>synstructure</a></p><script>window.sidebarCurrent = {name: 'test_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=''>test_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'>−</span>]</a></span><a class='srclink' href='../src/synstructure/macros.rs.html#107-152' 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">test_derive</span> {
- (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">path</span> { $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">tt</span>)<span class="op">*</span> } <span class="ident">expands</span> <span class="ident">to</span> { $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">o</span>:<span class="ident">tt</span>)<span class="op">*</span> }) <span class="op">=></span> { ... };
- (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">path</span> { $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">tt</span>)<span class="op">*</span> } <span class="ident">expands</span> <span class="ident">to</span> { $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">o</span>:<span class="ident">tt</span>)<span class="op">*</span> } <span class="ident">no_build</span>) <span class="op">=></span> { ... };
- }</pre>
- </div><div class='docblock'><p>Run a test on a custom derive. This macro expands both the original struct
- and the expansion to ensure that they compile correctly, and confirms that
- feeding the original struct into the named derive will produce the written
- output.</p>
- <p>You can add <code>no_build</code> to the end of the macro invocation to disable
- checking that the written code compiles. This is useful in contexts where
- the procedural macro cannot depend on the crate where it is used during
- tests.</p>
- <h1 id="usage" class="section-header"><a href="#usage">Usage</a></h1>
- <pre class="rust rust-example-rendered">
- <span class="kw">fn</span> <span class="ident">test_derive_example</span>(<span class="ident">_s</span>: <span class="ident">synstructure</span>::<span class="ident">Structure</span>) <span class="op">-></span> <span class="ident">proc_macro2</span>::<span class="ident">TokenStream</span> {
- <span class="macro">quote</span><span class="macro">!</span> { <span class="kw">const</span> <span class="ident">YOUR_OUTPUT</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span> <span class="op">=</span> <span class="string">"here"</span>; }
- }
- <span class="kw">fn</span> <span class="ident">main</span>() {
- <span class="macro">test_derive</span><span class="macro">!</span>{
- <span class="ident">test_derive_example</span> {
- <span class="kw">struct</span> <span class="ident">A</span>;
- }
- <span class="ident">expands</span> <span class="ident">to</span> {
- <span class="kw">const</span> <span class="ident">YOUR_OUTPUT</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span> <span class="op">=</span> <span class="string">"here"</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>⏎</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>
|
