784 lines
108 KiB
HTML
784 lines
108 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 `Structure` struct in crate `synstructure`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Structure">
|
|||
|
|
|
|||
|
|
<title>synstructure::Structure - 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="../main.css" id="themeStyle">
|
|||
|
|
<script src="../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc struct">
|
|||
|
|
<!--[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>
|
|||
|
|
|
|||
|
|
<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_impl_generic">add_impl_generic</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><a href="#method.gen_impl">gen_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>
|
|||
|
|
</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">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content">
|
|||
|
|
<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'>
|
|||
|
|
<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/lib.rs.html#954-959' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct Structure<'a> { /* fields omitted */ }</pre><div class='docblock'><p>A wrapper around a <code>syn::DeriveInput</code> which provides utilities for creating
|
|||
|
|
custom derive trait implementations.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='methods' class='small-section-header'>
|
|||
|
|
Methods<a href='#methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl' class='impl'><span class='in-band'><code>impl<'a> <a class="struct" href="../synstructure/struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></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#961-2160' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<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: &'a <a class="struct" href="../syn/derive/struct.DeriveInput.html" title="struct syn::derive::DeriveInput">DeriveInput</a>) -> Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#964-1017' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Create a new <code>Structure</code> with the variants and fields from the passed-in
|
|||
|
|
<code>DeriveInput</code>.</p>
|
|||
|
|
</div><h4 id='method.variants' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></h3><code class="content"><span class="where fmt-newline">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span><span class="where fmt-newline">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></code></div></div><span id='variants.v' class='invisible'><code>pub fn <a href='#method.variants' class='fnname'>variants</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="struct" href="../synstructure/struct.VariantInfo.html" title="struct synstructure::VariantInfo">VariantInfo</a><'a><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#1020-1022' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a slice of the variants in this Structure.</p>
|
|||
|
|
</div><h4 id='method.variants_mut' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></h3><code class="content"><span class="where fmt-newline">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span><span class="where fmt-newline">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></code></div></div><span id='variants_mut.v' class='invisible'><code>pub fn <a href='#method.variants_mut' class='fnname'>variants_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="struct" href="../synstructure/struct.VariantInfo.html" title="struct synstructure::VariantInfo">VariantInfo</a><'a><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#1025-1027' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a mut slice of the variants in this Structure.</p>
|
|||
|
|
</div><h4 id='method.ast' class="method"><span id='ast.v' class='invisible'><code>pub fn <a href='#method.ast' class='fnname'>ast</a>(&self) -> &'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#1031-1033' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a reference to the underlying <code>syn</code> AST node which this
|
|||
|
|
<code>Structure</code> was created from.</p>
|
|||
|
|
</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>(&self) -> <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#1036-1038' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>True if any variants were omitted due to a <code>filter_variants</code> call.</p>
|
|||
|
|
</div><h4 id='method.each' class="method"><span id='each.v' class='invisible'><code>pub fn <a href='#method.each' class='fnname'>each</a><F, R>(&self, f: F) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a> <span class="where fmt-newline">where<br> 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="../synstructure/struct.BindingInfo.html" title="struct synstructure::BindingInfo">BindingInfo</a>) -> R,<br> R: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1076-1089' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Runs the passed-in function once for each bound field, passing in a <code>BindingInfo</code>.
|
|||
|
|
and generating <code>match</code> arms which evaluate the returned tokens.</p>
|
|||
|
|
<p>This method will ignore variants or fields which are ignored through the
|
|||
|
|
<code>filter</code> and <code>filter_variant</code> methods.</p>
|
|||
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn</span>::<span class="ident">DeriveInput</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">enum</span> <span class="ident">A</span> {
|
|||
|
|
<span class="ident">B</span>(<span class="ident">i32</span>, <span class="ident">i32</span>),
|
|||
|
|
<span class="ident">C</span>(<span class="ident">u32</span>),
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
<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">&</span><span class="ident">di</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<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">"{:?}"</span>, #<span class="ident">bi</span>))).<span class="ident">to_string</span>(),
|
|||
|
|
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<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">=></span> {
|
|||
|
|
{ <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_0</span>) }
|
|||
|
|
{ <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_1</span>) }
|
|||
|
|
}
|
|||
|
|
<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">=></span> {
|
|||
|
|
{ <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_0</span>) }
|
|||
|
|
}
|
|||
|
|
}.<span class="ident">to_string</span>()
|
|||
|
|
);</pre>
|
|||
|
|
</div><h4 id='method.fold' class="method"><span id='fold.v' class='invisible'><code>pub fn <a href='#method.fold' class='fnname'>fold</a><F, I, R>(&self, init: I, f: F) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a> <span class="where fmt-newline">where<br> 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="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>, &<a class="struct" href="../synstructure/struct.BindingInfo.html" title="struct synstructure::BindingInfo">BindingInfo</a>) -> R,<br> I: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>,<br> R: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1129-1143' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Runs the passed-in function once for each bound field, passing in the
|
|||
|
|
result of the previous call, and a <code>BindingInfo</code>. generating <code>match</code>
|
|||
|
|
arms which evaluate to the resulting tokens.</p>
|
|||
|
|
<p>This method will ignore variants or fields which are ignored through the
|
|||
|
|
<code>filter</code> and <code>filter_variant</code> methods.</p>
|
|||
|
|
<p>If a variant has been ignored, it will return the <code>init</code> value.</p>
|
|||
|
|
<h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn</span>::<span class="ident">DeriveInput</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">enum</span> <span class="ident">A</span> {
|
|||
|
|
<span class="ident">B</span>(<span class="ident">i32</span>, <span class="ident">i32</span>),
|
|||
|
|
<span class="ident">C</span>(<span class="ident">u32</span>),
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
<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">&</span><span class="ident">di</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<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>)).<span class="ident">to_string</span>(),
|
|||
|
|
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<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">=></span> {
|
|||
|
|
<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>
|
|||
|
|
}
|
|||
|
|
<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">=></span> {
|
|||
|
|
<span class="number">0</span> <span class="op">+</span> <span class="ident">__binding_0</span>
|
|||
|
|
}
|
|||
|
|
}.<span class="ident">to_string</span>()
|
|||
|
|
);</pre>
|
|||
|
|
</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><F, R>(&self, f: F) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a> <span class="where fmt-newline">where<br> 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="../synstructure/struct.VariantInfo.html" title="struct synstructure::VariantInfo">VariantInfo</a>) -> R,<br> R: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1184-1199' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Runs the passed-in function once for each variant, passing in a
|
|||
|
|
<code>VariantInfo</code>. and generating <code>match</code> arms which evaluate the returned
|
|||
|
|
tokens.</p>
|
|||
|
|
<p>This method will ignore variants and not bind fields which are ignored
|
|||
|
|
through the <code>filter</code> and <code>filter_variant</code> methods.</p>
|
|||
|
|
<h1 id="example-2" class="section-header"><a href="#example-2">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn</span>::<span class="ident">DeriveInput</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">enum</span> <span class="ident">A</span> {
|
|||
|
|
<span class="ident">B</span>(<span class="ident">i32</span>, <span class="ident">i32</span>),
|
|||
|
|
<span class="ident">C</span>(<span class="ident">u32</span>),
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
<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">&</span><span class="ident">di</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<span class="ident">s</span>.<span class="ident">each_variant</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> {
|
|||
|
|
<span class="kw">let</span> <span class="ident">name</span> <span class="op">=</span> <span class="kw-2">&</span><span class="ident">v</span>.<span class="ident">ast</span>().<span class="ident">ident</span>;
|
|||
|
|
<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>)))
|
|||
|
|
}).<span class="ident">to_string</span>(),
|
|||
|
|
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<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">=></span> {
|
|||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="macro">stringify</span><span class="macro">!</span>(<span class="ident">B</span>))
|
|||
|
|
}
|
|||
|
|
<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">=></span> {
|
|||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="macro">stringify</span><span class="macro">!</span>(<span class="ident">C</span>))
|
|||
|
|
}
|
|||
|
|
}.<span class="ident">to_string</span>()
|
|||
|
|
);</pre>
|
|||
|
|
</div><h4 id='method.filter' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='filter.v' class='invisible'><code>pub fn <a href='#method.filter' class='fnname'>filter</a><F>(&mut self, f: F) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self <span class="where fmt-newline">where<br> 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="../synstructure/struct.BindingInfo.html" title="struct synstructure::BindingInfo">BindingInfo</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1244-1252' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Filter the bindings created by this <code>Structure</code> object. This has 2 effects:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>
|
|||
|
|
<p>The bindings will no longer appear in match arms generated by methods
|
|||
|
|
on this <code>Structure</code> or its subobjects.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p>Impl blocks created with the <code>bound_impl</code> or <code>unsafe_bound_impl</code>
|
|||
|
|
method only consider type parameters referenced in the types of
|
|||
|
|
non-filtered fields.</p>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h1 id="example-3" class="section-header"><a href="#example-3">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn</span>::<span class="ident">DeriveInput</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">enum</span> <span class="ident">A</span> {
|
|||
|
|
<span class="ident">B</span>{ <span class="ident">a</span>: <span class="ident">i32</span>, <span class="ident">b</span>: <span class="ident">i32</span> },
|
|||
|
|
<span class="ident">C</span>{ <span class="ident">a</span>: <span class="ident">u32</span> },
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
<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">&</span><span class="ident">di</span>);
|
|||
|
|
|
|||
|
|
<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="ident">syn</span>::<span class="ident">Ident</span>::<span class="ident">new</span>(<span class="string">"a"</span>, <span class="ident">proc_macro2</span>::<span class="ident">Span</span>::<span class="ident">call_site</span>()))
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<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">"{:?}"</span>, #<span class="ident">bi</span>))).<span class="ident">to_string</span>(),
|
|||
|
|
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<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">=></span> {
|
|||
|
|
{ <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_0</span>) }
|
|||
|
|
}
|
|||
|
|
<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">=></span> {
|
|||
|
|
{ <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_0</span>) }
|
|||
|
|
}
|
|||
|
|
}.<span class="ident">to_string</span>()
|
|||
|
|
);</pre>
|
|||
|
|
</div><h4 id='method.filter_variants' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='filter_variants.v' class='invisible'><code>pub fn <a href='#method.filter_variants' class='fnname'>filter_variants</a><F>(&mut self, f: F) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self <span class="where fmt-newline">where<br> 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="../synstructure/struct.VariantInfo.html" title="struct synstructure::VariantInfo">VariantInfo</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1293-1303' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Filter the variants matched by this <code>Structure</code> object. This has 2 effects:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>
|
|||
|
|
<p>Match arms destructuring these variants will no longer be generated by
|
|||
|
|
methods on this <code>Structure</code></p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p>Impl blocks created with the <code>bound_impl</code> or <code>unsafe_bound_impl</code>
|
|||
|
|
method only consider type parameters referenced in the types of
|
|||
|
|
fields in non-fitered variants.</p>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h1 id="example-4" class="section-header"><a href="#example-4">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn</span>::<span class="ident">DeriveInput</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">enum</span> <span class="ident">A</span> {
|
|||
|
|
<span class="ident">B</span>(<span class="ident">i32</span>, <span class="ident">i32</span>),
|
|||
|
|
<span class="ident">C</span>(<span class="ident">u32</span>),
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
<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">&</span><span class="ident">di</span>);
|
|||
|
|
|
|||
|
|
<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">"B"</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<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">"{:?}"</span>, #<span class="ident">bi</span>))).<span class="ident">to_string</span>(),
|
|||
|
|
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<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">=></span> {
|
|||
|
|
{ <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_0</span>) }
|
|||
|
|
}
|
|||
|
|
_ <span class="op">=></span> {}
|
|||
|
|
}.<span class="ident">to_string</span>()
|
|||
|
|
);</pre>
|
|||
|
|
</div><h4 id='method.remove_variant' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='remove_variant.v' class='invisible'><code>pub fn <a href='#method.remove_variant' class='fnname'>remove_variant</a>(&mut self, idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1310-1314' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Remove the variant at the given index.</p>
|
|||
|
|
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
|||
|
|
<p>Panics if the index is out of range.</p>
|
|||
|
|
</div><h4 id='method.bind_with' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='bind_with.v' class='invisible'><code>pub fn <a href='#method.bind_with' class='fnname'>bind_with</a><F>(&mut self, f: F) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self <span class="where fmt-newline">where<br> 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="../synstructure/struct.BindingInfo.html" title="struct synstructure::BindingInfo">BindingInfo</a>) -> <a class="enum" href="../synstructure/enum.BindStyle.html" title="enum synstructure::BindStyle">BindStyle</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1351-1359' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Updates the <code>BindStyle</code> for each of the passed-in fields by calling the
|
|||
|
|
passed-in function for each <code>BindingInfo</code>.</p>
|
|||
|
|
<h1 id="example-5" class="section-header"><a href="#example-5">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn</span>::<span class="ident">DeriveInput</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">enum</span> <span class="ident">A</span> {
|
|||
|
|
<span class="ident">B</span>(<span class="ident">i32</span>, <span class="ident">i32</span>),
|
|||
|
|
<span class="ident">C</span>(<span class="ident">u32</span>),
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
<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">&</span><span class="ident">di</span>);
|
|||
|
|
|
|||
|
|
<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>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<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">"{:?}"</span>, #<span class="ident">bi</span>))).<span class="ident">to_string</span>(),
|
|||
|
|
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<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">=></span> {
|
|||
|
|
{ <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_0</span>) }
|
|||
|
|
{ <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_1</span>) }
|
|||
|
|
}
|
|||
|
|
<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">=></span> {
|
|||
|
|
{ <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_0</span>) }
|
|||
|
|
}
|
|||
|
|
}.<span class="ident">to_string</span>()
|
|||
|
|
);</pre>
|
|||
|
|
</div><h4 id='method.binding_name' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='binding_name.v' class='invisible'><code>pub fn <a href='#method.binding_name' class='fnname'>binding_name</a><F>(&mut self, f: F) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self <span class="where fmt-newline">where<br> 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="../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>) -> <a class="struct" href="../proc_macro2/struct.Ident.html" title="struct proc_macro2::Ident">Ident</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1402-1410' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Updates the binding name for each fo the passed-in fields by calling the
|
|||
|
|
passed-in function for each <code>BindingInfo</code>.</p>
|
|||
|
|
<p>The function will be called with the <code>BindingInfo</code> and its index in the
|
|||
|
|
enclosing variant.</p>
|
|||
|
|
<p>The default name is <code>__binding_{}</code> where <code>{}</code> is replaced with an
|
|||
|
|
increasing number.</p>
|
|||
|
|
<h1 id="example-6" class="section-header"><a href="#example-6">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn</span>::<span class="ident">DeriveInput</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">enum</span> <span class="ident">A</span> {
|
|||
|
|
<span class="ident">B</span>{ <span class="ident">a</span>: <span class="ident">i32</span>, <span class="ident">b</span>: <span class="ident">i32</span> },
|
|||
|
|
<span class="ident">C</span>{ <span class="ident">a</span>: <span class="ident">u32</span> },
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
<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">&</span><span class="ident">di</span>);
|
|||
|
|
|
|||
|
|
<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>());
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<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">"{:?}"</span>, #<span class="ident">bi</span>))).<span class="ident">to_string</span>(),
|
|||
|
|
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<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">=></span> {
|
|||
|
|
{ <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">a</span>) }
|
|||
|
|
{ <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">b</span>) }
|
|||
|
|
}
|
|||
|
|
<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">=></span> {
|
|||
|
|
{ <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">a</span>) }
|
|||
|
|
}
|
|||
|
|
}.<span class="ident">to_string</span>()
|
|||
|
|
);</pre>
|
|||
|
|
</div><h4 id='method.referenced_ty_params' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></h3><code class="content"><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></span></code></div></div><span id='referenced_ty_params.v' class='invisible'><code>pub fn <a href='#method.referenced_ty_params' class='fnname'>referenced_ty_params</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><&'a <a class="struct" href="../proc_macro2/struct.Ident.html" title="struct proc_macro2::Ident">Ident</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1445-1453' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a list of the type parameters which are refrenced in the types
|
|||
|
|
of non-filtered fields / variants.</p>
|
|||
|
|
<h1 id="caveat" class="section-header"><a href="#caveat">Caveat</a></h1>
|
|||
|
|
<p>If the struct contains any macros in type position, all parameters will
|
|||
|
|
be considered bound. This is because we cannot determine which type
|
|||
|
|
parameters are bound by type macros.</p>
|
|||
|
|
<h1 id="example-7" class="section-header"><a href="#example-7">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn</span>::<span class="ident">DeriveInput</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">enum</span> <span class="ident">A</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> {
|
|||
|
|
<span class="ident">B</span>(<span class="ident">T</span>, <span class="ident">i32</span>),
|
|||
|
|
<span class="ident">C</span>(<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">U</span><span class="op">></span>),
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
<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">&</span><span class="ident">di</span>);
|
|||
|
|
|
|||
|
|
<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">"C"</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<span class="ident">s</span>.<span class="ident">referenced_ty_params</span>(),
|
|||
|
|
<span class="kw-2">&</span>[<span class="kw-2">&</span>(<span class="ident">syn</span>::<span class="ident">Ident</span>::<span class="ident">new</span>(<span class="string">"T"</span>, <span class="ident">proc_macro2</span>::<span class="ident">Span</span>::<span class="ident">call_site</span>()))]
|
|||
|
|
);</pre>
|
|||
|
|
</div><h4 id='method.add_impl_generic' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='add_impl_generic.v' class='invisible'><code>pub fn <a href='#method.add_impl_generic' class='fnname'>add_impl_generic</a>(&mut self, param: <a class="enum" href="../syn/generics/enum.GenericParam.html" title="enum syn::generics::GenericParam">GenericParam</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1498-1501' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Adds an <code>impl<></code> generic parameter.
|
|||
|
|
This can be used when the trait to be derived needs some extra generic parameters.</p>
|
|||
|
|
<h1 id="example-8" class="section-header"><a href="#example-8">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn</span>::<span class="ident">DeriveInput</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">enum</span> <span class="ident">A</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> {
|
|||
|
|
<span class="ident">B</span>(<span class="ident">T</span>),
|
|||
|
|
<span class="ident">C</span>(<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">U</span><span class="op">></span>),
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
<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">&</span><span class="ident">di</span>);
|
|||
|
|
<span class="kw">let</span> <span class="ident">generic</span>: <span class="ident">syn</span>::<span class="ident">GenericParam</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span>(<span class="ident">X</span>: <span class="ident">krate</span>::<span class="ident">AnotherTrait</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<span class="ident">s</span>.<span class="ident">add_impl_generic</span>(<span class="ident">generic</span>)
|
|||
|
|
.<span class="ident">bound_impl</span>(<span class="macro">quote</span><span class="macro">!</span>(<span class="ident">krate</span>::<span class="ident">Trait</span><span class="op"><</span><span class="ident">X</span><span class="op">></span>),
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
|||
|
|
}
|
|||
|
|
).<span class="ident">to_string</span>(),
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
|||
|
|
<span class="kw">const</span> <span class="ident">_DERIVE_krate_Trait_X_FOR_A</span>: () <span class="op">=</span> {
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">krate</span>;
|
|||
|
|
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span>, <span class="ident">X</span>: <span class="ident">krate</span>::<span class="ident">AnotherTrait</span><span class="op">></span> <span class="ident">krate</span>::<span class="ident">Trait</span><span class="op"><</span><span class="ident">X</span><span class="op">></span> <span class="kw">for</span> <span class="ident">A</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span>
|
|||
|
|
<span class="kw">where</span> <span class="ident">T</span> : <span class="ident">krate</span> :: <span class="ident">Trait</span> <span class="op"><</span> <span class="ident">X</span> <span class="op">></span>,
|
|||
|
|
<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">U</span><span class="op">></span>: <span class="ident">krate</span>::<span class="ident">Trait</span><span class="op"><</span><span class="ident">X</span><span class="op">></span>,
|
|||
|
|
<span class="ident">U</span>: <span class="ident">krate</span>::<span class="ident">Trait</span><span class="op"><</span><span class="ident">X</span><span class="op">></span>
|
|||
|
|
{
|
|||
|
|
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
}.<span class="ident">to_string</span>()
|
|||
|
|
);</pre>
|
|||
|
|
</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> &self, <br> bound: &<a class="struct" href="../syn/generics/struct.TraitBound.html" title="struct syn::generics::TraitBound">TraitBound</a>, <br> where_clause: &mut <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../syn/generics/struct.WhereClause.html" title="struct syn::generics::WhereClause">WhereClause</a>><br>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1511-1555' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Add trait bounds for a trait with the given path for each type parmaeter
|
|||
|
|
referenced in the types of non-filtered fields.</p>
|
|||
|
|
<h1 id="caveat-1" class="section-header"><a href="#caveat-1">Caveat</a></h1>
|
|||
|
|
<p>If the method contains any macros in type position, all parameters will
|
|||
|
|
be considered bound. This is because we cannot determine which type
|
|||
|
|
parameters are bound by type macros.</p>
|
|||
|
|
</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><P: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>, B: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>>(<br> &self, <br> path: P, <br> body: B<br>) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1622-1629' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><blockquote>
|
|||
|
|
<p>NOTE: This methods' features are superceded by <code>Structure::gen_impl</code>.</p>
|
|||
|
|
</blockquote>
|
|||
|
|
<p>Creates an <code>impl</code> block with the required generic type fields filled in
|
|||
|
|
to implement the trait <code>path</code>.</p>
|
|||
|
|
<p>This method also adds where clauses to the impl requiring that all
|
|||
|
|
referenced type parmaeters implement the trait <code>path</code>.</p>
|
|||
|
|
<h1 id="hygiene-and-paths" class="section-header"><a href="#hygiene-and-paths">Hygiene and Paths</a></h1>
|
|||
|
|
<p>This method wraps the impl block inside of a <code>const</code> (see the example
|
|||
|
|
below). In this scope, the first segment of the passed-in path is
|
|||
|
|
<code>extern crate</code>-ed in. If you don't want to generate that <code>extern crate</code>
|
|||
|
|
item, use a global path.</p>
|
|||
|
|
<p>This means that if you are implementing <code>my_crate::Trait</code>, you simply
|
|||
|
|
write <code>s.bound_impl(quote!(my_crate::Trait), quote!(...))</code>, and for the
|
|||
|
|
entirety of the definition, you can refer to your crate as <code>my_crate</code>.</p>
|
|||
|
|
<h1 id="caveat-2" class="section-header"><a href="#caveat-2">Caveat</a></h1>
|
|||
|
|
<p>If the method contains any macros in type position, all parameters will
|
|||
|
|
be considered bound. This is because we cannot determine which type
|
|||
|
|
parameters are bound by type macros.</p>
|
|||
|
|
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
|
|||
|
|
<p>Panics if the path string parameter is not a valid <code>TraitBound</code>.</p>
|
|||
|
|
<h1 id="example-9" class="section-header"><a href="#example-9">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn</span>::<span class="ident">DeriveInput</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">enum</span> <span class="ident">A</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> {
|
|||
|
|
<span class="ident">B</span>(<span class="ident">T</span>),
|
|||
|
|
<span class="ident">C</span>(<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">U</span><span class="op">></span>),
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
<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">&</span><span class="ident">di</span>);
|
|||
|
|
|
|||
|
|
<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">"B"</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<span class="ident">s</span>.<span class="ident">bound_impl</span>(<span class="macro">quote</span><span class="macro">!</span>(<span class="ident">krate</span>::<span class="ident">Trait</span>), <span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
|||
|
|
}).<span class="ident">to_string</span>(),
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
|||
|
|
<span class="kw">const</span> <span class="ident">_DERIVE_krate_Trait_FOR_A</span>: () <span class="op">=</span> {
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">krate</span>;
|
|||
|
|
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> <span class="ident">krate</span>::<span class="ident">Trait</span> <span class="kw">for</span> <span class="ident">A</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span>
|
|||
|
|
<span class="kw">where</span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">U</span><span class="op">></span>: <span class="ident">krate</span>::<span class="ident">Trait</span>,
|
|||
|
|
<span class="ident">U</span>: <span class="ident">krate</span>::<span class="ident">Trait</span>
|
|||
|
|
{
|
|||
|
|
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
}.<span class="ident">to_string</span>()
|
|||
|
|
);</pre>
|
|||
|
|
</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><P: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>, B: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>>(<br> &self, <br> path: P, <br> body: B<br>) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1696-1703' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><blockquote>
|
|||
|
|
<p>NOTE: This methods' features are superceded by <code>Structure::gen_impl</code>.</p>
|
|||
|
|
</blockquote>
|
|||
|
|
<p>Creates an <code>impl</code> block with the required generic type fields filled in
|
|||
|
|
to implement the unsafe trait <code>path</code>.</p>
|
|||
|
|
<p>This method also adds where clauses to the impl requiring that all
|
|||
|
|
referenced type parmaeters implement the trait <code>path</code>.</p>
|
|||
|
|
<h1 id="hygiene-and-paths-1" class="section-header"><a href="#hygiene-and-paths-1">Hygiene and Paths</a></h1>
|
|||
|
|
<p>This method wraps the impl block inside of a <code>const</code> (see the example
|
|||
|
|
below). In this scope, the first segment of the passed-in path is
|
|||
|
|
<code>extern crate</code>-ed in. If you don't want to generate that <code>extern crate</code>
|
|||
|
|
item, use a global path.</p>
|
|||
|
|
<p>This means that if you are implementing <code>my_crate::Trait</code>, you simply
|
|||
|
|
write <code>s.bound_impl(quote!(my_crate::Trait), quote!(...))</code>, and for the
|
|||
|
|
entirety of the definition, you can refer to your crate as <code>my_crate</code>.</p>
|
|||
|
|
<h1 id="caveat-3" class="section-header"><a href="#caveat-3">Caveat</a></h1>
|
|||
|
|
<p>If the method contains any macros in type position, all parameters will
|
|||
|
|
be considered bound. This is because we cannot determine which type
|
|||
|
|
parameters are bound by type macros.</p>
|
|||
|
|
<h1 id="panics-2" class="section-header"><a href="#panics-2">Panics</a></h1>
|
|||
|
|
<p>Panics if the path string parameter is not a valid <code>TraitBound</code>.</p>
|
|||
|
|
<h1 id="example-10" class="section-header"><a href="#example-10">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn</span>::<span class="ident">DeriveInput</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">enum</span> <span class="ident">A</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> {
|
|||
|
|
<span class="ident">B</span>(<span class="ident">T</span>),
|
|||
|
|
<span class="ident">C</span>(<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">U</span><span class="op">></span>),
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
<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">&</span><span class="ident">di</span>);
|
|||
|
|
|
|||
|
|
<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">"B"</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<span class="ident">s</span>.<span class="ident">unsafe_bound_impl</span>(<span class="macro">quote</span><span class="macro">!</span>(<span class="ident">krate</span>::<span class="ident">Trait</span>), <span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
|||
|
|
}).<span class="ident">to_string</span>(),
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
|||
|
|
<span class="kw">const</span> <span class="ident">_DERIVE_krate_Trait_FOR_A</span>: () <span class="op">=</span> {
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">krate</span>;
|
|||
|
|
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> <span class="ident">krate</span>::<span class="ident">Trait</span> <span class="kw">for</span> <span class="ident">A</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span>
|
|||
|
|
<span class="kw">where</span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">U</span><span class="op">></span>: <span class="ident">krate</span>::<span class="ident">Trait</span>,
|
|||
|
|
<span class="ident">U</span>: <span class="ident">krate</span>::<span class="ident">Trait</span>
|
|||
|
|
{
|
|||
|
|
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
}.<span class="ident">to_string</span>()
|
|||
|
|
);</pre>
|
|||
|
|
</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><P: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>, B: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>>(<br> &self, <br> path: P, <br> body: B<br>) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1760-1767' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><blockquote>
|
|||
|
|
<p>NOTE: This methods' features are superceded by <code>Structure::gen_impl</code>.</p>
|
|||
|
|
</blockquote>
|
|||
|
|
<p>Creates an <code>impl</code> block with the required generic type fields filled in
|
|||
|
|
to implement the trait <code>path</code>.</p>
|
|||
|
|
<p>This method will not add any where clauses to the impl.</p>
|
|||
|
|
<h1 id="hygiene-and-paths-2" class="section-header"><a href="#hygiene-and-paths-2">Hygiene and Paths</a></h1>
|
|||
|
|
<p>This method wraps the impl block inside of a <code>const</code> (see the example
|
|||
|
|
below). In this scope, the first segment of the passed-in path is
|
|||
|
|
<code>extern crate</code>-ed in. If you don't want to generate that <code>extern crate</code>
|
|||
|
|
item, use a global path.</p>
|
|||
|
|
<p>This means that if you are implementing <code>my_crate::Trait</code>, you simply
|
|||
|
|
write <code>s.bound_impl(quote!(my_crate::Trait), quote!(...))</code>, and for the
|
|||
|
|
entirety of the definition, you can refer to your crate as <code>my_crate</code>.</p>
|
|||
|
|
<h1 id="panics-3" class="section-header"><a href="#panics-3">Panics</a></h1>
|
|||
|
|
<p>Panics if the path string parameter is not a valid <code>TraitBound</code>.</p>
|
|||
|
|
<h1 id="example-11" class="section-header"><a href="#example-11">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn</span>::<span class="ident">DeriveInput</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">enum</span> <span class="ident">A</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> {
|
|||
|
|
<span class="ident">B</span>(<span class="ident">T</span>),
|
|||
|
|
<span class="ident">C</span>(<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">U</span><span class="op">></span>),
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
<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">&</span><span class="ident">di</span>);
|
|||
|
|
|
|||
|
|
<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">"B"</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<span class="ident">s</span>.<span class="ident">unbound_impl</span>(<span class="macro">quote</span><span class="macro">!</span>(<span class="ident">krate</span>::<span class="ident">Trait</span>), <span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
|||
|
|
}).<span class="ident">to_string</span>(),
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
|||
|
|
<span class="kw">const</span> <span class="ident">_DERIVE_krate_Trait_FOR_A</span>: () <span class="op">=</span> {
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">krate</span>;
|
|||
|
|
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> <span class="ident">krate</span>::<span class="ident">Trait</span> <span class="kw">for</span> <span class="ident">A</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> {
|
|||
|
|
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
}.<span class="ident">to_string</span>()
|
|||
|
|
);</pre>
|
|||
|
|
</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><P: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>, B: <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a>>(<br> &self, <br> path: P, <br> body: B<br>) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#1825-1832' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='stability'><div class='stab deprecated'>Deprecated</div></div><div class='docblock'><blockquote>
|
|||
|
|
<p>NOTE: This methods' features are superceded by <code>Structure::gen_impl</code>.</p>
|
|||
|
|
</blockquote>
|
|||
|
|
<p>Creates an <code>impl</code> block with the required generic type fields filled in
|
|||
|
|
to implement the unsafe trait <code>path</code>.</p>
|
|||
|
|
<p>This method will not add any where clauses to the impl.</p>
|
|||
|
|
<h1 id="hygiene-and-paths-3" class="section-header"><a href="#hygiene-and-paths-3">Hygiene and Paths</a></h1>
|
|||
|
|
<p>This method wraps the impl block inside of a <code>const</code> (see the example
|
|||
|
|
below). In this scope, the first segment of the passed-in path is
|
|||
|
|
<code>extern crate</code>-ed in. If you don't want to generate that <code>extern crate</code>
|
|||
|
|
item, use a global path.</p>
|
|||
|
|
<p>This means that if you are implementing <code>my_crate::Trait</code>, you simply
|
|||
|
|
write <code>s.bound_impl(quote!(my_crate::Trait), quote!(...))</code>, and for the
|
|||
|
|
entirety of the definition, you can refer to your crate as <code>my_crate</code>.</p>
|
|||
|
|
<h1 id="panics-4" class="section-header"><a href="#panics-4">Panics</a></h1>
|
|||
|
|
<p>Panics if the path string parameter is not a valid <code>TraitBound</code>.</p>
|
|||
|
|
<h1 id="example-12" class="section-header"><a href="#example-12">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn</span>::<span class="ident">DeriveInput</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">enum</span> <span class="ident">A</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> {
|
|||
|
|
<span class="ident">B</span>(<span class="ident">T</span>),
|
|||
|
|
<span class="ident">C</span>(<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">U</span><span class="op">></span>),
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
<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">&</span><span class="ident">di</span>);
|
|||
|
|
|
|||
|
|
<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">"B"</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<span class="ident">s</span>.<span class="ident">unsafe_unbound_impl</span>(<span class="macro">quote</span><span class="macro">!</span>(<span class="ident">krate</span>::<span class="ident">Trait</span>), <span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
|||
|
|
}).<span class="ident">to_string</span>(),
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
|||
|
|
<span class="kw">const</span> <span class="ident">_DERIVE_krate_Trait_FOR_A</span>: () <span class="op">=</span> {
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">krate</span>;
|
|||
|
|
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> <span class="ident">krate</span>::<span class="ident">Trait</span> <span class="kw">for</span> <span class="ident">A</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> {
|
|||
|
|
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
}.<span class="ident">to_string</span>()
|
|||
|
|
);</pre>
|
|||
|
|
</div><h4 id='method.gen_impl' class="method"><span id='gen_impl.v' class='invisible'><code>pub fn <a href='#method.gen_impl' class='fnname'>gen_impl</a>(&self, cfg: <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#2049-2159' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Generate an impl block for the given struct. This impl block will
|
|||
|
|
automatically use hygiene tricks to avoid polluting the caller's
|
|||
|
|
namespace, and will automatically add trait bounds for generic type
|
|||
|
|
parameters.</p>
|
|||
|
|
<h1 id="syntax" class="section-header"><a href="#syntax">Syntax</a></h1>
|
|||
|
|
<p>This function accepts its arguments as a <code>TokenStream</code>. The recommended way
|
|||
|
|
to call this function is passing the result of invoking the <code>quote!</code>
|
|||
|
|
macro to it.</p>
|
|||
|
|
|
|||
|
|
<div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
|
|||
|
|
<span class="ident">s</span>.<span class="ident">gen_impl</span>(<span class="macro">quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="comment">// You can write any items which you want to import into scope here.</span>
|
|||
|
|
<span class="comment">// For example, you may want to include an `extern crate` for the</span>
|
|||
|
|
<span class="comment">// crate which implements your trait. These items will only be</span>
|
|||
|
|
<span class="comment">// visible to the code you generate, and won't be exposed to the</span>
|
|||
|
|
<span class="comment">// consuming crate</span>
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">krate</span>;
|
|||
|
|
|
|||
|
|
<span class="comment">// You can also add `use` statements here to bring types or traits</span>
|
|||
|
|
<span class="comment">// into scope.</span>
|
|||
|
|
<span class="comment">//</span>
|
|||
|
|
<span class="comment">// WARNING: Try not to use common names here, because the stable</span>
|
|||
|
|
<span class="comment">// version of syn does not support hygiene and you could accidentally</span>
|
|||
|
|
<span class="comment">// shadow types from the caller crate.</span>
|
|||
|
|
<span class="kw">use</span> <span class="ident">krate</span>::<span class="ident">Trait</span> <span class="kw">as</span> <span class="ident">MyTrait</span>;
|
|||
|
|
|
|||
|
|
<span class="comment">// The actual impl block is a `gen impl` or `gen unsafe impl` block.</span>
|
|||
|
|
<span class="comment">// You can use `@Self` to refer to the structure's type.</span>
|
|||
|
|
<span class="ident">gen</span> <span class="kw">impl</span> <span class="ident">MyTrait</span> <span class="kw">for</span> @<span class="self">Self</span> {
|
|||
|
|
<span class="kw">fn</span> <span class="ident">f</span>(<span class="kw-2">&</span><span class="self">self</span>) { ... }
|
|||
|
|
}
|
|||
|
|
})</pre>
|
|||
|
|
<p>The most common usage of this trait involves loading the crate the
|
|||
|
|
target trait comes from with <code>extern crate</code>, and then invoking a <code>gen impl</code> block.</p>
|
|||
|
|
<h1 id="hygiene" class="section-header"><a href="#hygiene">Hygiene</a></h1>
|
|||
|
|
<p>This method tries to handle hygiene intelligenly for both stable and
|
|||
|
|
unstable proc-macro implementations, however there are visible
|
|||
|
|
differences.</p>
|
|||
|
|
<p>The output of every <code>gen_impl</code> function is wrapped in a dummy <code>const</code>
|
|||
|
|
value, to ensure that it is given its own scope, and any values brought
|
|||
|
|
into scope are not leaked to the calling crate. For example, the above
|
|||
|
|
invocation may generate an output like the following:</p>
|
|||
|
|
|
|||
|
|
<div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
|
|||
|
|
<span class="kw">const</span> <span class="ident">_DERIVE_krate_Trait_FOR_Struct</span>: () <span class="op">=</span> {
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">krate</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">krate</span>::<span class="ident">Trait</span> <span class="kw">as</span> <span class="ident">MyTrait</span>;
|
|||
|
|
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">MyTrait</span> <span class="kw">for</span> <span class="ident">Struct</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">where</span> <span class="ident">T</span>: <span class="ident">MyTrait</span> {
|
|||
|
|
<span class="kw">fn</span> <span class="ident">f</span>(<span class="kw-2">&</span><span class="self">self</span>) { ... }
|
|||
|
|
}
|
|||
|
|
};</pre>
|
|||
|
|
<h3 id="using-the-std-crate" class="section-header"><a href="#using-the-std-crate">Using the <code>std</code> crate</a></h3>
|
|||
|
|
<p>If you are using <code>quote!()</code> to implement your trait, with the
|
|||
|
|
<code>proc-macro2/nightly</code> feature, <code>std</code> isn't considered to be in scope for
|
|||
|
|
your macro. This means that if you use types from <code>std</code> in your
|
|||
|
|
procedural macro, you'll want to explicitly load it with an <code>extern crate std;</code>.</p>
|
|||
|
|
<h3 id="absolute-paths" class="section-header"><a href="#absolute-paths">Absolute paths</a></h3>
|
|||
|
|
<p>You should generally avoid using absolute paths in your generated code,
|
|||
|
|
as they will resolve very differently when using the stable and nightly
|
|||
|
|
versions of <code>proc-macro2</code>. Instead, load the crates you need to use
|
|||
|
|
explictly with <code>extern crate</code> and</p>
|
|||
|
|
<h1 id="trait-bounds" class="section-header"><a href="#trait-bounds">Trait Bounds</a></h1>
|
|||
|
|
<p>This method will automatically add trait bounds for any type parameters
|
|||
|
|
which are referenced within the types of non-ignored fields.</p>
|
|||
|
|
<p>Additional type parameters may be added with the generics syntax after
|
|||
|
|
the <code>impl</code> keyword.</p>
|
|||
|
|
<h3 id="type-macro-caveat" class="section-header"><a href="#type-macro-caveat">Type Macro Caveat</a></h3>
|
|||
|
|
<p>If the method contains any macros in type position, all parameters will
|
|||
|
|
be considered bound. This is because we cannot determine which type
|
|||
|
|
parameters are bound by type macros.</p>
|
|||
|
|
<h1 id="panics-5" class="section-header"><a href="#panics-5">Panics</a></h1>
|
|||
|
|
<p>This function will panic if the input <code>TokenStream</code> is not well-formed, or
|
|||
|
|
if additional type parameters added by <code>impl<..></code> conflict with generic
|
|||
|
|
type parameters on the original struct.</p>
|
|||
|
|
<h1 id="example-usage" class="section-header"><a href="#example-usage">Example Usage</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn</span>::<span class="ident">DeriveInput</span> <span class="op">=</span> <span class="macro">parse_quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">enum</span> <span class="ident">A</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> {
|
|||
|
|
<span class="ident">B</span>(<span class="ident">T</span>),
|
|||
|
|
<span class="ident">C</span>(<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">U</span><span class="op">></span>),
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
<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">&</span><span class="ident">di</span>);
|
|||
|
|
|
|||
|
|
<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">"B"</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<span class="ident">s</span>.<span class="ident">gen_impl</span>(<span class="macro">quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">krate</span>;
|
|||
|
|
<span class="ident">gen</span> <span class="kw">impl</span> <span class="ident">krate</span>::<span class="ident">Trait</span> <span class="kw">for</span> @<span class="self">Self</span> {
|
|||
|
|
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
|||
|
|
}
|
|||
|
|
}).<span class="ident">to_string</span>(),
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
|||
|
|
<span class="kw">const</span> <span class="ident">_DERIVE_krate_Trait_FOR_A</span>: () <span class="op">=</span> {
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">krate</span>;
|
|||
|
|
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> <span class="ident">krate</span>::<span class="ident">Trait</span> <span class="kw">for</span> <span class="ident">A</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span>
|
|||
|
|
<span class="kw">where</span>
|
|||
|
|
<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">U</span><span class="op">></span>: <span class="ident">krate</span>::<span class="ident">Trait</span>,
|
|||
|
|
<span class="ident">U</span>: <span class="ident">krate</span>::<span class="ident">Trait</span>
|
|||
|
|
{
|
|||
|
|
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
}.<span class="ident">to_string</span>()
|
|||
|
|
);
|
|||
|
|
|
|||
|
|
<span class="comment">// NOTE: You can also add extra generics after the impl</span>
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
|||
|
|
<span class="ident">s</span>.<span class="ident">gen_impl</span>(<span class="macro">quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">krate</span>;
|
|||
|
|
<span class="ident">gen</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">X</span>: <span class="ident">krate</span>::<span class="ident">OtherTrait</span><span class="op">></span> <span class="ident">krate</span>::<span class="ident">Trait</span><span class="op"><</span><span class="ident">X</span><span class="op">></span> <span class="kw">for</span> @<span class="self">Self</span>
|
|||
|
|
<span class="kw">where</span>
|
|||
|
|
<span class="ident">X</span>: <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span>,
|
|||
|
|
{
|
|||
|
|
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
|||
|
|
}
|
|||
|
|
}).<span class="ident">to_string</span>(),
|
|||
|
|
<span class="macro">quote</span><span class="macro">!</span>{
|
|||
|
|
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
|||
|
|
<span class="kw">const</span> <span class="ident">_DERIVE_krate_Trait_X_FOR_A</span>: () <span class="op">=</span> {
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">krate</span>;
|
|||
|
|
<span class="kw">impl</span><span class="op"><</span><span class="ident">X</span>: <span class="ident">krate</span>::<span class="ident">OtherTrait</span>, <span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> <span class="ident">krate</span>::<span class="ident">Trait</span><span class="op"><</span><span class="ident">X</span><span class="op">></span> <span class="kw">for</span> <span class="ident">A</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span>
|
|||
|
|
<span class="kw">where</span>
|
|||
|
|
<span class="ident">X</span>: <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span>,
|
|||
|
|
<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">U</span><span class="op">></span>: <span class="ident">krate</span>::<span class="ident">Trait</span><span class="op"><</span><span class="ident">X</span><span class="op">></span>,
|
|||
|
|
<span class="ident">U</span>: <span class="ident">krate</span>::<span class="ident">Trait</span><span class="op"><</span><span class="ident">X</span><span class="op">></span>
|
|||
|
|
{
|
|||
|
|
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
}.<span class="ident">to_string</span>()
|
|||
|
|
);</pre>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl<'a> <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><'a></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#953' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<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>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <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#953' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<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>
|
|||
|
|
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl<'a> <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><'a></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#953' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<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>(&self) -> <a class="struct" href="../synstructure/struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#953' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<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>
|
|||
|
|
</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>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</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>
|
|||
|
|
<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>
|
|||
|
|
</div></div><h3 id='impl-PartialEq' class='impl'><span class='in-band'><code>impl<'a> <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><'a></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#953' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<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>(&self, __arg_0: &<a class="struct" href="../synstructure/struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a>) -> <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#953' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<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>
|
|||
|
|
</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>(&self, __arg_0: &<a class="struct" href="../synstructure/struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a>) -> <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#953' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
|||
|
|
</div></div><h3 id='impl-Eq' class='impl'><span class='in-band'><code>impl<'a> <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><'a></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#953' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'></div><h3 id='impl-Hash' class='impl'><span class='in-band'><code>impl<'a> <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><'a></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#953' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<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><__H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>>(&self, __arg_0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>__H)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/synstructure/lib.rs.html#953' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<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>
|
|||
|
|
</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><H>(data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[Self]</a>, state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>H) <span class="where fmt-newline">where<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>, </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>
|
|||
|
|
<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>
|
|||
|
|
</div></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>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../";
|
|||
|
|
window.currentCrate = "synstructure";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|