pnmixer-rust/syn/enum.Ty.html

169 lines
20 KiB
HTML
Raw Permalink 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 `Ty` enum in crate `syn`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Ty">
<title>syn::Ty - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</head>
<body class="rustdoc enum">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'>Enum Ty</p><div class="block items"><ul><li><a href="#variants">Variants</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='index.html'>syn</a></p><script>window.sidebarCurrent = {name: 'Ty', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<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'>Enum <a href='index.html'>syn</a>::<wbr><a class="enum" href=''>Ty</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/ty.rs.html#5-38' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum Ty {
Slice(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a>&gt;),
Array(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a>&gt;,&nbsp;<a class="enum" href="../syn/enum.ConstExpr.html" title="enum syn::ConstExpr">ConstExpr</a>),
Ptr(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="struct" href="../syn/struct.MutTy.html" title="struct syn::MutTy">MutTy</a>&gt;),
Rptr(<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.Lifetime.html" title="struct syn::Lifetime">Lifetime</a>&gt;,&nbsp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="struct" href="../syn/struct.MutTy.html" title="struct syn::MutTy">MutTy</a>&gt;),
BareFn(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="struct" href="../syn/struct.BareFnTy.html" title="struct syn::BareFnTy">BareFnTy</a>&gt;),
Never,
Tup(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a>&gt;),
Path(<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.QSelf.html" title="struct syn::QSelf">QSelf</a>&gt;,&nbsp;<a class="struct" href="../syn/struct.Path.html" title="struct syn::Path">Path</a>),
TraitObject(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../syn/enum.TyParamBound.html" title="enum syn::TyParamBound">TyParamBound</a>&gt;),
ImplTrait(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../syn/enum.TyParamBound.html" title="enum syn::TyParamBound">TyParamBound</a>&gt;),
Paren(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a>&gt;),
Infer,
Mac(<a class="struct" href="../syn/struct.Mac.html" title="struct syn::Mac">Mac</a>),
}</pre><div class='docblock'><p>The different kinds of types recognized by the compiler</p>
</div><h2 id='variants' class='variants'>Variants</h2>
<span id='variant.Slice' class='variant'><span id='Slice.v' class='invisible'><code>Slice(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a>&gt;)</code></span></span><div class='docblock'><p>A variable-length array (<code>[T]</code>)</p>
</div><span id='variant.Array' class='variant'><span id='Array.v' class='invisible'><code>Array(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a>&gt;,&nbsp;<a class="enum" href="../syn/enum.ConstExpr.html" title="enum syn::ConstExpr">ConstExpr</a>)</code></span></span><div class='docblock'><p>A fixed length array (<code>[T; n]</code>)</p>
</div><span id='variant.Ptr' class='variant'><span id='Ptr.v' class='invisible'><code>Ptr(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="struct" href="../syn/struct.MutTy.html" title="struct syn::MutTy">MutTy</a>&gt;)</code></span></span><div class='docblock'><p>A raw pointer (<code>*const T</code> or <code>*mut T</code>)</p>
</div><span id='variant.Rptr' class='variant'><span id='Rptr.v' class='invisible'><code>Rptr(<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.Lifetime.html" title="struct syn::Lifetime">Lifetime</a>&gt;,&nbsp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="struct" href="../syn/struct.MutTy.html" title="struct syn::MutTy">MutTy</a>&gt;)</code></span></span><div class='docblock'><p>A reference (<code>&amp;&#39;a T</code> or <code>&amp;&#39;a mut T</code>)</p>
</div><span id='variant.BareFn' class='variant'><span id='BareFn.v' class='invisible'><code>BareFn(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="struct" href="../syn/struct.BareFnTy.html" title="struct syn::BareFnTy">BareFnTy</a>&gt;)</code></span></span><div class='docblock'><p>A bare function (e.g. <code>fn(usize) -&gt; bool</code>)</p>
</div><span id='variant.Never' class='variant'><span id='Never.v' class='invisible'><code>Never</code></span></span><div class='docblock'><p>The never type (<code>!</code>)</p>
</div><span id='variant.Tup' class='variant'><span id='Tup.v' class='invisible'><code>Tup(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a>&gt;)</code></span></span><div class='docblock'><p>A tuple (<code>(A, B, C, D, ...)</code>)</p>
</div><span id='variant.Path' class='variant'><span id='Path.v' class='invisible'><code>Path(<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.QSelf.html" title="struct syn::QSelf">QSelf</a>&gt;,&nbsp;<a class="struct" href="../syn/struct.Path.html" title="struct syn::Path">Path</a>)</code></span></span><div class='docblock'><p>A path (<code>module::module::...::Type</code>), optionally
&quot;qualified&quot;, e.g. <code>&lt;Vec&lt;T&gt; as SomeTrait&gt;::SomeType</code>.</p>
<p>Type parameters are stored in the Path itself</p>
</div><span id='variant.TraitObject' class='variant'><span id='TraitObject.v' class='invisible'><code>TraitObject(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../syn/enum.TyParamBound.html" title="enum syn::TyParamBound">TyParamBound</a>&gt;)</code></span></span><div class='docblock'><p>A trait object type <code>Bound1 + Bound2 + Bound3</code>
where <code>Bound</code> is a trait or a lifetime.</p>
</div><span id='variant.ImplTrait' class='variant'><span id='ImplTrait.v' class='invisible'><code>ImplTrait(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../syn/enum.TyParamBound.html" title="enum syn::TyParamBound">TyParamBound</a>&gt;)</code></span></span><div class='docblock'><p>An <code>impl Bound1 + Bound2 + Bound3</code> type
where <code>Bound</code> is a trait or a lifetime.</p>
</div><span id='variant.Paren' class='variant'><span id='Paren.v' class='invisible'><code>Paren(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a>&gt;)</code></span></span><div class='docblock'><p>No-op; kept solely so that we can pretty-print faithfully</p>
</div><span id='variant.Infer' class='variant'><span id='Infer.v' class='invisible'><code>Infer</code></span></span><div class='docblock'><p>TyKind::Infer means the type should be inferred instead of it having been
specified. This can appear anywhere in a type.</p>
</div><span id='variant.Mac' class='variant'><span id='Mac.v' class='invisible'><code>Mac(<a class="struct" href="../syn/struct.Mac.html" title="struct syn::Mac">Mac</a>)</code></span></span><div class='docblock'><p>A macro in the type position.</p>
</div><h2 id='implementations'>Trait Implementations</h2><h3 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="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/ty.rs.html#586-671' 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></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></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/ty.rs.html#4' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 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="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/ty.rs.html#4' 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="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a></code></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: &amp;Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/ty.rs.html#4' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/ty.rs.html#4' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4>
<div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4>
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="enum" href="../syn/enum.Ty.html" title="enum syn::Ty">Ty</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/syn/ty.rs.html#4' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.hash' class="method"><span id='hash.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash' class='fnname'>hash</a>&lt;__H:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>&gt;(&amp;self, __arg_0: &amp;mut __H)</code></span></h4>
<div class='docblock'><p>Feeds this value into the given [<code>Hasher</code>]. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash">Read more</a></p>
</div><h4 id='method.hash_slice' class="method"><span id='hash_slice.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice' class='fnname'>hash_slice</a>&lt;H&gt;(data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[Self]</a>, state: &amp;mut H) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>,&nbsp;</span></code><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div></span></h4>
<div class='docblock'><p>Feeds a slice of this type into the given [<code>Hasher</code>]. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice">Read more</a></p>
</div></div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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>