28 lines
4.9 KiB
HTML
28 lines
4.9 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="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."><title>test_derive in synstructure - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="synstructure" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">test_derive</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../synstructure/index.html">synstructure</a><span class="version">0.13.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">test_<wbr>derive</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#usage" title="Usage">Usage</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate synstructure</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">synstructure</a></div><h1>Macro <span class="macro">test_<wbr>derive</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/synstructure/macros.rs.html#210-262">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! test_derive {
|
|
($name:path { $($i:tt)* } expands to { $($o:tt)* }) => { ... };
|
|
($name:path { $($i:tt)* } expands to { $($o:tt)* } no_build) => { ... };
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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>
|
|
<h2 id="usage"><a class="doc-anchor" href="#usage">§</a>Usage</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">fn </span>test_derive_example(_s: synstructure::Structure)
|
|
-> <span class="prelude-ty">Result</span><proc_macro2::TokenStream, syn::Error>
|
|
{
|
|
<span class="prelude-val">Ok</span>(<span class="macro">quote::quote!</span> { <span class="kw">const </span>YOUR_OUTPUT: <span class="kw-2">&</span><span class="lifetime">'static </span>str = <span class="string">"here"</span>; })
|
|
}
|
|
|
|
<span class="kw">fn </span>main() {
|
|
<span class="macro">synstructure::test_derive!</span>{
|
|
test_derive_example {
|
|
<span class="kw">struct </span>A;
|
|
}
|
|
expands to {
|
|
<span class="kw">const </span>YOUR_OUTPUT: <span class="kw-2">&</span><span class="lifetime">'static </span>str = <span class="string">"here"</span>;
|
|
}
|
|
}
|
|
}</code></pre></div></div></details></section></div></main></body></html> |