struct.Structure.html 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `Structure` struct in crate `synstructure`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, Structure">
  9. <title>synstructure::Structure - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
  14. <script src="../storage.js"></script>
  15. </head>
  16. <body class="rustdoc struct">
  17. <!--[if lte IE 8]>
  18. <div class="warning">
  19. This old browser is unsupported and will most likely display funky
  20. things.
  21. </div>
  22. <![endif]-->
  23. <nav class="sidebar">
  24. <div class="sidebar-menu">&#9776;</div>
  25. <p class='location'>Struct Structure</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.variants">variants</a><a href="#method.variants_mut">variants_mut</a><a href="#method.ast">ast</a><a href="#method.omitted_variants">omitted_variants</a><a href="#method.each">each</a><a href="#method.fold">fold</a><a href="#method.each_variant">each_variant</a><a href="#method.filter">filter</a><a href="#method.filter_variants">filter_variants</a><a href="#method.remove_variant">remove_variant</a><a href="#method.bind_with">bind_with</a><a href="#method.binding_name">binding_name</a><a href="#method.referenced_ty_params">referenced_ty_params</a><a href="#method.add_trait_bounds">add_trait_bounds</a><a href="#method.bound_impl">bound_impl</a><a href="#method.unsafe_bound_impl">unsafe_bound_impl</a><a href="#method.unbound_impl">unbound_impl</a><a href="#method.unsafe_unbound_impl">unsafe_unbound_impl</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Clone">Clone</a><a href="#impl-PartialEq">PartialEq</a><a href="#impl-Eq">Eq</a><a href="#impl-Hash">Hash</a></div></div><p class='location'><a href='index.html'>synstructure</a></p><script>window.sidebarCurrent = {name: 'Structure', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
  26. </nav>
  27. <div class="theme-picker">
  28. <button id="theme-picker" aria-label="Pick another theme!">
  29. <img src="../brush.svg" width="18" alt="Pick another theme!">
  30. </button>
  31. <div id="theme-choices"></div>
  32. </div>
  33. <script src="../theme.js"></script>
  34. <nav class="sub">
  35. <form class="search-form js-only">
  36. <div class="search-container">
  37. <input class="search-input" name="search"
  38. autocomplete="off"
  39. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  40. type="search">
  41. </div>
  42. </form>
  43. </nav>
  44. <section id='main' class="content">
  45. <h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>synstructure</a>::<wbr><a class="struct" href=''>Structure</a></span><span class='out-of-band'><span id='render-detail'>
  46. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  47. [<span class='inner'>&#x2212;</span>]
  48. </a>
  49. </span><a class='srclink' href='../src/synstructure/lib.rs.html#859-863' title='goto source code'>[src]</a></span></h1>
  50. <pre class='rust struct'>pub struct Structure&lt;'a&gt; { /* fields omitted */ }</pre><div class='docblock'><p>A wrapper around a <code>syn</code> <code>DeriveInput</code> which provides utilities for creating
  51. custom derive trait implementations.</p>
  52. </div>
  53. <h2 id='methods' class='small-section-header'>
  54. Methods<a href='#methods' class='anchor'></a>
  55. </h2>
  56. <h3 id='impl' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="struct" href="../synstructure/struct.Structure.html" title="struct synstructure::Structure">Structure</a>&lt;'a&gt;</code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#865-1469' title='goto source code'>[src]</a></span></h3>
  57. <div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(ast: &amp;'a <a class="struct" href="../syn/derive/struct.DeriveInput.html" title="struct syn::derive::DeriveInput">DeriveInput</a>) -&gt; Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#868-907' title='goto source code'>[src]</a></span></h4>
  58. <div class='docblock'><p>Create a new <code>Structure</code> with the variants and fields from the passed-in
  59. <code>DeriveInput</code>.</p>
  60. </div><h4 id='method.variants' class="method"><span id='variants.v' class='invisible'><code>pub fn <a href='#method.variants' class='fnname'>variants</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="struct" href="../synstructure/struct.VariantInfo.html" title="struct synstructure::VariantInfo">VariantInfo</a>&lt;'a&gt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#910-912' title='goto source code'>[src]</a></span></h4>
  61. <div class='docblock'><p>Returns a slice of the variants in this Structure.</p>
  62. </div><h4 id='method.variants_mut' class="method"><span id='variants_mut.v' class='invisible'><code>pub fn <a href='#method.variants_mut' class='fnname'>variants_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;mut [</a><a class="struct" href="../synstructure/struct.VariantInfo.html" title="struct synstructure::VariantInfo">VariantInfo</a>&lt;'a&gt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#915-917' title='goto source code'>[src]</a></span></h4>
  63. <div class='docblock'><p>Returns a mut slice of the variants in this Structure.</p>
  64. </div><h4 id='method.ast' class="method"><span id='ast.v' class='invisible'><code>pub fn <a href='#method.ast' class='fnname'>ast</a>(&amp;self) -&gt; &amp;'a <a class="struct" href="../syn/derive/struct.DeriveInput.html" title="struct syn::derive::DeriveInput">DeriveInput</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#921-923' title='goto source code'>[src]</a></span></h4>
  65. <div class='docblock'><p>Returns a reference to the underlying <code>syn</code> AST node which this
  66. <code>Structure</code> was created from.</p>
  67. </div><h4 id='method.omitted_variants' class="method"><span id='omitted_variants.v' class='invisible'><code>pub fn <a href='#method.omitted_variants' class='fnname'>omitted_variants</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#926-928' title='goto source code'>[src]</a></span></h4>
  68. <div class='docblock'><p>True if any variants were omitted due to a <code>filter_variants</code> call.</p>
  69. </div><h4 id='method.each' class="method"><span id='each.v' class='invisible'><code>pub fn <a href='#method.each' class='fnname'>each</a>&lt;F, R&gt;(&amp;self, f: F) -&gt; <a class="struct" href="../quote/tokens/struct.Tokens.html" title="struct quote::tokens::Tokens">Tokens</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&amp;<a class="struct" href="../synstructure/struct.BindingInfo.html" title="struct synstructure::BindingInfo">BindingInfo</a>) -&gt; R,<br>&nbsp;&nbsp;&nbsp;&nbsp;R: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#966-979' title='goto source code'>[src]</a></span></h4>
  70. <div class='docblock'><p>Runs the passed-in function once for each bound field, passing in a <code>BindingInfo</code>.
  71. and generating <code>match</code> arms which evaluate the returned tokens.</p>
  72. <p>This method will ignore variants or fields which are ignored through the
  73. <code>filter</code> and <code>filter_variant</code> methods.</p>
  74. <h1 id="example" class="section-header"><a href="#example">Example</a></h1>
  75. <pre class="rust rust-example-rendered">
  76. <span class="kw">let</span> <span class="ident">di</span> <span class="op">=</span> <span class="ident">syn</span>::<span class="ident">parse_derive_input</span>(<span class="string">r#&quot;
  77. enum A {
  78. B(i32, i32),
  79. C(u32),
  80. }
  81. &quot;#</span>).<span class="ident">unwrap</span>();
  82. <span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">Structure</span>::<span class="ident">new</span>(<span class="kw-2">&amp;</span><span class="ident">di</span>);
  83. <span class="macro">assert_eq</span><span class="macro">!</span>(
  84. <span class="ident">s</span>.<span class="ident">each</span>(<span class="op">|</span><span class="ident">bi</span><span class="op">|</span> <span class="macro">quote</span><span class="macro">!</span>(<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, #<span class="ident">bi</span>))),
  85. <span class="macro">quote</span><span class="macro">!</span>{
  86. <span class="ident">A</span>::<span class="ident">B</span>(<span class="kw-2">ref</span> <span class="ident">__binding_0</span>, <span class="kw-2">ref</span> <span class="ident">__binding_1</span>,) <span class="op">=&gt;</span> {
  87. { <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">__binding_0</span>) }
  88. { <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">__binding_1</span>) }
  89. }
  90. <span class="ident">A</span>::<span class="ident">C</span>(<span class="kw-2">ref</span> <span class="ident">__binding_0</span>,) <span class="op">=&gt;</span> {
  91. { <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">__binding_0</span>) }
  92. }
  93. }
  94. );</pre>
  95. </div><h4 id='method.fold' class="method"><span id='fold.v' class='invisible'><code>pub fn <a href='#method.fold' class='fnname'>fold</a>&lt;F, I, R&gt;(&amp;self, init: I, f: F) -&gt; <a class="struct" href="../quote/tokens/struct.Tokens.html" title="struct quote::tokens::Tokens">Tokens</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="struct" href="../quote/tokens/struct.Tokens.html" title="struct quote::tokens::Tokens">Tokens</a>, &amp;<a class="struct" href="../synstructure/struct.BindingInfo.html" title="struct synstructure::BindingInfo">BindingInfo</a>) -&gt; R,<br>&nbsp;&nbsp;&nbsp;&nbsp;I: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;R: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1019-1033' title='goto source code'>[src]</a></span></h4>
  96. <div class='docblock'><p>Runs the passed-in function once for each bound field, passing in the
  97. result of the previous call, and a <code>BindingInfo</code>. generating <code>match</code>
  98. arms which evaluate to the resulting tokens.</p>
  99. <p>This method will ignore variants or fields which are ignored through the
  100. <code>filter</code> and <code>filter_variant</code> methods.</p>
  101. <p>If a variant has been ignored, it will return the <code>init</code> value.</p>
  102. <h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
  103. <pre class="rust rust-example-rendered">
  104. <span class="kw">let</span> <span class="ident">di</span> <span class="op">=</span> <span class="ident">syn</span>::<span class="ident">parse_derive_input</span>(<span class="string">r#&quot;
  105. enum A {
  106. B(i32, i32),
  107. C(u32),
  108. }
  109. &quot;#</span>).<span class="ident">unwrap</span>();
  110. <span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">Structure</span>::<span class="ident">new</span>(<span class="kw-2">&amp;</span><span class="ident">di</span>);
  111. <span class="macro">assert_eq</span><span class="macro">!</span>(
  112. <span class="ident">s</span>.<span class="ident">fold</span>(<span class="macro">quote</span><span class="macro">!</span>(<span class="number">0</span>), <span class="op">|</span><span class="ident">acc</span>, <span class="ident">bi</span><span class="op">|</span> <span class="macro">quote</span><span class="macro">!</span>(#<span class="ident">acc</span> <span class="op">+</span> #<span class="ident">bi</span>)),
  113. <span class="macro">quote</span><span class="macro">!</span>{
  114. <span class="ident">A</span>::<span class="ident">B</span>(<span class="kw-2">ref</span> <span class="ident">__binding_0</span>, <span class="kw-2">ref</span> <span class="ident">__binding_1</span>,) <span class="op">=&gt;</span> {
  115. <span class="number">0</span> <span class="op">+</span> <span class="ident">__binding_0</span> <span class="op">+</span> <span class="ident">__binding_1</span>
  116. }
  117. <span class="ident">A</span>::<span class="ident">C</span>(<span class="kw-2">ref</span> <span class="ident">__binding_0</span>,) <span class="op">=&gt;</span> {
  118. <span class="number">0</span> <span class="op">+</span> <span class="ident">__binding_0</span>
  119. }
  120. }
  121. );</pre>
  122. </div><h4 id='method.each_variant' class="method"><span id='each_variant.v' class='invisible'><code>pub fn <a href='#method.each_variant' class='fnname'>each_variant</a>&lt;F, R&gt;(&amp;self, f: F) -&gt; <a class="struct" href="../quote/tokens/struct.Tokens.html" title="struct quote::tokens::Tokens">Tokens</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&amp;<a class="struct" href="../synstructure/struct.VariantInfo.html" title="struct synstructure::VariantInfo">VariantInfo</a>) -&gt; R,<br>&nbsp;&nbsp;&nbsp;&nbsp;R: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1074-1089' title='goto source code'>[src]</a></span></h4>
  123. <div class='docblock'><p>Runs the passed-in function once for each variant, passing in a
  124. <code>VariantInfo</code>. and generating <code>match</code> arms which evaluate the returned
  125. tokens.</p>
  126. <p>This method will ignore variants and not bind fields which are ignored
  127. through the <code>filter</code> and <code>filter_variant</code> methods.</p>
  128. <h1 id="example-2" class="section-header"><a href="#example-2">Example</a></h1>
  129. <pre class="rust rust-example-rendered">
  130. <span class="kw">let</span> <span class="ident">di</span> <span class="op">=</span> <span class="ident">syn</span>::<span class="ident">parse_derive_input</span>(<span class="string">r#&quot;
  131. enum A {
  132. B(i32, i32),
  133. C(u32),
  134. }
  135. &quot;#</span>).<span class="ident">unwrap</span>();
  136. <span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">Structure</span>::<span class="ident">new</span>(<span class="kw-2">&amp;</span><span class="ident">di</span>);
  137. <span class="macro">assert_eq</span><span class="macro">!</span>(
  138. <span class="ident">s</span>.<span class="ident">each_variant</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> {
  139. <span class="kw">let</span> <span class="ident">name</span> <span class="op">=</span> <span class="kw-2">&amp;</span><span class="ident">v</span>.<span class="ident">ast</span>().<span class="ident">ident</span>;
  140. <span class="macro">quote</span><span class="macro">!</span>(<span class="macro">println</span><span class="macro">!</span>(<span class="macro">stringify</span><span class="macro">!</span>(#<span class="ident">name</span>)))
  141. }),
  142. <span class="macro">quote</span><span class="macro">!</span>{
  143. <span class="ident">A</span>::<span class="ident">B</span>(<span class="kw-2">ref</span> <span class="ident">__binding_0</span>, <span class="kw-2">ref</span> <span class="ident">__binding_1</span>,) <span class="op">=&gt;</span> {
  144. <span class="macro">println</span><span class="macro">!</span>(<span class="macro">stringify</span><span class="macro">!</span>(<span class="ident">B</span>))
  145. }
  146. <span class="ident">A</span>::<span class="ident">C</span>(<span class="kw-2">ref</span> <span class="ident">__binding_0</span>,) <span class="op">=&gt;</span> {
  147. <span class="macro">println</span><span class="macro">!</span>(<span class="macro">stringify</span><span class="macro">!</span>(<span class="ident">C</span>))
  148. }
  149. }
  150. );</pre>
  151. </div><h4 id='method.filter' class="method"><span id='filter.v' class='invisible'><code>pub fn <a href='#method.filter' class='fnname'>filter</a>&lt;F&gt;(&amp;mut self, f: F) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&amp;<a class="struct" href="../synstructure/struct.BindingInfo.html" title="struct synstructure::BindingInfo">BindingInfo</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1131-1139' title='goto source code'>[src]</a></span></h4>
  152. <div class='docblock'><p>Filter the bindings created by this <code>Structure</code> object. This has 2 effects:</p>
  153. <ul>
  154. <li>
  155. <p>The bindings will no longer appear in match arms generated by methods
  156. on this <code>Structure</code> or its subobjects.</p>
  157. </li>
  158. <li>
  159. <p>Impl blocks created with the <code>bound_impl</code> or <code>unsafe_bound_impl</code>
  160. method only consider type parameters referenced in the types of
  161. non-filtered fields.</p>
  162. </li>
  163. </ul>
  164. <h1 id="example-3" class="section-header"><a href="#example-3">Example</a></h1>
  165. <pre class="rust rust-example-rendered">
  166. <span class="kw">let</span> <span class="ident">di</span> <span class="op">=</span> <span class="ident">syn</span>::<span class="ident">parse_derive_input</span>(<span class="string">r#&quot;
  167. enum A {
  168. B{ a: i32, b: i32 },
  169. C{ a: u32 },
  170. }
  171. &quot;#</span>).<span class="ident">unwrap</span>();
  172. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">Structure</span>::<span class="ident">new</span>(<span class="kw-2">&amp;</span><span class="ident">di</span>);
  173. <span class="ident">s</span>.<span class="ident">filter</span>(<span class="op">|</span><span class="ident">bi</span><span class="op">|</span> { <span class="ident">bi</span>.<span class="ident">ast</span>().<span class="ident">ident</span> <span class="op">==</span> <span class="prelude-val">Some</span>(<span class="string">&quot;a&quot;</span>.<span class="ident">into</span>()) });
  174. <span class="macro">assert_eq</span><span class="macro">!</span>(
  175. <span class="ident">s</span>.<span class="ident">each</span>(<span class="op">|</span><span class="ident">bi</span><span class="op">|</span> <span class="macro">quote</span><span class="macro">!</span>(<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, #<span class="ident">bi</span>))),
  176. <span class="macro">quote</span><span class="macro">!</span>{
  177. <span class="ident">A</span>::<span class="ident">B</span>{ <span class="ident">a</span>: <span class="kw-2">ref</span> <span class="ident">__binding_0</span>, .. } <span class="op">=&gt;</span> {
  178. { <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">__binding_0</span>) }
  179. }
  180. <span class="ident">A</span>::<span class="ident">C</span>{ <span class="ident">a</span>: <span class="kw-2">ref</span> <span class="ident">__binding_0</span>, } <span class="op">=&gt;</span> {
  181. { <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">__binding_0</span>) }
  182. }
  183. }
  184. );</pre>
  185. </div><h4 id='method.filter_variants' class="method"><span id='filter_variants.v' class='invisible'><code>pub fn <a href='#method.filter_variants' class='fnname'>filter_variants</a>&lt;F&gt;(&amp;mut self, f: F) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&amp;<a class="struct" href="../synstructure/struct.VariantInfo.html" title="struct synstructure::VariantInfo">VariantInfo</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1179-1189' title='goto source code'>[src]</a></span></h4>
  186. <div class='docblock'><p>Filter the variants matched by this <code>Structure</code> object. This has 2 effects:</p>
  187. <ul>
  188. <li>
  189. <p>Match arms destructuring these variants will no longer be generated by
  190. methods on this <code>Structure</code></p>
  191. </li>
  192. <li>
  193. <p>Impl blocks created with the <code>bound_impl</code> or <code>unsafe_bound_impl</code>
  194. method only consider type parameters referenced in the types of
  195. fields in non-fitered variants.</p>
  196. </li>
  197. </ul>
  198. <h1 id="example-4" class="section-header"><a href="#example-4">Example</a></h1>
  199. <pre class="rust rust-example-rendered">
  200. <span class="kw">let</span> <span class="ident">di</span> <span class="op">=</span> <span class="ident">syn</span>::<span class="ident">parse_derive_input</span>(<span class="string">r#&quot;
  201. enum A {
  202. B(i32, i32),
  203. C(u32),
  204. }
  205. &quot;#</span>).<span class="ident">unwrap</span>();
  206. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">Structure</span>::<span class="ident">new</span>(<span class="kw-2">&amp;</span><span class="ident">di</span>);
  207. <span class="ident">s</span>.<span class="ident">filter_variants</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">ast</span>().<span class="ident">ident</span> <span class="op">!=</span> <span class="string">&quot;B&quot;</span>);
  208. <span class="macro">assert_eq</span><span class="macro">!</span>(
  209. <span class="ident">s</span>.<span class="ident">each</span>(<span class="op">|</span><span class="ident">bi</span><span class="op">|</span> <span class="macro">quote</span><span class="macro">!</span>(<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, #<span class="ident">bi</span>))),
  210. <span class="macro">quote</span><span class="macro">!</span>{
  211. <span class="ident">A</span>::<span class="ident">C</span>(<span class="kw-2">ref</span> <span class="ident">__binding_0</span>,) <span class="op">=&gt;</span> {
  212. { <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">__binding_0</span>) }
  213. }
  214. _ <span class="op">=&gt;</span> {}
  215. }
  216. );</pre>
  217. </div><h4 id='method.remove_variant' class="method"><span id='remove_variant.v' class='invisible'><code>pub fn <a href='#method.remove_variant' class='fnname'>remove_variant</a>(&amp;mut self, idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1196-1200' title='goto source code'>[src]</a></span></h4>
  218. <div class='docblock'><p>Remove the variant at the given index.</p>
  219. <h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
  220. <p>Panics if the index is out of range.</p>
  221. </div><h4 id='method.bind_with' class="method"><span id='bind_with.v' class='invisible'><code>pub fn <a href='#method.bind_with' class='fnname'>bind_with</a>&lt;F&gt;(&amp;mut self, f: F) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&amp;<a class="struct" href="../synstructure/struct.BindingInfo.html" title="struct synstructure::BindingInfo">BindingInfo</a>) -&gt; <a class="enum" href="../synstructure/enum.BindStyle.html" title="enum synstructure::BindStyle">BindStyle</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1237-1245' title='goto source code'>[src]</a></span></h4>
  222. <div class='docblock'><p>Updates the <code>BindStyle</code> for each of the passed-in fields by calling the
  223. passed-in function for each <code>BindingInfo</code>.</p>
  224. <h1 id="example-5" class="section-header"><a href="#example-5">Example</a></h1>
  225. <pre class="rust rust-example-rendered">
  226. <span class="kw">let</span> <span class="ident">di</span> <span class="op">=</span> <span class="ident">syn</span>::<span class="ident">parse_derive_input</span>(<span class="string">r#&quot;
  227. enum A {
  228. B(i32, i32),
  229. C(u32),
  230. }
  231. &quot;#</span>).<span class="ident">unwrap</span>();
  232. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">Structure</span>::<span class="ident">new</span>(<span class="kw-2">&amp;</span><span class="ident">di</span>);
  233. <span class="ident">s</span>.<span class="ident">bind_with</span>(<span class="op">|</span><span class="ident">bi</span><span class="op">|</span> <span class="ident">BindStyle</span>::<span class="ident">RefMut</span>);
  234. <span class="macro">assert_eq</span><span class="macro">!</span>(
  235. <span class="ident">s</span>.<span class="ident">each</span>(<span class="op">|</span><span class="ident">bi</span><span class="op">|</span> <span class="macro">quote</span><span class="macro">!</span>(<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, #<span class="ident">bi</span>))),
  236. <span class="macro">quote</span><span class="macro">!</span>{
  237. <span class="ident">A</span>::<span class="ident">B</span>(<span class="kw-2">ref</span> <span class="kw-2">mut</span> <span class="ident">__binding_0</span>, <span class="kw-2">ref</span> <span class="kw-2">mut</span> <span class="ident">__binding_1</span>,) <span class="op">=&gt;</span> {
  238. { <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">__binding_0</span>) }
  239. { <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">__binding_1</span>) }
  240. }
  241. <span class="ident">A</span>::<span class="ident">C</span>(<span class="kw-2">ref</span> <span class="kw-2">mut</span> <span class="ident">__binding_0</span>,) <span class="op">=&gt;</span> {
  242. { <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">__binding_0</span>) }
  243. }
  244. }
  245. );</pre>
  246. </div><h4 id='method.binding_name' class="method"><span id='binding_name.v' class='invisible'><code>pub fn <a href='#method.binding_name' class='fnname'>binding_name</a>&lt;F&gt;(&amp;mut self, f: F) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&amp;<a class="struct" href="../syn/data/struct.Field.html" title="struct syn::data::Field">Field</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="struct" href="../syn/ident/struct.Ident.html" title="struct syn::ident::Ident">Ident</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1288-1296' title='goto source code'>[src]</a></span></h4>
  247. <div class='docblock'><p>Updates the binding name for each fo the passed-in fields by calling the
  248. passed-in function for each <code>BindingInfo</code>.</p>
  249. <p>The function will be called with the <code>BindingInfo</code> and its index in the
  250. enclosing variant.</p>
  251. <p>The default name is <code>__binding_{}</code> where <code>{}</code> is replaced with an
  252. increasing number.</p>
  253. <h1 id="example-6" class="section-header"><a href="#example-6">Example</a></h1>
  254. <pre class="rust rust-example-rendered">
  255. <span class="kw">let</span> <span class="ident">di</span> <span class="op">=</span> <span class="ident">syn</span>::<span class="ident">parse_derive_input</span>(<span class="string">r#&quot;
  256. enum A {
  257. B{ a: i32, b: i32 },
  258. C{ a: u32 },
  259. }
  260. &quot;#</span>).<span class="ident">unwrap</span>();
  261. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">Structure</span>::<span class="ident">new</span>(<span class="kw-2">&amp;</span><span class="ident">di</span>);
  262. <span class="ident">s</span>.<span class="ident">binding_name</span>(<span class="op">|</span><span class="ident">bi</span>, <span class="ident">i</span><span class="op">|</span> <span class="ident">bi</span>.<span class="ident">ident</span>.<span class="ident">clone</span>().<span class="ident">unwrap</span>());
  263. <span class="macro">assert_eq</span><span class="macro">!</span>(
  264. <span class="ident">s</span>.<span class="ident">each</span>(<span class="op">|</span><span class="ident">bi</span><span class="op">|</span> <span class="macro">quote</span><span class="macro">!</span>(<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, #<span class="ident">bi</span>))),
  265. <span class="macro">quote</span><span class="macro">!</span>{
  266. <span class="ident">A</span>::<span class="ident">B</span>{ <span class="ident">a</span>: <span class="kw-2">ref</span> <span class="ident">a</span>, <span class="ident">b</span>: <span class="kw-2">ref</span> <span class="ident">b</span>, } <span class="op">=&gt;</span> {
  267. { <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">a</span>) }
  268. { <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">b</span>) }
  269. }
  270. <span class="ident">A</span>::<span class="ident">C</span>{ <span class="ident">a</span>: <span class="kw-2">ref</span> <span class="ident">a</span>, } <span class="op">=&gt;</span> {
  271. { <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">a</span>) }
  272. }
  273. }
  274. );</pre>
  275. </div><h4 id='method.referenced_ty_params' class="method"><span id='referenced_ty_params.v' class='invisible'><code>pub fn <a href='#method.referenced_ty_params' class='fnname'>referenced_ty_params</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;&amp;'a <a class="struct" href="../syn/ident/struct.Ident.html" title="struct syn::ident::Ident">Ident</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1330-1338' title='goto source code'>[src]</a></span></h4>
  276. <div class='docblock'><p>Returns a list of the type parameters which are refrenced in the types
  277. of non-filtered fields / variants.</p>
  278. <h1 id="caveat" class="section-header"><a href="#caveat">Caveat</a></h1>
  279. <p>If the struct contains any macros in type position, all parameters will
  280. be considered bound. This is because we cannot determine which type
  281. parameters are bound by type macros.</p>
  282. <h1 id="example-7" class="section-header"><a href="#example-7">Example</a></h1>
  283. <pre class="rust rust-example-rendered">
  284. <span class="kw">let</span> <span class="ident">di</span> <span class="op">=</span> <span class="ident">syn</span>::<span class="ident">parse_derive_input</span>(<span class="string">r#&quot;
  285. enum A&lt;T, U&gt; {
  286. B(T, i32),
  287. C(Option&lt;U&gt;),
  288. }
  289. &quot;#</span>).<span class="ident">unwrap</span>();
  290. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">Structure</span>::<span class="ident">new</span>(<span class="kw-2">&amp;</span><span class="ident">di</span>);
  291. <span class="ident">s</span>.<span class="ident">filter_variants</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">ast</span>().<span class="ident">ident</span> <span class="op">!=</span> <span class="string">&quot;C&quot;</span>);
  292. <span class="macro">assert_eq</span><span class="macro">!</span>(
  293. <span class="ident">s</span>.<span class="ident">referenced_ty_params</span>(),
  294. <span class="kw-2">&amp;</span>[<span class="kw-2">&amp;</span>(<span class="ident">syn</span>::<span class="ident">Ident</span>::<span class="ident">from</span>(<span class="string">&quot;T&quot;</span>))]
  295. );</pre>
  296. </div><h4 id='method.add_trait_bounds' class="method"><span id='add_trait_bounds.v' class='invisible'><code>pub fn <a href='#method.add_trait_bounds' class='fnname'>add_trait_bounds</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;bound: &amp;<a class="enum" href="../syn/generics/enum.TyParamBound.html" title="enum syn::generics::TyParamBound">TyParamBound</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;preds: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../syn/generics/enum.WherePredicate.html" title="enum syn::generics::WherePredicate">WherePredicate</a>&gt;<br>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1348-1373' title='goto source code'>[src]</a></span></h4>
  297. <div class='docblock'><p>Add trait bounds for a trait with the given path for each type parmaeter
  298. referenced in the types of non-filtered fields.</p>
  299. <h1 id="caveat-1" class="section-header"><a href="#caveat-1">Caveat</a></h1>
  300. <p>If the method contains any macros in type position, all parameters will
  301. be considered bound. This is because we cannot determine which type
  302. parameters are bound by type macros.</p>
  303. </div><h4 id='method.bound_impl' class="method"><span id='bound_impl.v' class='invisible'><code>pub fn <a href='#method.bound_impl' class='fnname'>bound_impl</a>&lt;P:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;, B:&nbsp;<a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;bound: P, <br>&nbsp;&nbsp;&nbsp;&nbsp;body: B<br>) -&gt; <a class="struct" href="../quote/tokens/struct.Tokens.html" title="struct quote::tokens::Tokens">Tokens</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1423-1438' title='goto source code'>[src]</a></span></h4>
  304. <div class='docblock'><p>Creates an <code>impl</code> block with the required generic type fields filled in
  305. to implement the trait <code>path</code>.</p>
  306. <p>This method also adds where clauses to the impl requiring that all
  307. referenced type parmaeters implement the trait <code>path</code>.</p>
  308. <h1 id="caveat-2" class="section-header"><a href="#caveat-2">Caveat</a></h1>
  309. <p>If the method contains any macros in type position, all parameters will
  310. be considered bound. This is because we cannot determine which type
  311. parameters are bound by type macros.</p>
  312. <h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
  313. <p>Panics if the path string parameter is not a valid TyParamBound.</p>
  314. <h1 id="example-8" class="section-header"><a href="#example-8">Example</a></h1>
  315. <pre class="rust rust-example-rendered">
  316. <span class="kw">let</span> <span class="ident">di</span> <span class="op">=</span> <span class="ident">syn</span>::<span class="ident">parse_derive_input</span>(<span class="string">r#&quot;
  317. enum A&lt;T, U&gt; {
  318. B(T),
  319. C(Option&lt;U&gt;),
  320. }
  321. &quot;#</span>).<span class="ident">unwrap</span>();
  322. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">Structure</span>::<span class="ident">new</span>(<span class="kw-2">&amp;</span><span class="ident">di</span>);
  323. <span class="ident">s</span>.<span class="ident">filter_variants</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">ast</span>().<span class="ident">ident</span> <span class="op">!=</span> <span class="string">&quot;B&quot;</span>);
  324. <span class="macro">assert_eq</span><span class="macro">!</span>(
  325. <span class="ident">s</span>.<span class="ident">bound_impl</span>(<span class="string">&quot;::krate::Trait&quot;</span>, <span class="macro">quote</span><span class="macro">!</span>{
  326. <span class="kw">fn</span> <span class="ident">a</span>() {}
  327. }),
  328. <span class="macro">quote</span><span class="macro">!</span>{
  329. <span class="kw">impl</span><span class="op">&lt;</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">&gt;</span> ::<span class="ident">krate</span>::<span class="ident">Trait</span> <span class="kw">for</span> <span class="ident">A</span><span class="op">&lt;</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">&gt;</span>
  330. <span class="kw">where</span> <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">U</span><span class="op">&gt;</span>: ::<span class="ident">krate</span>::<span class="ident">Trait</span>,
  331. <span class="ident">U</span>: ::<span class="ident">krate</span>::<span class="ident">Trait</span>
  332. {
  333. <span class="kw">fn</span> <span class="ident">a</span>() {}
  334. }
  335. }
  336. );</pre>
  337. </div><h4 id='method.unsafe_bound_impl' class="method"><span id='unsafe_bound_impl.v' class='invisible'><code>pub fn <a href='#method.unsafe_bound_impl' class='fnname'>unsafe_bound_impl</a>&lt;P:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;, B:&nbsp;<a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;path: P, <br>&nbsp;&nbsp;&nbsp;&nbsp;body: B<br>) -&gt; <a class="struct" href="../quote/tokens/struct.Tokens.html" title="struct quote::tokens::Tokens">Tokens</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1442-1445' title='goto source code'>[src]</a></span></h4>
  338. <div class='docblock'><p>This method is the same as <code>bound_impl</code>, except also includes the
  339. <code>unsafe</code> keyword for implementing unsafe traits.</p>
  340. </div><h4 id='method.unbound_impl' class="method"><span id='unbound_impl.v' class='invisible'><code>pub fn <a href='#method.unbound_impl' class='fnname'>unbound_impl</a>&lt;P:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;, B:&nbsp;<a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;bound: P, <br>&nbsp;&nbsp;&nbsp;&nbsp;body: B<br>) -&gt; <a class="struct" href="../quote/tokens/struct.Tokens.html" title="struct quote::tokens::Tokens">Tokens</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1449-1461' title='goto source code'>[src]</a></span></h4>
  341. <div class='docblock'><p>This method is like <code>bound_impl</code> but doesn't add the additional bounds
  342. to the where clause.</p>
  343. </div><h4 id='method.unsafe_unbound_impl' class="method"><span id='unsafe_unbound_impl.v' class='invisible'><code>pub fn <a href='#method.unsafe_unbound_impl' class='fnname'>unsafe_unbound_impl</a>&lt;P:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;, B:&nbsp;<a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;path: P, <br>&nbsp;&nbsp;&nbsp;&nbsp;body: B<br>) -&gt; <a class="struct" href="../quote/tokens/struct.Tokens.html" title="struct quote::tokens::Tokens">Tokens</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1465-1468' title='goto source code'>[src]</a></span></h4>
  344. <div class='docblock'><p>This method is the same as <code>unbound_impl</code>, except also includes the
  345. <code>unsafe</code> keyword for implementing unsafe traits.</p>
  346. </div></div>
  347. <h2 id='implementations' class='small-section-header'>
  348. Trait Implementations<a href='#implementations' class='anchor'></a>
  349. </h2>
  350. <h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../synstructure/struct.Structure.html" title="struct synstructure::Structure">Structure</a>&lt;'a&gt;</code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#858' title='goto source code'>[src]</a></span></h3>
  351. <div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#858' title='goto source code'>[src]</a></span></h4>
  352. <div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
  353. </div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../synstructure/struct.Structure.html" title="struct synstructure::Structure">Structure</a>&lt;'a&gt;</code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#858' title='goto source code'>[src]</a></span></h3>
  354. <div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../synstructure/struct.Structure.html" title="struct synstructure::Structure">Structure</a>&lt;'a&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#858' title='goto source code'>[src]</a></span></h4>
  355. <div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
  356. </div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
  357. <div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
  358. </div></div><h3 id='impl-PartialEq' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="../synstructure/struct.Structure.html" title="struct synstructure::Structure">Structure</a>&lt;'a&gt;</code><a href='#impl-PartialEq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#858' title='goto source code'>[src]</a></span></h3>
  359. <div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, __arg_0: &amp;<a class="struct" href="../synstructure/struct.Structure.html" title="struct synstructure::Structure">Structure</a>&lt;'a&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#858' title='goto source code'>[src]</a></span></h4>
  360. <div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
  361. </div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, __arg_0: &amp;<a class="struct" href="../synstructure/struct.Structure.html" title="struct synstructure::Structure">Structure</a>&lt;'a&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#858' title='goto source code'>[src]</a></span></h4>
  362. <div class='docblock'><p>This method tests for <code>!=</code>.</p>
  363. </div></div><h3 id='impl-Eq' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="../synstructure/struct.Structure.html" title="struct synstructure::Structure">Structure</a>&lt;'a&gt;</code><a href='#impl-Eq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#858' title='goto source code'>[src]</a></span></h3>
  364. <div class='impl-items'></div><h3 id='impl-Hash' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="struct" href="../synstructure/struct.Structure.html" title="struct synstructure::Structure">Structure</a>&lt;'a&gt;</code><a href='#impl-Hash' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#858' title='goto source code'>[src]</a></span></h3>
  365. <div class='impl-items'><h4 id='method.hash' class="method"><span id='hash.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash' class='fnname'>hash</a>&lt;__H:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>&gt;(&amp;self, __arg_0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>__H)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#858' title='goto source code'>[src]</a></span></h4>
  366. <div class='docblock'><p>Feeds this value into the given [<code>Hasher</code>]. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash">Read more</a></p>
  367. </div><h4 id='method.hash_slice' class="method"><span id='hash_slice.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice' class='fnname'>hash_slice</a>&lt;H&gt;(data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[Self]</a>, state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>H) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/hash/mod.rs.html#202-208' title='goto source code'>[src]</a></span></h4>
  368. <div class='docblock'><p>Feeds a slice of this type into the given [<code>Hasher</code>]. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice">Read more</a></p>
  369. </div></div></section>
  370. <section id='search' class="content hidden"></section>
  371. <section class="footer"></section>
  372. <aside id="help" class="hidden">
  373. <div>
  374. <h1 class="hidden">Help</h1>
  375. <div class="shortcuts">
  376. <h2>Keyboard Shortcuts</h2>
  377. <dl>
  378. <dt><kbd>?</kbd></dt>
  379. <dd>Show this help dialog</dd>
  380. <dt><kbd>S</kbd></dt>
  381. <dd>Focus the search field</dd>
  382. <dt><kbd>↑</kbd></dt>
  383. <dd>Move up in search results</dd>
  384. <dt><kbd>↓</kbd></dt>
  385. <dd>Move down in search results</dd>
  386. <dt><kbd>↹</kbd></dt>
  387. <dd>Switch tab</dd>
  388. <dt><kbd>&#9166;</kbd></dt>
  389. <dd>Go to active search result</dd>
  390. <dt><kbd>+</kbd></dt>
  391. <dd>Expand all sections</dd>
  392. <dt><kbd>-</kbd></dt>
  393. <dd>Collapse all sections</dd>
  394. </dl>
  395. </div>
  396. <div class="infos">
  397. <h2>Search Tricks</h2>
  398. <p>
  399. Prefix searches with a type followed by a colon (e.g.
  400. <code>fn:</code>) to restrict the search to a given type.
  401. </p>
  402. <p>
  403. Accepted types are: <code>fn</code>, <code>mod</code>,
  404. <code>struct</code>, <code>enum</code>,
  405. <code>trait</code>, <code>type</code>, <code>macro</code>,
  406. and <code>const</code>.
  407. </p>
  408. <p>
  409. Search functions by type signature (e.g.
  410. <code>vec -> usize</code> or <code>* -> vec</code>)
  411. </p>
  412. </div>
  413. </div>
  414. </aside>
  415. <script>
  416. window.rootPath = "../";
  417. window.currentCrate = "synstructure";
  418. </script>
  419. <script src="../main.js"></script>
  420. <script defer src="../search-index.js"></script>
  421. </body>
  422. </html>