mirror of
https://github.com/trussed-dev/flexiber.git
synced 2026-03-11 16:35:17 -07:00
781 lines
122 KiB
HTML
781 lines
122 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="A wrapper around a `syn::DeriveInput` which provides utilities for creating custom derive trait implementations."><meta name="keywords" content="rust, rustlang, rust-lang, Structure"><title>Structure in synstructure - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../synstructure/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><h2 class="location">Struct Structure</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><div class="sidebar-links"><a href="#method.add_bounds">add_bounds</a><a href="#method.add_impl_generic">add_impl_generic</a><a href="#method.add_trait_bounds">add_trait_bounds</a><a href="#method.add_where_predicate">add_where_predicate</a><a href="#method.ast">ast</a><a href="#method.bind_with">bind_with</a><a href="#method.binding_name">binding_name</a><a href="#method.bound_impl">bound_impl</a><a href="#method.each">each</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.fold">fold</a><a href="#method.gen_impl">gen_impl</a><a href="#method.new">new</a><a href="#method.omitted_variants">omitted_variants</a><a href="#method.referenced_ty_params">referenced_ty_params</a><a href="#method.remove_variant">remove_variant</a><a href="#method.try_new">try_new</a><a href="#method.unbound_impl">unbound_impl</a><a href="#method.underscore_const">underscore_const</a><a href="#method.unsafe_bound_impl">unsafe_bound_impl</a><a href="#method.unsafe_unbound_impl">unsafe_unbound_impl</a><a href="#method.variants">variants</a><a href="#method.variants_mut">variants_mut</a></div><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Eq">Eq</a><a href="#impl-Hash">Hash</a><a href="#impl-PartialEq%3CStructure%3C%27a%3E%3E">PartialEq<Structure<'a>></a><a href="#impl-StructuralEq">StructuralEq</a><a href="#impl-StructuralPartialEq">StructuralPartialEq</a></div><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><h2 class="location">Other items in<br><a href="index.html">synstructure</a></h2><div id="sidebar-vars" data-name="Structure" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></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><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></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#939-947" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust struct"><code>pub struct Structure<'a> { /* fields omitted */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A wrapper around a <code>syn::DeriveInput</code> which provides utilities for creating
|
||
custom derive trait implementations.</p>
|
||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#949-2310" title="goto source code">[src]</a></div><a href="#impl" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.new" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#957-959" title="goto source code">[src]</a></div><a href="#method.new" class="anchor"></a><h4 class="code-header">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</h4></div></summary><div class="docblock"><p>Create a new <code>Structure</code> with the variants and fields from the passed-in
|
||
<code>DeriveInput</code>.</p>
|
||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||
<p>This method will panic if the provided AST node represents an untagged
|
||
union.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_new" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#966-1021" title="goto source code">[src]</a></div><a href="#method.try_new" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.try_new" class="fnname">try_new</a>(ast: &'a <a class="struct" href="../syn/derive/struct.DeriveInput.html" title="struct syn::derive::DeriveInput">DeriveInput</a>) -> <a class="type" href="../syn/error/type.Result.html" title="type syn::error::Result">Result</a><Self></h4></div></summary><div class="docblock"><p>Create a new <code>Structure</code> with the variants and fields from the passed-in
|
||
<code>DeriveInput</code>.</p>
|
||
<p>Unlike <code>Structure::new</code>, this method does not panic if the provided AST
|
||
node represents an untagged union.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.variants" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1024-1026" title="goto source code">[src]</a></div><a href="#method.variants" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.variants" class="fnname">variants</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.slice.html">&[</a><a class="struct" href="struct.VariantInfo.html" title="struct synstructure::VariantInfo">VariantInfo</a><'a><a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.slice.html">]</a></h4></div></summary><div class="docblock"><p>Returns a slice of the variants in this Structure.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.variants_mut" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1029-1031" title="goto source code">[src]</a></div><a href="#method.variants_mut" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.variants_mut" class="fnname">variants_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.slice.html">&mut [</a><a class="struct" href="struct.VariantInfo.html" title="struct synstructure::VariantInfo">VariantInfo</a><'a><a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.slice.html">]</a></h4></div></summary><div class="docblock"><p>Returns a mut slice of the variants in this Structure.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ast" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1035-1037" title="goto source code">[src]</a></div><a href="#method.ast" class="anchor"></a><h4 class="code-header">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></h4></div></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.omitted_variants" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1040-1042" title="goto source code">[src]</a></div><a href="#method.omitted_variants" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.omitted_variants" class="fnname">omitted_variants</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a></h4></div></summary><div class="docblock"><p>True if any variants were omitted due to a <code>filter_variants</code> call.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.each" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1075-1088" title="goto source code">[src]</a></div><a href="#method.each" class="anchor"></a><h4 class="code-header">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/1.56.1/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="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></h4></div></summary><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>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::new</span>(<span class="kw-2">&</span><span class="ident">di</span>);
|
||
|
||
<span class="macro">assert_eq!</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">println!</span>(<span class="string">"{:?}"</span>, #<span class="ident">bi</span>))).<span class="ident">to_string</span>(),
|
||
|
||
<span class="macro">quote!</span>{
|
||
<span class="ident">A::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="op">></span> {
|
||
{ <span class="macro">println!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_0</span>) }
|
||
{ <span class="macro">println!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_1</span>) }
|
||
}
|
||
<span class="ident">A::C</span>(<span class="kw-2">ref</span> <span class="ident">__binding_0</span>,) <span class="op">=</span><span class="op">></span> {
|
||
{ <span class="macro">println!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_0</span>) }
|
||
}
|
||
}.<span class="ident">to_string</span>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fold" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1123-1137" title="goto source code">[src]</a></div><a href="#method.fold" class="anchor"></a><h4 class="code-header">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/1.56.1/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="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></h4></div></summary><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>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::new</span>(<span class="kw-2">&</span><span class="ident">di</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">s</span>.<span class="ident">fold</span>(<span class="macro">quote!</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="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="ident">A::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="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::C</span>(<span class="kw-2">ref</span> <span class="ident">__binding_0</span>,) <span class="op">=</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>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.each_variant" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1173-1188" title="goto source code">[src]</a></div><a href="#method.each_variant" class="anchor"></a><h4 class="code-header">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/1.56.1/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="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></h4></div></summary><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>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::new</span>(<span class="kw-2">&</span><span class="ident">di</span>);
|
||
|
||
<span class="macro">assert_eq!</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">println!</span>(<span class="macro">stringify!</span>(#<span class="ident">name</span>)))
|
||
}).<span class="ident">to_string</span>(),
|
||
|
||
<span class="macro">quote!</span>{
|
||
<span class="ident">A::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="op">></span> {
|
||
<span class="macro">println!</span>(<span class="macro">stringify!</span>(<span class="ident">B</span>))
|
||
}
|
||
<span class="ident">A::C</span>(<span class="kw-2">ref</span> <span class="ident">__binding_0</span>,) <span class="op">=</span><span class="op">></span> {
|
||
<span class="macro">println!</span>(<span class="macro">stringify!</span>(<span class="ident">C</span>))
|
||
}
|
||
}.<span class="ident">to_string</span>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.filter" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1227-1235" title="goto source code">[src]</a></div><a href="#method.filter" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.filter" class="fnname">filter</a><F>(&mut self, f: F) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.reference.html">&mut </a>Self <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="struct.BindingInfo.html" title="struct synstructure::BindingInfo">BindingInfo</a><'_>) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a>, </span></h4></div></summary><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>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::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="op">=</span> <span class="prelude-val">Some</span>(<span class="macro">quote::format_ident!</span>(<span class="string">"a"</span>))
|
||
});
|
||
|
||
<span class="macro">assert_eq!</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">println!</span>(<span class="string">"{:?}"</span>, #<span class="ident">bi</span>))).<span class="ident">to_string</span>(),
|
||
|
||
<span class="macro">quote!</span>{
|
||
<span class="ident">A::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="op">></span> {
|
||
{ <span class="macro">println!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_0</span>) }
|
||
}
|
||
<span class="ident">A::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="op">></span> {
|
||
{ <span class="macro">println!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_0</span>) }
|
||
}
|
||
}.<span class="ident">to_string</span>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.add_where_predicate" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1276-1279" title="goto source code">[src]</a></div><a href="#method.add_where_predicate" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.add_where_predicate" class="fnname">add_where_predicate</a>(&mut self, pred: <a class="enum" href="../syn/generics/enum.WherePredicate.html" title="enum syn::generics::WherePredicate">WherePredicate</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.reference.html">&mut </a>Self</h4></div></summary><div class="docblock"><p>Specify additional where predicate bounds which should be generated by
|
||
impl-generating functions such as <code>gen_impl</code>, <code>bound_impl</code>, and
|
||
<code>unsafe_bound_impl</code>.</p>
|
||
<h1 id="example-4" class="section-header"><a href="#example-4">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::new</span>(<span class="kw-2">&</span><span class="ident">di</span>);
|
||
|
||
<span class="comment">// Add an additional where predicate.</span>
|
||
<span class="ident">s</span>.<span class="ident">add_where_predicate</span>(<span class="macro">syn::parse_quote!</span>(<span class="ident">T</span>: <span class="ident">std::fmt::Display</span>));
|
||
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">s</span>.<span class="ident">bound_impl</span>(<span class="macro">quote!</span>(<span class="ident">krate::Trait</span>), <span class="macro">quote!</span>{
|
||
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
||
}).<span class="ident">to_string</span>(),
|
||
<span class="macro">quote!</span>{
|
||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</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::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="ident">T</span>: <span class="ident">std::fmt::Display</span>,
|
||
<span class="ident">T</span>: <span class="ident">krate::Trait</span>,
|
||
<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">U</span><span class="op">></span>: <span class="ident">krate::Trait</span>,
|
||
<span class="ident">U</span>: <span class="ident">krate::Trait</span>
|
||
{
|
||
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
||
}
|
||
};
|
||
}.<span class="ident">to_string</span>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.add_bounds" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1320-1323" title="goto source code">[src]</a></div><a href="#method.add_bounds" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.add_bounds" class="fnname">add_bounds</a>(&mut self, mode: <a class="enum" href="enum.AddBounds.html" title="enum synstructure::AddBounds">AddBounds</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.reference.html">&mut </a>Self</h4></div></summary><div class="docblock"><p>Specify which bounds should be generated by impl-generating functions
|
||
such as <code>gen_impl</code>, <code>bound_impl</code>, and <code>unsafe_bound_impl</code>.</p>
|
||
<p>The default behaviour is to generate both field and generic bounds from
|
||
type parameters.</p>
|
||
<h1 id="example-5" class="section-header"><a href="#example-5">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::new</span>(<span class="kw-2">&</span><span class="ident">di</span>);
|
||
|
||
<span class="comment">// Limit bounds to only generics.</span>
|
||
<span class="ident">s</span>.<span class="ident">add_bounds</span>(<span class="ident">AddBounds::Generics</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">s</span>.<span class="ident">bound_impl</span>(<span class="macro">quote!</span>(<span class="ident">krate::Trait</span>), <span class="macro">quote!</span>{
|
||
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
||
}).<span class="ident">to_string</span>(),
|
||
<span class="macro">quote!</span>{
|
||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</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::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="ident">T</span>: <span class="ident">krate::Trait</span>,
|
||
<span class="ident">U</span>: <span class="ident">krate::Trait</span>
|
||
{
|
||
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
||
}
|
||
};
|
||
}.<span class="ident">to_string</span>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.filter_variants" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1359-1369" title="goto source code">[src]</a></div><a href="#method.filter_variants" class="anchor"></a><h4 class="code-header">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/1.56.1/std/primitive.reference.html">&mut </a>Self <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="struct.VariantInfo.html" title="struct synstructure::VariantInfo">VariantInfo</a><'_>) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a>, </span></h4></div></summary><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-6" class="section-header"><a href="#example-6">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::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="op">=</span> <span class="string">"B"</span>);
|
||
|
||
<span class="macro">assert_eq!</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">println!</span>(<span class="string">"{:?}"</span>, #<span class="ident">bi</span>))).<span class="ident">to_string</span>(),
|
||
|
||
<span class="macro">quote!</span>{
|
||
<span class="ident">A::C</span>(<span class="kw-2">ref</span> <span class="ident">__binding_0</span>,) <span class="op">=</span><span class="op">></span> {
|
||
{ <span class="macro">println!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_0</span>) }
|
||
}
|
||
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> {}
|
||
}.<span class="ident">to_string</span>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.remove_variant" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1376-1380" title="goto source code">[src]</a></div><a href="#method.remove_variant" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.remove_variant" class="fnname">remove_variant</a>(&mut self, idx: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.reference.html">&mut </a>Self</h4></div></summary><div class="docblock"><p>Remove the variant at the given index.</p>
|
||
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
|
||
<p>Panics if the index is out of range.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.bind_with" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1412-1420" title="goto source code">[src]</a></div><a href="#method.bind_with" class="anchor"></a><h4 class="code-header">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/1.56.1/std/primitive.reference.html">&mut </a>Self <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="struct.BindingInfo.html" title="struct synstructure::BindingInfo">BindingInfo</a><'_>) -> <a class="enum" href="enum.BindStyle.html" title="enum synstructure::BindStyle">BindStyle</a>, </span></h4></div></summary><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-7" class="section-header"><a href="#example-7">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::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::RefMut</span>);
|
||
|
||
<span class="macro">assert_eq!</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">println!</span>(<span class="string">"{:?}"</span>, #<span class="ident">bi</span>))).<span class="ident">to_string</span>(),
|
||
|
||
<span class="macro">quote!</span>{
|
||
<span class="ident">A::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="op">></span> {
|
||
{ <span class="macro">println!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_0</span>) }
|
||
{ <span class="macro">println!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_1</span>) }
|
||
}
|
||
<span class="ident">A::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="op">></span> {
|
||
{ <span class="macro">println!</span>(<span class="string">"{:?}"</span>, <span class="ident">__binding_0</span>) }
|
||
}
|
||
}.<span class="ident">to_string</span>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.binding_name" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1458-1466" title="goto source code">[src]</a></div><a href="#method.binding_name" class="anchor"></a><h4 class="code-header">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/1.56.1/std/primitive.reference.html">&mut </a>Self <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.56.1/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/1.56.1/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../proc_macro2/struct.Ident.html" title="struct proc_macro2::Ident">Ident</a>, </span></h4></div></summary><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-8" class="section-header"><a href="#example-8">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::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="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">println!</span>(<span class="string">"{:?}"</span>, #<span class="ident">bi</span>))).<span class="ident">to_string</span>(),
|
||
|
||
<span class="macro">quote!</span>{
|
||
<span class="ident">A::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="op">></span> {
|
||
{ <span class="macro">println!</span>(<span class="string">"{:?}"</span>, <span class="ident">a</span>) }
|
||
{ <span class="macro">println!</span>(<span class="string">"{:?}"</span>, <span class="ident">b</span>) }
|
||
}
|
||
<span class="ident">A::C</span>{ <span class="ident">a</span>: <span class="kw-2">ref</span> <span class="ident">a</span>, } <span class="op">=</span><span class="op">></span> {
|
||
{ <span class="macro">println!</span>(<span class="string">"{:?}"</span>, <span class="ident">a</span>) }
|
||
}
|
||
}.<span class="ident">to_string</span>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.referenced_ty_params" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1495-1503" title="goto source code">[src]</a></div><a href="#method.referenced_ty_params" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.referenced_ty_params" class="fnname">referenced_ty_params</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.56.1/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>></h4></div></summary><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-9" class="section-header"><a href="#example-9">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::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="op">=</span> <span class="string">"C"</span>);
|
||
|
||
<span class="macro">assert_eq!</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="macro">quote::format_ident!</span>(<span class="string">"T"</span>)]
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.add_impl_generic" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1543-1546" title="goto source code">[src]</a></div><a href="#method.add_impl_generic" class="anchor"></a><h4 class="code-header">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/1.56.1/std/primitive.reference.html">&mut </a>Self</h4></div></summary><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-10" class="section-header"><a href="#example-10">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::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::GenericParam</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</span>(<span class="ident">X</span>: <span class="ident">krate::AnotherTrait</span>);
|
||
|
||
<span class="macro">assert_eq!</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="ident">krate::Trait</span><span class="op"><</span><span class="ident">X</span><span class="op">></span>),
|
||
<span class="macro">quote!</span>{
|
||
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
||
}
|
||
).<span class="ident">to_string</span>(),
|
||
<span class="macro">quote!</span>{
|
||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</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::AnotherTrait</span><span class="op">></span> <span class="ident">krate::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::Trait</span><span class="op"><</span><span class="ident">X</span><span class="op">></span>,
|
||
<span class="ident">U</span>: <span class="ident">krate::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>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.add_trait_bounds" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1556-1621" title="goto source code">[src]</a></div><a href="#method.add_trait_bounds" class="anchor"></a><h4 class="code-header">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/1.56.1/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> mode: <a class="enum" href="enum.AddBounds.html" title="enum synstructure::AddBounds">AddBounds</a><br>)</h4></div></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.underscore_const" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1664-1667" title="goto source code">[src]</a></div><a href="#method.underscore_const" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.underscore_const" class="fnname">underscore_const</a>(&mut self, enabled: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.reference.html">&mut </a>Self</h4></div></summary><div class="docblock"><p>Configure whether to use <code>const _</code> instead of a generated const name in
|
||
code generated by <code>gen_impl</code> and <code>bound_impl</code>.</p>
|
||
<p>This syntax is only supported by rust 1.37, and later versions.</p>
|
||
<p>Defaults to <code>false</code> for backwards compatibility reasons.</p>
|
||
<h1 id="example-11" class="section-header"><a href="#example-11">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</span> {
|
||
<span class="kw">struct</span> <span class="ident">MyStruct</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::new</span>(<span class="kw-2">&</span><span class="ident">di</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">s</span>.<span class="ident">underscore_const</span>(<span class="bool-val">true</span>)
|
||
.<span class="ident">gen_impl</span>(<span class="macro">quote!</span> { <span class="ident">gen</span> <span class="kw">impl</span> <span class="ident">Trait</span> <span class="kw">for</span> @<span class="self">Self</span> { } })
|
||
.<span class="ident">to_string</span>(),
|
||
<span class="macro">quote!</span> {
|
||
<span class="kw">const</span> <span class="kw">_</span>: () <span class="op">=</span> {
|
||
<span class="kw">impl</span> <span class="ident">Trait</span> <span class="kw">for</span> <span class="ident">MyStruct</span> { }
|
||
};
|
||
}
|
||
.<span class="ident">to_string</span>()
|
||
);
|
||
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">s</span>.<span class="ident">underscore_const</span>(<span class="bool-val">false</span>)
|
||
.<span class="ident">gen_impl</span>(<span class="macro">quote!</span> { <span class="ident">gen</span> <span class="kw">impl</span> <span class="ident">Trait</span> <span class="kw">for</span> @<span class="self">Self</span> { } })
|
||
.<span class="ident">to_string</span>(),
|
||
<span class="macro">quote!</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_Trait_FOR_MyStruct</span>: () <span class="op">=</span> {
|
||
<span class="kw">impl</span> <span class="ident">Trait</span> <span class="kw">for</span> <span class="ident">MyStruct</span> { }
|
||
};
|
||
}
|
||
.<span class="ident">to_string</span>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.bound_impl" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1730-1737" title="goto source code">[src]</a></div><a href="#method.bound_impl" class="anchor"></a><h4 class="code-header">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></h4></div></summary><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-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-12" class="section-header"><a href="#example-12">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::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="op">=</span> <span class="string">"B"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">s</span>.<span class="ident">bound_impl</span>(<span class="macro">quote!</span>(<span class="ident">krate::Trait</span>), <span class="macro">quote!</span>{
|
||
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
||
}).<span class="ident">to_string</span>(),
|
||
<span class="macro">quote!</span>{
|
||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</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::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::Trait</span>,
|
||
<span class="ident">U</span>: <span class="ident">krate::Trait</span>
|
||
{
|
||
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
||
}
|
||
};
|
||
}.<span class="ident">to_string</span>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.unsafe_bound_impl" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1800-1807" title="goto source code">[src]</a></div><a href="#method.unsafe_bound_impl" class="anchor"></a><h4 class="code-header">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></h4></div></summary><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-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-13" class="section-header"><a href="#example-13">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::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="op">=</span> <span class="string">"B"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">s</span>.<span class="ident">unsafe_bound_impl</span>(<span class="macro">quote!</span>(<span class="ident">krate::Trait</span>), <span class="macro">quote!</span>{
|
||
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
||
}).<span class="ident">to_string</span>(),
|
||
<span class="macro">quote!</span>{
|
||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</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::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::Trait</span>,
|
||
<span class="ident">U</span>: <span class="ident">krate::Trait</span>
|
||
{
|
||
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
||
}
|
||
};
|
||
}.<span class="ident">to_string</span>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.unbound_impl" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1860-1867" title="goto source code">[src]</a></div><a href="#method.unbound_impl" class="anchor"></a><h4 class="code-header">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></h4></div></summary><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-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-14" class="section-header"><a href="#example-14">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::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="op">=</span> <span class="string">"B"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">s</span>.<span class="ident">unbound_impl</span>(<span class="macro">quote!</span>(<span class="ident">krate::Trait</span>), <span class="macro">quote!</span>{
|
||
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
||
}).<span class="ident">to_string</span>(),
|
||
<span class="macro">quote!</span>{
|
||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</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::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>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.unsafe_unbound_impl" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#1921-1928" title="goto source code">[src]</a></div><a href="#method.unsafe_unbound_impl" class="anchor"></a><h4 class="code-header">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></h4></div><div class="item-info"><div class="stab deprecated"><span class="emoji">👎</span> Deprecated</div></div></summary><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-5" class="section-header"><a href="#panics-5">Panics</a></h1>
|
||
<p>Panics if the path string parameter is not a valid <code>TraitBound</code>.</p>
|
||
<h1 id="example-15" class="section-header"><a href="#example-15">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::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="op">=</span> <span class="string">"B"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">s</span>.<span class="ident">unsafe_unbound_impl</span>(<span class="macro">quote!</span>(<span class="ident">krate::Trait</span>), <span class="macro">quote!</span>{
|
||
<span class="kw">fn</span> <span class="ident">a</span>() {}
|
||
}).<span class="ident">to_string</span>(),
|
||
<span class="macro">quote!</span>{
|
||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</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::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>()
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.gen_impl" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#2205-2211" title="goto source code">[src]</a></div><a href="#method.gen_impl" class="anchor"></a><h4 class="code-header">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></h4></div></summary><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'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore"><code><span class="ident">s</span>.<span class="ident">gen_impl</span>(<span class="macro">quote!</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::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>) { ... }
|
||
}
|
||
})</code></pre></div>
|
||
<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.</p>
|
||
<p>By default, the above invocation may generate an output like the
|
||
following:</p>
|
||
|
||
<div class='information'><div class='tooltip ignore'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore"><code><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::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>) { ... }
|
||
}
|
||
};</code></pre></div>
|
||
<p>The <code>Structure</code> may also be confired with the [<code>underscore_const</code>] method
|
||
to generate <code>const _</code> instead.</p>
|
||
|
||
<div class='information'><div class='tooltip ignore'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore"><code><span class="kw">const</span> <span class="kw">_</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::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>) { ... }
|
||
}
|
||
};</code></pre></div>
|
||
<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="errors" class="section-header"><a href="#errors">Errors</a></h1>
|
||
<p>This function will generate a <code>compile_error!</code> if additional type
|
||
parameters added by <code>impl<..></code> conflict with generic type parameters on
|
||
the original struct.</p>
|
||
<h1 id="panics-6" class="section-header"><a href="#panics-6">Panics</a></h1>
|
||
<p>This function will panic if the input <code>TokenStream</code> is not well-formed.</p>
|
||
<h1 id="example-usage" class="section-header"><a href="#example-usage">Example Usage</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">di</span>: <span class="ident">syn::DeriveInput</span> <span class="op">=</span> <span class="macro">syn::parse_quote!</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::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="op">=</span> <span class="string">"B"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">s</span>.<span class="ident">gen_impl</span>(<span class="macro">quote!</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::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="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::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::Trait</span>,
|
||
<span class="ident">U</span>: <span class="ident">krate::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="ident">s</span>.<span class="ident">gen_impl</span>(<span class="macro">quote!</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::OtherTrait</span><span class="op">></span> <span class="ident">krate::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="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::OtherTrait</span>, <span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> <span class="ident">krate::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::Trait</span><span class="op"><</span><span class="ident">X</span><span class="op">></span>,
|
||
<span class="ident">U</span>: <span class="ident">krate::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>()
|
||
);
|
||
|
||
<span class="comment">// NOTE: you can generate multiple traits with a single call</span>
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">s</span>.<span class="ident">gen_impl</span>(<span class="macro">quote!</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::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">gen</span> <span class="kw">impl</span> <span class="ident">krate::OtherTrait</span> <span class="kw">for</span> @<span class="self">Self</span> {
|
||
<span class="kw">fn</span> <span class="ident">b</span>() {}
|
||
}
|
||
}).<span class="ident">to_string</span>(),
|
||
<span class="macro">quote!</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::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::Trait</span>,
|
||
<span class="ident">U</span>: <span class="ident">krate::Trait</span>
|
||
{
|
||
<span class="kw">fn</span> <span class="ident">a</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::OtherTrait</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::OtherTrait</span>,
|
||
<span class="ident">U</span>: <span class="ident">krate::OtherTrait</span>
|
||
{
|
||
<span class="kw">fn</span> <span class="ident">b</span>() {}
|
||
}
|
||
};
|
||
}.<span class="ident">to_string</span>()
|
||
);</code></pre></div>
|
||
<p>Use <code>add_bounds</code> to change which bounds are generated.</p>
|
||
</div></details></div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Clone" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#938" title="goto source code">[src]</a></div><a href="#impl-Clone" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#938" title="goto source code">[src]</a></div><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.56.1/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></h4></div></summary><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.56.1/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone_from" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/clone.rs.html#130" title="goto source code">[src]</a></div><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.56.1/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/1.56.1/std/primitive.reference.html">&</a>Self)</h4></div></summary><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.56.1/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Debug" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#938" title="goto source code">[src]</a></div><a href="#impl-Debug" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fmt" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#938" title="goto source code">[src]</a></div><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.56.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.56.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.56.1/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></div></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.56.1/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Hash" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#938" title="goto source code">[src]</a></div><a href="#impl-Hash" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.hash" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#938" title="goto source code">[src]</a></div><a href="#method.hash" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.56.1/core/hash/trait.Hash.html#tymethod.hash" class="fnname">hash</a><__H: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>>(&self, state: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.reference.html">&mut </a>__H)</h4></div></summary><div class='docblock'><p>Feeds this value into the given <a href="https://doc.rust-lang.org/1.56.1/core/hash/trait.Hasher.html" title="Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.56.1/core/hash/trait.Hash.html#tymethod.hash">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.hash_slice" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.3.0">1.3.0</span><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/hash/mod.rs.html#211-213" title="goto source code">[src]</a></div><a href="#method.hash_slice" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.56.1/core/hash/trait.Hash.html#method.hash_slice" class="fnname">hash_slice</a><H>(data: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.slice.html">&[Self]</a>, state: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.reference.html">&mut </a>H) <span class="where fmt-newline">where<br> H: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>, </span></h4></div></summary><div class='docblock'><p>Feeds a slice of this type into the given <a href="https://doc.rust-lang.org/1.56.1/core/hash/trait.Hasher.html" title="Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.56.1/core/hash/trait.Hash.html#method.hash_slice">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialEq%3CStructure%3C%27a%3E%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#938" title="goto source code">[src]</a></div><a href="#impl-PartialEq%3CStructure%3C%27a%3E%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a>> for <a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.eq" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#938" title="goto source code">[src]</a></div><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.56.1/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a></h4></div></summary><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/1.56.1/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ne" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#938" title="goto source code">[src]</a></div><a href="#method.ne" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.56.1/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: &<a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
||
</div></details></div></details><div id="impl-Eq" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#938" title="goto source code">[src]</a></div><a href="#impl-Eq" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></h3></div><div id="impl-StructuralEq" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#938" title="goto source code">[src]</a></div><a href="#impl-StructuralEq" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.StructuralEq.html" title="trait core::marker::StructuralEq">StructuralEq</a> for <a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></h3></div><div id="impl-StructuralPartialEq" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/synstructure/lib.rs.html#938" title="goto source code">[src]</a></div><a href="#impl-StructuralPartialEq" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></h3></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><div id="impl-RefUnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-RefUnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></h3></div><div id="impl-Send" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Send" class="anchor"></a><h3 class="code-header in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></h3></div><div id="impl-Sync" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Sync" class="anchor"></a><h3 class="code-header in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></h3></div><div id="impl-Unpin" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Unpin" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></h3></div><div id="impl-UnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-UnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Structure.html" title="struct synstructure::Structure">Structure</a><'a></h3></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Any" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/any.rs.html#132-136" title="goto source code">[src]</a></div><a href="#impl-Any" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.type_id" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/any.rs.html#133" title="goto source code">[src]</a></div><a href="#method.type_id" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.56.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></div></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.56.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Borrow%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/borrow.rs.html#208-213" title="goto source code">[src]</a></div><a href="#impl-Borrow%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/borrow.rs.html#210" title="goto source code">[src]</a></div><a href="#method.borrow" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.reference.html">&</a>T</h4></div></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.56.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/borrow.rs.html#216-220" title="goto source code">[src]</a></div><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow_mut" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/borrow.rs.html#217" title="goto source code">[src]</a></div><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.reference.html">&mut </a>T</h4></div></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.56.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#546-550" title="goto source code">[src]</a></div><a href="#impl-From%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#547" title="goto source code">[src]</a></div><a href="#method.from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Into%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#535-542" title="goto source code">[src]</a></div><a href="#impl-Into%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#539" title="goto source code">[src]</a></div><a href="#method.into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-ToOwned" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/alloc/borrow.rs.html#84-96" title="goto source code">[src]</a></div><a href="#impl-ToOwned" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.56.1/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Owned" class="type trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.56.1/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="type">Owned</a> = T</h4></div></summary><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.to_owned" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/alloc/borrow.rs.html#89" title="goto source code">[src]</a></div><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</h4></div></summary><div class='docblock'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.56.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone_into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/alloc/borrow.rs.html#93" title="goto source code">[src]</a></div><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.reference.html">&mut </a>T)</h4></div></summary><div class="item-info"><div class="stab unstable"><details><summary><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
||
</details></div></div><div class='docblock'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.56.1/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#583-592" title="goto source code">[src]</a></div><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="type trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.56.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#589" title="goto source code">[src]</a></div><a href="#method.try_from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.56.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryInto%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#569-578" title="goto source code">[src]</a></div><a href="#impl-TryInto%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-1" class="type trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#575" title="goto source code">[src]</a></div><a href="#method.try_into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.56.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="synstructure" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
|
||
<script src="../main.js"></script>
|
||
</body></html> |