Files
tantivy/master/syn/struct.Generics.html
2018-03-25 03:58:45 +00:00

249 lines
24 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `Generics` struct in crate `syn`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Generics">
<title>syn::Generics - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css"
id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../dark.css">
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
<script src="../storage.js"></script>
</head>
<body class="rustdoc struct">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<p class='location'>Struct Generics</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.lt_token">lt_token</a><a href="#structfield.params">params</a><a href="#structfield.gt_token">gt_token</a><a href="#structfield.where_clause">where_clause</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.type_params">type_params</a><a href="#method.type_params_mut">type_params_mut</a><a href="#method.lifetimes">lifetimes</a><a href="#method.lifetimes_mut">lifetimes_mut</a><a href="#method.const_params">const_params</a><a href="#method.const_params_mut">const_params_mut</a><a href="#method.split_for_impl">split_for_impl</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Synom">Synom</a><a href="#impl-ToTokens">ToTokens</a><a href="#impl-Default">Default</a><a href="#impl-Clone">Clone</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='index.html'>syn</a></p><script>window.sidebarCurrent = {name: 'Generics', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>syn</a>::<wbr><a class="struct" href=''>Generics</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/syn/macros.rs.html#47' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Generics {
pub lt_token: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../syn/token/struct.Lt.html" title="struct syn::token::Lt">Lt</a>&gt;,
pub params: <a class="struct" href="../syn/punctuated/struct.Punctuated.html" title="struct syn::punctuated::Punctuated">Punctuated</a>&lt;<a class="enum" href="../syn/enum.GenericParam.html" title="enum syn::GenericParam">GenericParam</a>, <a class="struct" href="../syn/token/struct.Comma.html" title="struct syn::token::Comma">Comma</a>&gt;,
pub gt_token: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../syn/token/struct.Gt.html" title="struct syn::token::Gt">Gt</a>&gt;,
pub where_clause: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../syn/struct.WhereClause.html" title="struct syn::WhereClause">WhereClause</a>&gt;,
}</pre><div class='docblock'><p>Lifetimes and type parameters attached to a declaration of a function,
enum, trait, etc.</p>
<p><em>This type is available if Syn is built with the <code>&quot;derive&quot;</code> or <code>&quot;full&quot;</code>
feature.</em></p>
</div><h2 id='fields' class='fields small-section-header'>
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.lt_token" class="structfield small-section-header">
<a href="#structfield.lt_token" class="anchor field"></a>
<span id="lt_token.v" class='invisible'>
<code>lt_token: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../syn/token/struct.Lt.html" title="struct syn::token::Lt">Lt</a>&gt;</code>
</span></span><span id="structfield.params" class="structfield small-section-header">
<a href="#structfield.params" class="anchor field"></a>
<span id="params.v" class='invisible'>
<code>params: <a class="struct" href="../syn/punctuated/struct.Punctuated.html" title="struct syn::punctuated::Punctuated">Punctuated</a>&lt;<a class="enum" href="../syn/enum.GenericParam.html" title="enum syn::GenericParam">GenericParam</a>, <a class="struct" href="../syn/token/struct.Comma.html" title="struct syn::token::Comma">Comma</a>&gt;</code>
</span></span><span id="structfield.gt_token" class="structfield small-section-header">
<a href="#structfield.gt_token" class="anchor field"></a>
<span id="gt_token.v" class='invisible'>
<code>gt_token: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../syn/token/struct.Gt.html" title="struct syn::token::Gt">Gt</a>&gt;</code>
</span></span><span id="structfield.where_clause" class="structfield small-section-header">
<a href="#structfield.where_clause" class="anchor field"></a>
<span id="where_clause.v" class='invisible'>
<code>where_clause: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../syn/struct.WhereClause.html" title="struct syn::WhereClause">WhereClause</a>&gt;</code>
</span></span>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../syn/struct.Generics.html" title="struct syn::Generics">Generics</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#80-146' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.type_params' class="method"><span id='type_params.v' class='invisible'><code>pub fn <a href='#method.type_params' class='fnname'>type_params</a>(&amp;self) -&gt; TypeParams</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#88-90' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns an
<code
style="padding-right:0;">Iterator&lt;Item = &amp;</code><a
href="struct.TypeParam.html"><code
style="padding-left:0;padding-right:0;">TypeParam</code></a><code
style="padding-left:0;">&gt;</code>
over the type parameters in <code>self.params</code>.</p>
</div><h4 id='method.type_params_mut' class="method"><span id='type_params_mut.v' class='invisible'><code>pub fn <a href='#method.type_params_mut' class='fnname'>type_params_mut</a>(&amp;mut self) -&gt; TypeParamsMut</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#99-101' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns an
<code
style="padding-right:0;">Iterator&lt;Item = &amp;mut </code><a
href="struct.TypeParam.html"><code
style="padding-left:0;padding-right:0;">TypeParam</code></a><code
style="padding-left:0;">&gt;</code>
over the type parameters in <code>self.params</code>.</p>
</div><h4 id='method.lifetimes' class="method"><span id='lifetimes.v' class='invisible'><code>pub fn <a href='#method.lifetimes' class='fnname'>lifetimes</a>(&amp;self) -&gt; Lifetimes</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#110-112' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns an
<code
style="padding-right:0;">Iterator&lt;Item = &amp;</code><a
href="struct.LifetimeDef.html"><code
style="padding-left:0;padding-right:0;">LifetimeDef</code></a><code
style="padding-left:0;">&gt;</code>
over the lifetime parameters in <code>self.params</code>.</p>
</div><h4 id='method.lifetimes_mut' class="method"><span id='lifetimes_mut.v' class='invisible'><code>pub fn <a href='#method.lifetimes_mut' class='fnname'>lifetimes_mut</a>(&amp;mut self) -&gt; LifetimesMut</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#121-123' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns an
<code
style="padding-right:0;">Iterator&lt;Item = &amp;mut </code><a
href="struct.LifetimeDef.html"><code
style="padding-left:0;padding-right:0;">LifetimeDef</code></a><code
style="padding-left:0;">&gt;</code>
over the lifetime parameters in <code>self.params</code>.</p>
</div><h4 id='method.const_params' class="method"><span id='const_params.v' class='invisible'><code>pub fn <a href='#method.const_params' class='fnname'>const_params</a>(&amp;self) -&gt; ConstParams</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#132-134' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns an
<code
style="padding-right:0;">Iterator&lt;Item = &amp;</code><a
href="struct.ConstParam.html"><code
style="padding-left:0;padding-right:0;">ConstParam</code></a><code
style="padding-left:0;">&gt;</code>
over the constant parameters in <code>self.params</code>.</p>
</div><h4 id='method.const_params_mut' class="method"><span id='const_params_mut.v' class='invisible'><code>pub fn <a href='#method.const_params_mut' class='fnname'>const_params_mut</a>(&amp;mut self) -&gt; ConstParamsMut</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#143-145' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns an
<code
style="padding-right:0;">Iterator&lt;Item = &amp;mut </code><a
href="struct.ConstParam.html"><code
style="padding-left:0;padding-right:0;">ConstParam</code></a><code
style="padding-left:0;">&gt;</code>
over the constant parameters in <code>self.params</code>.</p>
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><code>impl <a class="struct" href="../syn/struct.Generics.html" title="struct syn::Generics">Generics</a></code><a href='#impl-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#290-320' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.split_for_impl' class="method"><span id='split_for_impl.v' class='invisible'><code>pub fn <a href='#method.split_for_impl' class='fnname'>split_for_impl</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self<br>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../syn/struct.ImplGenerics.html" title="struct syn::ImplGenerics">ImplGenerics</a>, <a class="struct" href="../syn/struct.TypeGenerics.html" title="struct syn::TypeGenerics">TypeGenerics</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../syn/struct.WhereClause.html" title="struct syn::WhereClause">WhereClause</a>&gt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#313-319' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Split a type's generics into the pieces required for impl'ing a trait
for that type.</p>
<pre class="rust rust-example-rendered">
<span class="kw">let</span> (<span class="ident">impl_generics</span>, <span class="ident">ty_generics</span>, <span class="ident">where_clause</span>) <span class="op">=</span> <span class="ident">generics</span>.<span class="ident">split_for_impl</span>();
<span class="macro">quote</span><span class="macro">!</span> {
<span class="kw">impl</span> #<span class="ident">impl_generics</span> <span class="ident">MyTrait</span> <span class="kw">for</span> #<span class="ident">name</span> #<span class="ident">ty_generics</span> #<span class="ident">where_clause</span> {
<span class="comment">// ...</span>
}
}</pre>
<p><em>This method is available if Syn is built with the <code>&quot;derive&quot;</code> or
<code>&quot;full&quot;</code> feature and the <code>&quot;printing&quot;</code> feature.</em></p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'>
<h3 id='impl-Synom' class='impl'><span class='in-band'><code>impl <a class="trait" href="../syn/synom/trait.Synom.html" title="trait syn::synom::Synom">Synom</a> for <a class="struct" href="../syn/struct.Generics.html" title="struct syn::Generics">Generics</a></code><a href='#impl-Synom' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#476-510' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.parse' class="method"><span id='parse.v' class='invisible'><code>fn <a href='../syn/synom/trait.Synom.html#tymethod.parse' class='fnname'>parse</a>(i: <a class="struct" href="../syn/buffer/struct.Cursor.html" title="struct syn::buffer::Cursor">Cursor</a>) -&gt; <a class="type" href="../syn/synom/type.PResult.html" title="type syn::synom::PResult">PResult</a>&lt;Self&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/parsers.rs.html#68-70' title='goto source code'>[src]</a></span></h4>
<h4 id='method.description' class="method"><span id='description.v' class='invisible'><code>fn <a href='../syn/synom/trait.Synom.html#method.description' class='fnname'>description</a>() -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#507-509' title='goto source code'>[src]</a></span></h4>
</div><h3 id='impl-ToTokens' class='impl'><span class='in-band'><code>impl <a class="trait" href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">ToTokens</a> for <a class="struct" href="../syn/struct.Generics.html" title="struct syn::Generics">Generics</a></code><a href='#impl-ToTokens' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#736-771' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.to_tokens' class="method"><span id='to_tokens.v' class='invisible'><code>fn <a href='../quote/to_tokens/trait.ToTokens.html#tymethod.to_tokens' class='fnname'>to_tokens</a>(&amp;self, tokens: &amp;mut <a class="struct" href="../quote/tokens/struct.Tokens.html" title="struct quote::tokens::Tokens">Tokens</a>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#737-770' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Write <code>self</code> to the given <code>Tokens</code>. <a href="../quote/to_tokens/trait.ToTokens.html#tymethod.to_tokens">Read more</a></p>
</div><h4 id='method.into_tokens' class="method"><span id='into_tokens.v' class='invisible'><code>fn <a href='../quote/to_tokens/trait.ToTokens.html#method.into_tokens' class='fnname'>into_tokens</a>(self) -&gt; <a class="struct" href="../quote/tokens/struct.Tokens.html" title="struct quote::tokens::Tokens">Tokens</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/quote/to_tokens.rs.html#70-77' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Convert <code>self</code> directly into a <code>Tokens</code> object. <a href="../quote/to_tokens/trait.ToTokens.html#method.into_tokens">Read more</a></p>
</div></div><h3 id='impl-Default' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../syn/struct.Generics.html" title="struct syn::Generics">Generics</a></code><a href='#impl-Default' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#18' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class="struct" href="../syn/struct.Generics.html" title="struct syn::Generics">Generics</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/generics.rs.html#18' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the &quot;default value&quot; for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../syn/struct.Generics.html" title="struct syn::Generics">Generics</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/macros.rs.html#46' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../syn/struct.Generics.html" title="struct syn::Generics">Generics</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/macros.rs.html#46' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#117-119' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div></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'>
<h3 id='impl-Send' class='impl'><span class='in-band'><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../syn/struct.Generics.html" title="struct syn::Generics">Generics</a></code><a href='#impl-Send' class='anchor'></a></span><span class='out-of-band'></span></h3>
<div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../syn/struct.Generics.html" title="struct syn::Generics">Generics</a></code><a href='#impl-Sync' class='anchor'></a></span><span class='out-of-band'></span></h3>
<div class='impl-items'></div></div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "syn";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>