mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-29 15:04:32 +01:00
203 lines
66 KiB
HTML
203 lines
66 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="github crates-io docs-rs"><title>syn - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="syn" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../syn/index.html">syn</a><span class="version">1.0.109</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Aliases</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">syn</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/syn/lib.rs.html#1-984">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><a href="https://github.com/dtolnay/syn"><img src="https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github" alt="github" /></a> <a href="https://crates.io/crates/syn"><img src="https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust" alt="crates-io" /></a> <a href="index.html" title="mod syn"><img src="https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" alt="docs-rs" /></a></p>
|
|||
|
|
<br>
|
|||
|
|
<p>Syn is a parsing library for parsing a stream of Rust tokens into a syntax
|
|||
|
|
tree of Rust source code.</p>
|
|||
|
|
<p>Currently this library is geared toward use in Rust procedural macros, but
|
|||
|
|
contains some APIs that may be useful more generally.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>
|
|||
|
|
<p><strong>Data structures</strong> — Syn provides a complete syntax tree that can
|
|||
|
|
represent any valid Rust source code. The syntax tree is rooted at
|
|||
|
|
<a href="struct.File.html" title="struct syn::File"><code>syn::File</code></a> which represents a full source file, but there are other
|
|||
|
|
entry points that may be useful to procedural macros including
|
|||
|
|
<a href="enum.Item.html" title="enum syn::Item"><code>syn::Item</code></a>, <a href="enum.Expr.html" title="enum syn::Expr"><code>syn::Expr</code></a> and <a href="enum.Type.html" title="enum syn::Type"><code>syn::Type</code></a>.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p><strong>Derives</strong> — Of particular interest to derive macros is
|
|||
|
|
<a href="struct.DeriveInput.html" title="struct syn::DeriveInput"><code>syn::DeriveInput</code></a> which is any of the three legal input items to a
|
|||
|
|
derive macro. An example below shows using this type in a library that can
|
|||
|
|
derive implementations of a user-defined trait.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p><strong>Parsing</strong> — Parsing in Syn is built around <a href="parse/index.html" title="mod syn::parse">parser functions</a> with the
|
|||
|
|
signature <code>fn(ParseStream) -> Result<T></code>. Every syntax tree node defined
|
|||
|
|
by Syn is individually parsable and may be used as a building block for
|
|||
|
|
custom syntaxes, or you may dream up your own brand new syntax without
|
|||
|
|
involving any of our syntax tree types.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p><strong>Location information</strong> — Every token parsed by Syn is associated with a
|
|||
|
|
<code>Span</code> that tracks line and column information back to the source of that
|
|||
|
|
token. These spans allow a procedural macro to display detailed error
|
|||
|
|
messages pointing to all the right places in the user’s code. There is an
|
|||
|
|
example of this below.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p><strong>Feature flags</strong> — Functionality is aggressively feature gated so your
|
|||
|
|
procedural macros enable only what they need, and do not pay in compile
|
|||
|
|
time for all the rest.</p>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<br>
|
|||
|
|
<h2 id="example-of-a-derive-macro"><a class="doc-anchor" href="#example-of-a-derive-macro">§</a>Example of a derive macro</h2>
|
|||
|
|
<p>The canonical derive macro using Syn looks like this. We write an ordinary
|
|||
|
|
Rust function tagged with a <code>proc_macro_derive</code> attribute and the name of
|
|||
|
|
the trait we are deriving. Any time that derive appears in the user’s code,
|
|||
|
|
the Rust compiler passes their data structure as tokens into our macro. We
|
|||
|
|
get to execute arbitrary Rust code to figure out what to do with those
|
|||
|
|
tokens, then hand some tokens back to the compiler to compile into the
|
|||
|
|
user’s crate.</p>
|
|||
|
|
<div class="example-wrap"><pre class="language-toml"><code>[dependencies]
|
|||
|
|
syn = "1.0"
|
|||
|
|
quote = "1.0"
|
|||
|
|
|
|||
|
|
[lib]
|
|||
|
|
proc-macro = true
|
|||
|
|
</code></pre></div>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>proc_macro::TokenStream;
|
|||
|
|
<span class="kw">use </span>quote::quote;
|
|||
|
|
<span class="kw">use </span>syn::{parse_macro_input, DeriveInput};
|
|||
|
|
|
|||
|
|
<span class="attr">#[proc_macro_derive(MyMacro)]
|
|||
|
|
</span><span class="kw">pub fn </span>my_macro(input: TokenStream) -> TokenStream {
|
|||
|
|
<span class="comment">// Parse the input tokens into a syntax tree
|
|||
|
|
</span><span class="kw">let </span>input = <span class="macro">parse_macro_input!</span>(input <span class="kw">as </span>DeriveInput);
|
|||
|
|
|
|||
|
|
<span class="comment">// Build the output, possibly using quasi-quotation
|
|||
|
|
</span><span class="kw">let </span>expanded = <span class="macro">quote!</span> {
|
|||
|
|
<span class="comment">// ...
|
|||
|
|
</span>};
|
|||
|
|
|
|||
|
|
<span class="comment">// Hand the output tokens back to the compiler
|
|||
|
|
</span>TokenStream::from(expanded)
|
|||
|
|
}</code></pre></div>
|
|||
|
|
<p>The <a href="https://github.com/dtolnay/syn/tree/master/examples/heapsize"><code>heapsize</code></a> example directory shows a complete working implementation
|
|||
|
|
of a derive macro. It works on any Rust compiler 1.31+. The example derives
|
|||
|
|
a <code>HeapSize</code> trait which computes an estimate of the amount of heap memory
|
|||
|
|
owned by a value.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">pub trait </span>HeapSize {
|
|||
|
|
<span class="doccomment">/// Total number of bytes of heap memory owned by `self`.
|
|||
|
|
</span><span class="kw">fn </span>heap_size_of_children(<span class="kw-2">&</span><span class="self">self</span>) -> usize;
|
|||
|
|
}</code></pre></div>
|
|||
|
|
<p>The derive macro allows users to write <code>#[derive(HeapSize)]</code> on data
|
|||
|
|
structures in their program.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#[derive(HeapSize)]
|
|||
|
|
</span><span class="kw">struct </span>Demo<<span class="lifetime">'a</span>, T: <span class="question-mark">?</span>Sized> {
|
|||
|
|
a: Box<T>,
|
|||
|
|
b: u8,
|
|||
|
|
c: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
|||
|
|
d: String,
|
|||
|
|
}</code></pre></div>
|
|||
|
|
<p><br></p>
|
|||
|
|
<h2 id="spans-and-error-reporting"><a class="doc-anchor" href="#spans-and-error-reporting">§</a>Spans and error reporting</h2>
|
|||
|
|
<p>The token-based procedural macro API provides great control over where the
|
|||
|
|
compiler’s error messages are displayed in user code. Consider the error the
|
|||
|
|
user sees if one of their field types does not implement <code>HeapSize</code>.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#[derive(HeapSize)]
|
|||
|
|
</span><span class="kw">struct </span>Broken {
|
|||
|
|
ok: String,
|
|||
|
|
bad: std::thread::Thread,
|
|||
|
|
}</code></pre></div>
|
|||
|
|
<p>By tracking span information all the way through the expansion of a
|
|||
|
|
procedural macro as shown in the <code>heapsize</code> example, token-based macros in
|
|||
|
|
Syn are able to trigger errors that directly pinpoint the source of the
|
|||
|
|
problem.</p>
|
|||
|
|
<div class="example-wrap"><pre class="language-text"><code>error[E0277]: the trait bound `std::thread::Thread: HeapSize` is not satisfied
|
|||
|
|
--> src/main.rs:7:5
|
|||
|
|
|
|
|||
|
|
7 | bad: std::thread::Thread,
|
|||
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^ the trait `HeapSize` is not implemented for `Thread`
|
|||
|
|
</code></pre></div><br>
|
|||
|
|
<h2 id="parsing-a-custom-syntax"><a class="doc-anchor" href="#parsing-a-custom-syntax">§</a>Parsing a custom syntax</h2>
|
|||
|
|
<p>The <a href="https://github.com/dtolnay/syn/tree/master/examples/lazy-static"><code>lazy-static</code></a> example directory shows the implementation of a
|
|||
|
|
<code>functionlike!(...)</code> procedural macro in which the input tokens are parsed
|
|||
|
|
using Syn’s parsing API.</p>
|
|||
|
|
<p>The example reimplements the popular <code>lazy_static</code> crate from crates.io as a
|
|||
|
|
procedural macro.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">lazy_static!</span> {
|
|||
|
|
<span class="kw">static </span><span class="kw-2">ref </span>USERNAME: Regex = Regex::new(<span class="string">"^[a-z0-9_-]{3,16}$"</span>).unwrap();
|
|||
|
|
}</code></pre></div>
|
|||
|
|
<p>The implementation shows how to trigger custom warnings and error messages
|
|||
|
|
on the macro input.</p>
|
|||
|
|
<div class="example-wrap"><pre class="language-text"><code>warning: come on, pick a more creative name
|
|||
|
|
--> src/main.rs:10:16
|
|||
|
|
|
|
|||
|
|
10 | static ref FOO: String = "lazy_static".to_owned();
|
|||
|
|
| ^^^
|
|||
|
|
</code></pre></div><br>
|
|||
|
|
<h2 id="testing"><a class="doc-anchor" href="#testing">§</a>Testing</h2>
|
|||
|
|
<p>When testing macros, we often care not just that the macro can be used
|
|||
|
|
successfully but also that when the macro is provided with invalid input it
|
|||
|
|
produces maximally helpful error messages. Consider using the <a href="https://github.com/dtolnay/trybuild"><code>trybuild</code></a>
|
|||
|
|
crate to write tests for errors that are emitted by your macro or errors
|
|||
|
|
detected by the Rust compiler in the expanded code following misuse of the
|
|||
|
|
macro. Such tests help avoid regressions from later refactors that
|
|||
|
|
mistakenly make an error no longer trigger or be less helpful than it used
|
|||
|
|
to be.</p>
|
|||
|
|
<br>
|
|||
|
|
<h2 id="debugging"><a class="doc-anchor" href="#debugging">§</a>Debugging</h2>
|
|||
|
|
<p>When developing a procedural macro it can be helpful to look at what the
|
|||
|
|
generated code looks like. Use <code>cargo rustc -- -Zunstable-options --pretty=expanded</code> or the <a href="https://github.com/dtolnay/cargo-expand"><code>cargo expand</code></a> subcommand.</p>
|
|||
|
|
<p>To show the expanded code for some crate that uses your procedural macro,
|
|||
|
|
run <code>cargo expand</code> from that crate. To show the expanded code for one of
|
|||
|
|
your own test cases, run <code>cargo expand --test the_test_case</code> where the last
|
|||
|
|
argument is the name of the test file without the <code>.rs</code> extension.</p>
|
|||
|
|
<p>This write-up by Brandon W Maister discusses debugging in more detail:
|
|||
|
|
<a href="https://quodlibetor.github.io/posts/debugging-rusts-new-custom-derive-system/">Debugging Rust’s new Custom Derive system</a>.</p>
|
|||
|
|
<br>
|
|||
|
|
<h2 id="optional-features"><a class="doc-anchor" href="#optional-features">§</a>Optional features</h2>
|
|||
|
|
<p>Syn puts a lot of functionality behind optional features in order to
|
|||
|
|
optimize compile time for the most common use cases. The following features
|
|||
|
|
are available.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><strong><code>derive</code></strong> <em>(enabled by default)</em> — Data structures for representing the
|
|||
|
|
possible input to a derive macro, including structs and enums and types.</li>
|
|||
|
|
<li><strong><code>full</code></strong> — Data structures for representing the syntax tree of all valid
|
|||
|
|
Rust source code, including items and expressions.</li>
|
|||
|
|
<li><strong><code>parsing</code></strong> <em>(enabled by default)</em> — Ability to parse input tokens into
|
|||
|
|
a syntax tree node of a chosen type.</li>
|
|||
|
|
<li><strong><code>printing</code></strong> <em>(enabled by default)</em> — Ability to print a syntax tree
|
|||
|
|
node as tokens of Rust source code.</li>
|
|||
|
|
<li><strong><code>visit</code></strong> — Trait for traversing a syntax tree.</li>
|
|||
|
|
<li><strong><code>visit-mut</code></strong> — Trait for traversing and mutating in place a syntax
|
|||
|
|
tree.</li>
|
|||
|
|
<li><strong><code>fold</code></strong> — Trait for transforming an owned syntax tree.</li>
|
|||
|
|
<li><strong><code>clone-impls</code></strong> <em>(enabled by default)</em> — Clone impls for all syntax tree
|
|||
|
|
types.</li>
|
|||
|
|
<li><strong><code>extra-traits</code></strong> — Debug, Eq, PartialEq, Hash impls for all syntax tree
|
|||
|
|
types.</li>
|
|||
|
|
<li><strong><code>proc-macro</code></strong> <em>(enabled by default)</em> — Runtime dependency on the
|
|||
|
|
dynamic library libproc_macro from rustc toolchain.</li>
|
|||
|
|
</ul>
|
|||
|
|
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.Ident"><code>pub use crate::ident::Ident;</code></div></li><li><div class="item-name" id="reexport.Lifetime"><code>pub use crate::lifetime::<a class="struct" href="struct.Lifetime.html" title="struct syn::Lifetime">Lifetime</a>;</code></div></li><li><div class="item-name" id="reexport.Lifetime-1"><code>pub use crate::lifetime::Lifetime;</code></div></li><li><div class="item-name" id="reexport.Lit"><code>pub use crate::lit::<a class="enum" href="enum.Lit.html" title="enum syn::Lit">Lit</a>;</code></div></li><li><div class="item-name" id="reexport.Lit-1"><code>pub use crate::lit::Lit;</code></div></li><li><div class="item-name" id="reexport.LitBool"><code>pub use crate::lit::<a class="struct" href="struct.LitBool.html" title="struct syn::LitBool">LitBool</a>;</code></div></li><li><div class="item-name" id="reexport.LitBool-1"><code>pub use crate::lit::LitBool;</code></div></li><li><div class="item-name" id="reexport.LitByte"><code>pub use crate::lit::<a class="struct" href="struct.LitByte.html" title="struct syn::LitByte">LitByte</a>;</code></div></li><li><div class="item-name" id="reexport.LitByte-1"><code>pub use crate::lit::LitByte;</code></div></li><li><div class="item-name" id="reexport.LitByteStr"><code>pub use crate::lit::<a class="struct" href="struct.LitByteStr.html" title="struct syn::LitByteStr">LitByteStr</a>;</code></div></li><li><div class="item-name" id="reexport.LitByteStr-1"><code>pub use crate::lit::LitByteStr;</code></div></li><li><div class="item-name" id="reexport.LitChar"><code>pub use crate::lit::<a class="struct" href="struct.LitChar.html" title="struct syn::LitChar">LitChar</a>;</code></div></li><li><div class="item-name" id="reexport.LitChar-1"><code>pub use crate::lit::LitChar;</code></div></li><li><div class="item-name" id="reexport.LitFloat"><code>pub use crate::lit::<a class="struct" href="struct.LitFloat.html" title="struct syn::LitFloat">LitFloat</a>;</code></div></li><li><div class="item-name" id="reexport.LitFloat-1"><code>pub use crate::lit::LitFloat;</code></div></li><li><div class="item-name" id="reexport.LitInt"><code>pub use crate::lit::<a class="struct" href="struct.LitInt.html" title="struct syn::LitInt">LitInt</a>;</code></div></li><li><div class="item-name" id="reexport.LitInt-1"><code>pub use crate::lit::LitInt;</code></div></li><li><div class="item-name" id="reexport.LitStr"><code>pub use crate::lit::<a class="struct" href="struct.LitStr.html" title="struct syn::LitStr">LitStr</a>;</code></div></li><li><div class="item-name" id="reexport.LitStr-1"><code>pub use crate::lit::LitStr;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="buffer/index.html" title="mod syn::buffer">buffer</a></div><div class="desc docblock-short">A stably addressed token buffer supporting efficient traversal based on a
|
|||
|
|
cheaply copyable cursor.</div></li><li><div class="item-name"><a class="mod" href="ext/index.html" title="mod syn::ext">ext</a></div><div class="desc docblock-short">Extension traits to provide parsing methods on foreign types.</div></li><li><div class="item-name"><a class="mod" href="parse/index.html" title="mod syn::parse">parse</a></div><div class="desc docblock-short">Parsing interface for parsing a token stream into a syntax tree node.</div></li><li><div class="item-name"><a class="mod" href="punctuated/index.html" title="mod syn::punctuated">punctuated</a></div><div class="desc docblock-short">A punctuated sequence of syntax tree nodes separated by punctuation.</div></li><li><div class="item-name"><a class="mod" href="spanned/index.html" title="mod syn::spanned">spanned</a></div><div class="desc docblock-short">A trait that can provide the <code>Span</code> of the complete contents of a syntax
|
|||
|
|
tree node.</div></li><li><div class="item-name"><a class="mod" href="token/index.html" title="mod syn::token">token</a></div><div class="desc docblock-short">Tokens representing Rust punctuation, keywords, and delimiters.</div></li></ul><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.Token.html" title="macro syn::Token">Token</a></div><div class="desc docblock-short">A type-macro that expands to the name of the Rust type representation of a
|
|||
|
|
given token.</div></li><li><div class="item-name"><a class="macro" href="macro.braced.html" title="macro syn::braced">braced</a></div><div class="desc docblock-short">Parse a set of curly braces and expose their content to subsequent parsers.</div></li><li><div class="item-name"><a class="macro" href="macro.bracketed.html" title="macro syn::bracketed">bracketed</a></div><div class="desc docblock-short">Parse a set of square brackets and expose their content to subsequent
|
|||
|
|
parsers.</div></li><li><div class="item-name"><a class="macro" href="macro.custom_keyword.html" title="macro syn::custom_keyword">custom_<wbr>keyword</a></div><div class="desc docblock-short">Define a type that supports parsing and printing a given identifier as if it
|
|||
|
|
were a keyword.</div></li><li><div class="item-name"><a class="macro" href="macro.custom_punctuation.html" title="macro syn::custom_punctuation">custom_<wbr>punctuation</a></div><div class="desc docblock-short">Define a type that supports parsing and printing a multi-character symbol
|
|||
|
|
as if it were a punctuation token.</div></li><li><div class="item-name"><a class="macro" href="macro.parenthesized.html" title="macro syn::parenthesized">parenthesized</a></div><div class="desc docblock-short">Parse a set of parentheses and expose their content to subsequent parsers.</div></li><li><div class="item-name"><a class="macro" href="macro.parse_macro_input.html" title="macro syn::parse_macro_input">parse_<wbr>macro_<wbr>input</a></div><div class="desc docblock-short">Parse the input TokenStream of a macro, triggering a compile error if the
|
|||
|
|
tokens fail to parse.</div></li><li><div class="item-name"><a class="macro" href="macro.parse_quote.html" title="macro syn::parse_quote">parse_<wbr>quote</a></div><div class="desc docblock-short">Quasi-quotation macro that accepts input like the <a href="https://docs.rs/quote/1.0/quote/index.html"><code>quote!</code></a> macro but uses
|
|||
|
|
type inference to figure out a return type for those tokens.</div></li><li><div class="item-name"><a class="macro" href="macro.parse_quote_spanned.html" title="macro syn::parse_quote_spanned">parse_<wbr>quote_<wbr>spanned</a></div><div class="desc docblock-short">This macro is <a href="macro.parse_quote.html" title="macro syn::parse_quote"><code>parse_quote!</code></a> + <a href="../quote/macro.quote_spanned.html" title="macro quote::quote_spanned"><code>quote_spanned!</code></a>.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Abi.html" title="struct syn::Abi">Abi</a></div><div class="desc docblock-short">The binary interface of a function: <code>extern "C"</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.AngleBracketedGenericArguments.html" title="struct syn::AngleBracketedGenericArguments">Angle<wbr>Bracketed<wbr>Generic<wbr>Arguments</a></div><div class="desc docblock-short">Angle bracketed arguments of a path segment: the <code><K, V></code> in <code>HashMap<K, V></code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Arm.html" title="struct syn::Arm">Arm</a></div><div class="desc docblock-short">One arm of a <code>match</code> expression: <code>0...10 => { return true; }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Attribute.html" title="struct syn::Attribute">Attribute</a></div><div class="desc docblock-short">An attribute like <code>#[repr(transparent)]</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.BareFnArg.html" title="struct syn::BareFnArg">Bare<wbr>FnArg</a></div><div class="desc docblock-short">An argument in a function type: the <code>usize</code> in <code>fn(usize) -> bool</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Binding.html" title="struct syn::Binding">Binding</a></div><div class="desc docblock-short">A binding (equality constraint) on an associated type: <code>Item = u8</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Block.html" title="struct syn::Block">Block</a></div><div class="desc docblock-short">A braced block containing Rust statements.</div></li><li><div class="item-name"><a class="struct" href="struct.BoundLifetimes.html" title="struct syn::BoundLifetimes">Bound<wbr>Lifetimes</a></div><div class="desc docblock-short">A set of bound lifetimes: <code>for<'a, 'b, 'c></code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ConstParam.html" title="struct syn::ConstParam">Const<wbr>Param</a></div><div class="desc docblock-short">A const generic parameter: <code>const LENGTH: usize</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Constraint.html" title="struct syn::Constraint">Constraint</a></div><div class="desc docblock-short">An associated type bound: <code>Iterator<Item: Display></code>.</div></li><li><div class="item-name"><a class="struct" href="struct.DataEnum.html" title="struct syn::DataEnum">Data<wbr>Enum</a></div><div class="desc docblock-short">An enum input to a <code>proc_macro_derive</code> macro.</div></li><li><div class="item-name"><a class="struct" href="struct.DataStruct.html" title="struct syn::DataStruct">Data<wbr>Struct</a></div><div class="desc docblock-short">A struct input to a <code>proc_macro_derive</code> macro.</div></li><li><div class="item-name"><a class="struct" href="struct.DataUnion.html" title="struct syn::DataUnion">Data<wbr>Union</a></div><div class="desc docblock-short">An untagged union input to a <code>proc_macro_derive</code> macro.</div></li><li><div class="item-name"><a class="struct" href="struct.DeriveInput.html" title="struct syn::DeriveInput">Derive<wbr>Input</a></div><div class="desc docblock-short">Data structure sent to a <code>proc_macro_derive</code> macro.</div></li><li><div class="item-name"><a class="struct" href="struct.Error.html" title="struct syn::Error">Error<
|
|||
|
|
expression.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprCall.html" title="struct syn::ExprCall">Expr<wbr>Call</a></div><div class="desc docblock-short">A function call expression: <code>invoke(a, b)</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprCast.html" title="struct syn::ExprCast">Expr<wbr>Cast</a></div><div class="desc docblock-short">A cast expression: <code>foo as f64</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprClosure.html" title="struct syn::ExprClosure">Expr<wbr>Closure</a></div><div class="desc docblock-short">A closure expression: <code>|a, b| a + b</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprContinue.html" title="struct syn::ExprContinue">Expr<wbr>Continue</a></div><div class="desc docblock-short">A <code>continue</code>, with an optional label.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprField.html" title="struct syn::ExprField">Expr<wbr>Field</a></div><div class="desc docblock-short">Access of a named struct field (<code>obj.k</code>) or unnamed tuple struct
|
|||
|
|
field (<code>obj.0</code>).</div></li><li><div class="item-name"><a class="struct" href="struct.ExprForLoop.html" title="struct syn::ExprForLoop">Expr<wbr>ForLoop</a></div><div class="desc docblock-short">A for loop: <code>for pat in expr { ... }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprGroup.html" title="struct syn::ExprGroup">Expr<wbr>Group</a></div><div class="desc docblock-short">An expression contained within invisible delimiters.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprIf.html" title="struct syn::ExprIf">ExprIf</a></div><div class="desc docblock-short">An <code>if</code> expression with an optional <code>else</code> block: <code>if expr { ... } else { ... }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprIndex.html" title="struct syn::ExprIndex">Expr<wbr>Index</a></div><div class="desc docblock-short">A square bracketed indexing expression: <code>vector[2]</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprLet.html" title="struct syn::ExprLet">ExprLet</a></div><div class="desc docblock-short">A <code>let</code> guard: <code>let Some(x) = opt</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprLit.html" title="struct syn::ExprLit">ExprLit</a></div><div class="desc docblock-short">A literal in place of an expression: <code>1</code>, <code>"foo"</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprLoop.html" title="struct syn::ExprLoop">Expr<wbr>Loop</a></div><div class="desc docblock-short">Conditionless loop: <code>loop { ... }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprMacro.html" title="struct syn::ExprMacro">Expr<wbr>Macro</a></div><div class="desc docblock-short">A macro invocation expression: <code>format!("{}", q)</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprMatch.html" title="struct syn::ExprMatch">Expr<wbr>Match</a></div><div class="desc docblock-short">A <code>match</code> expression: <code>match n { Some(n) => {}, None => {} }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprMethodCall.html" title="struct syn::ExprMethodCall">Expr<wbr>Method<wbr>Call</a></div><div class="desc docblock-short">A method call expression: <code>x.foo::<T>(a, b)</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprParen.html" title="struct syn::ExprParen">Expr<wbr>Paren</a></div><div class="desc docblock-short">A parenthesized expression: <code>(a + b)</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprPath.html" title="struct syn::ExprPath">Expr<wbr>Path</a></div><div class="desc docblock-short">A path like <code>std::mem::replace</code> possibly containing generic
|
|||
|
|
parameters and a qualified self-type.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprRange.html" title="struct syn::ExprRange">Expr<wbr>Range</a></div><div class="desc docblock-short">A range expression: <code>1..2</code>, <code>1..</code>, <code>..2</code>, <code>1..=2</code>, <code>..=2</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprReference.html" title="struct syn::ExprReference">Expr<wbr>Reference</a></div><div class="desc docblock-short">A referencing operation: <code>&a</code> or <code>&mut a</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprRepeat.html" title="struct syn::ExprRepeat">Expr<wbr>Repeat</a></div><div class="desc docblock-short">An array literal constructed from one repeated element: <code>[0u8; N]</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprReturn.html" title="struct syn::ExprReturn">Expr<wbr>Return</a></div><div class="desc docblock-short">A <code>return</code>, with an optional value to be returned.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprStruct.html" title="struct syn::ExprStruct">Expr<wbr>Struct</a></div><div class="desc docblock-short">A struct literal expression: <code>Point { x: 1, y: 1 }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprTry.html" title="struct syn::ExprTry">ExprTry</a></div><div class="desc docblock-short">A try-expression: <code>expr?</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprTryBlock.html" title="struct syn::ExprTryBlock">Expr<wbr>TryBlock</a></div><div class="desc docblock-short">A try block: <code>try { ... }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprTuple.html" title="struct syn::ExprTuple">Expr<wbr>Tuple</a></div><div class="desc docblock-short">A tuple expression: <code>(a, b, c, d)</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprType.html" title="struct syn::ExprType">Expr<wbr>Type</a></div><div class="desc docblock-short">A type ascription expression: <code>foo: f64</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprUnary.html" title="struct syn::ExprUnary">Expr<wbr>Unary</a></div><div class="desc docblock-short">A unary operation: <code>!x</code>, <code>*x</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprUnsafe.html" title="struct syn::ExprUnsafe">Expr<wbr>Unsafe</a></div><div class="desc docblock-short">An unsafe block: <code>unsafe { ... }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprWhile.html" title="struct syn::ExprWhile">Expr<wbr>While</a></div><div class="desc docblock-short">A while loop: <code>while expr { ... }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ExprYield.html" title="struct syn::ExprYield">Expr<wbr>Yield</a></div><div class="desc docblock-short">A yield expression: <code>yield expr</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Field.html" title="struct syn::Field">Field</a></div><div class="desc docblock-short">A field of a struct or enum variant.</div></li><li><div class="item-name"><a class="struct" href="struct.FieldPat.html" title="struct syn::FieldPat">Field<wbr>Pat</a></div><div class="desc docblock-short">A single field in a struct pattern.</div></li><li><div class="item-name"><a class="struct" href="struct.FieldValue.html" title="struct syn::FieldValue">Field<wbr>Value</a></div><div class="desc docblock-short">A field-value pair in a struct literal.</div></li><li><div class="item-name"><a class="struct" href="struct.FieldsNamed.html" title="struct syn::FieldsNamed">Fields<wbr>Named</a></div><div class="desc docblock-short">Named fields of a struct or struct variant such as <code>Point { x: f64, y: f64 }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.FieldsUnnamed.html" title="struct syn::FieldsUnnamed">Fields<wbr>Unnamed</a></div><div class="desc docblock-sho
|
|||
|
|
enum, trait, etc.</div></li><li><div class="item-name"><a class="struct" href="struct.Ident.html" title="struct syn::Ident">Ident</a></div><div class="desc docblock-short">A word of Rust code, which may be a keyword or legal variable name.</div></li><li><div class="item-name"><a class="struct" href="struct.ImplGenerics.html" title="struct syn::ImplGenerics">Impl<wbr>Generics</a></div><div class="desc docblock-short">Returned by <code>Generics::split_for_impl</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ImplItemConst.html" title="struct syn::ImplItemConst">Impl<wbr>Item<wbr>Const</a></div><div class="desc docblock-short">An associated constant within an impl block.</div></li><li><div class="item-name"><a class="struct" href="struct.ImplItemMacro.html" title="struct syn::ImplItemMacro">Impl<wbr>Item<wbr>Macro</a></div><div class="desc docblock-short">A macro invocation within an impl block.</div></li><li><div class="item-name"><a class="struct" href="struct.ImplItemMethod.html" title="struct syn::ImplItemMethod">Impl<wbr>Item<wbr>Method</a></div><div class="desc docblock-short">A method within an impl block.</div></li><li><div class="item-name"><a class="struct" href="struct.ImplItemType.html" title="struct syn::ImplItemType">Impl<wbr>Item<wbr>Type</a></div><div class="desc docblock-short">An associated type within an impl block.</div></li><li><div class="item-name"><a class="struct" href="struct.Index.html" title="struct syn::Index">Index</a></div><div class="desc docblock-short">The index of an unnamed tuple struct field.</div></li><li><div class="item-name"><a class="struct" href="struct.ItemConst.html" title="struct syn::ItemConst">Item<wbr>Const</a></div><div class="desc docblock-short">A constant item: <code>const MAX: u16 = 65535</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ItemEnum.html" title="struct syn::ItemEnum">Item<wbr>Enum</a></div><div class="desc docblock-short">An enum definition: <code>enum Foo<A, B> { A(A), B(B) }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ItemExternCrate.html" title="struct syn::ItemExternCrate">Item<wbr>Extern<wbr>Crate</a></div><div class="desc docblock-short">An <code>extern crate</code> item: <code>extern crate serde</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ItemFn.html" title="struct syn::ItemFn">ItemFn</a></div><div class="desc docblock-short">A free-standing function: <code>fn process(n: usize) -> Result<()> { ... }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ItemForeignMod.html" title="struct syn::ItemForeignMod">Item<wbr>Foreign<wbr>Mod</a></div><div class="desc docblock-short">A block of foreign items: <code>extern "C" { ... }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ItemImpl.html" title="struct syn::ItemImpl">Item<wbr>Impl</a></div><div class="desc docblock-short">An impl block providing trait or associated items: <code>impl<A> Trait for Data<A> { ... }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ItemMacro.html" title="struct syn::ItemMacro">Item<wbr>Macro</a></div><div class="desc docblock-short">A macro invocation, which includes <code>macro_rules!</code> definitions.</div></li><li><div class="item-name"><a class="struct" href="struct.ItemMacro2.html" title="struct syn::ItemMacro2">Item<wbr>Macro2</a></div><div class="desc docblock-short">A 2.0-style declarative macro introduced by the <code>macro</code> keyword.</div></li><li><div class="item-name"><a class="struct" href="struct.ItemMod.html" title="struct syn::ItemMod">ItemMod</a></div><div class="desc docblock-short">A module or module declaration: <code>mod m</code> or <code>mod m { ... }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ItemStatic.html" title="struct syn::ItemStatic">Item<wbr>Static</a></div><div class="desc docblock-short">A static item: <code>static BIKE: Shed = Shed(42)</code>.</div></li><li><div class="item-name"><a clas
|
|||
|
|
<code>parse::<u64>()</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ParenthesizedGenericArguments.html" title="struct syn::ParenthesizedGenericArguments">Parenthesized<wbr>Generic<wbr>Arguments</a></div><div class="desc docblock-short">Arguments of a function path segment: the <code>(A, B) -> C</code> in <code>Fn(A,B) -> C</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PatBox.html" title="struct syn::PatBox">PatBox</a></div><div class="desc docblock-short">A box pattern: <code>box v</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PatIdent.html" title="struct syn::PatIdent">PatIdent</a></div><div class="desc docblock-short">A pattern that binds a new variable: <code>ref mut binding @ SUBPATTERN</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PatLit.html" title="struct syn::PatLit">PatLit</a></div><div class="desc docblock-short">A literal pattern: <code>0</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PatMacro.html" title="struct syn::PatMacro">PatMacro</a></div><div class="desc docblock-short">A macro in pattern position.</div></li><li><div class="item-name"><a class="struct" href="struct.PatOr.html" title="struct syn::PatOr">PatOr</a></div><div class="desc docblock-short">A pattern that matches any one of a set of cases.</div></li><li><div class="item-name"><a class="struct" href="struct.PatPath.html" title="struct syn::PatPath">PatPath</a></div><div class="desc docblock-short">A path pattern like <code>Color::Red</code>, optionally qualified with a
|
|||
|
|
self-type.</div></li><li><div class="item-name"><a class="struct" href="struct.PatRange.html" title="struct syn::PatRange">PatRange</a></div><div class="desc docblock-short">A range pattern: <code>1..=2</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PatReference.html" title="struct syn::PatReference">PatReference</a></div><div class="desc docblock-short">A reference pattern: <code>&mut var</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PatRest.html" title="struct syn::PatRest">PatRest</a></div><div class="desc docblock-short">The dots in a tuple or slice pattern: <code>[0, 1, ..]</code></div></li><li><div class="item-name"><a class="struct" href="struct.PatSlice.html" title="struct syn::PatSlice">PatSlice</a></div><div class="desc docblock-short">A dynamically sized slice pattern: <code>[a, b, ref i @ .., y, z]</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PatStruct.html" title="struct syn::PatStruct">PatStruct</a></div><div class="desc docblock-short">A struct or struct variant pattern: <code>Variant { x, y, .. }</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PatTuple.html" title="struct syn::PatTuple">PatTuple</a></div><div class="desc docblock-short">A tuple pattern: <code>(a, b)</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PatTupleStruct.html" title="struct syn::PatTupleStruct">PatTuple<wbr>Struct</a></div><div class="desc docblock-short">A tuple struct or tuple variant pattern: <code>Variant(x, y, .., z)</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PatType.html" title="struct syn::PatType">PatType</a></div><div class="desc docblock-short">A type ascription pattern: <code>foo: f64</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PatWild.html" title="struct syn::PatWild">PatWild</a></div><div class="desc docblock-short">A pattern that matches any value: <code>_</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Path.html" title="struct syn::Path">Path</a></div><div class="desc docblock-short">A path at which a named item is exported (e.g. <code>std::collections::HashMap</code>).</div></li><li><div class="item-name"><a class="struct" href="struct.PathSegment.html" title="struct syn::PathSegment">Path<wbr>Segment</a></div><div class="desc docblock-short">A segment of a path together with any path arguments on that segment.</div></li><li><div class="item-name"><a class="struct" href="struct.PredicateEq.html" title="struct syn::PredicateEq">Predicate<wbr>Eq</a></div><div class="desc docblock-short">An equality predicate in a <code>where</code> clause (unsupported).</div></li><li><div class="item-name"><a class="struct" href="struct.PredicateLifetime.html" title="struct syn::PredicateLifetime">Predicate<wbr>Lifetime</a></div><div class="desc docblock-short">A lifetime predicate in a <code>where</code> clause: <code>'a: 'b + 'c</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PredicateType.html" title="struct syn::PredicateType">Predicate<wbr>Type</a></div><div class="desc docblock-short">A type predicate in a <code>where</code> clause: <code>for<'c> Foo<'c>: Trait<'c></code>.</div></li><li><div class="item-name"><a class="struct" href="struct.QSelf.html" title="struct syn::QSelf">QSelf</a></div><div class="desc docblock-short">The explicit Self type in a qualified path: the <code>T</code> in <code><T as Display>::fmt</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Receiver.html" title="struct syn::Receiver">Receiver</a></div><div class="desc docblock-short">The <code>self</code> argument of an associated method, whether taken by value
|
|||
|
|
or by reference.</div></li><li><div class="item-name"><a class="struct" href="struct.Signature.html" title="struct syn::Signature">Signature</a></div><div class="desc docblock-short">A function signature in a trait or implementation: <code>unsafe fn initialize(&self)</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.TraitBound.html" title="struct syn::TraitBound">Trait<wbr>Bound</a></div><div class="desc docblock-short">A trait used as a bound on a type parameter.</div></li><li><div class="item-name"><a class="struct" href="struct.TraitItemConst.html" title="struct syn::TraitItemConst">Trait<wbr>Item<wbr>Const</a></div><div class="desc docblock-short">An associated constant within the definition of a trait.</div></li><li><div class="item-name"><a class="struct" href="struct.TraitItemMacro.html" title="struct syn::TraitItemMacro">Trait<wbr>Item<wbr>Macro</a></div><div class="desc docblock-short">A macro invocation within the definition of a trait.</div></li><li><div class="item-name"><a class="struct" href="struct.TraitItemMethod.html" title="struct syn::TraitItemMethod">Trait<wbr>Item<wbr>Method</a></div><div class="desc docblock-short">A trait method within the definition of a trait.</div></li><li><div class="item-name"><a class="struct" href="struct.TraitItemType.html" title="struct syn::TraitItemType">Trait<wbr>Item<wbr>Type</a></div><div class="desc docblock-short">An associated type within the definition of a trait.</div></li><li><div class="item-name"><a class="struct" href="struct.Turbofish.html" title="struct syn::Turbofish">Turbofish</a></div><div class="desc docblock-short">Returned by <code>TypeGenerics::as_turbofish</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.TypeArray.html" title="struct syn::TypeArray">Type<wbr>Array</a></div><div class="desc docblock-short">A fixed size array type: <code>[T; n]</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.TypeBareFn.html" title="struct syn::TypeBareFn">Type<wbr>Bare<wbr>Fn</a></div><div class="desc docblock-short">A bare function type: <code>fn(usize) -> bool</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.TypeGenerics.html" title="struct syn::TypeGenerics">Type<wbr>Generics</a></div><div class="desc docblock-short">Returned by <code>Generics::split_for_impl</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.TypeGroup.html" title="struct syn::TypeGroup">Type<wbr>Group</a></div><div class="desc docblock-short">A type contained within invisible delimiters.</div></li><li><div class="item-name"><a class="struct" href="struct.TypeImplTrait.html" title="struct syn::TypeImplTrait">Type<wbr>Impl<wbr>Trait</a></div><div class="desc docblock-short">An <code>impl Bound1 + Bound2 + Bound3</code> type where <code>Bound</code> is a trait or
|
|||
|
|
a lifetime.</div></li><li><div class="item-name"><a class="struct" href="struct.TypeInfer.html" title="struct syn::TypeInfer">Type<wbr>Infer</a></div><div class="desc docblock-short">Indication that a type should be inferred by the compiler: <code>_</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.TypeMacro.html" title="struct syn::TypeMacro">Type<wbr>Macro</a></div><div class="desc docblock-short">A macro in the type position.</div></li><li><div class="item-name"><a class="struct" href="struct.TypeNever.html" title="struct syn::TypeNever">Type<wbr>Never</a></div><div class="desc docblock-short">The never type: <code>!</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.TypeParam.html" title="struct syn::TypeParam">Type<wbr>Param</a></div><div class="desc docblock-short">A generic type parameter: <code>T: Into<String></code>.</div></li><li><div class="item-name"><a class="struct" href="struct.TypeParen.html" title="struct syn::TypeParen">Type<wbr>Paren</a></div><div class="desc docblock-short">A parenthesized type equivalent to the inner type.</div></li><li><div class="item-name"><a class="struct" href="struct.TypePath.html" title="struct syn::TypePath">Type<wbr>Path</a></div><div class="desc docblock-short">A path like <code>std::slice::Iter</code>, optionally qualified with a
|
|||
|
|
self-type as in <code><Vec<T> as SomeTrait>::Associated</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.TypePtr.html" title="struct syn::TypePtr">TypePtr</a></div><div class="desc docblock-short">A raw pointer type: <code>*const T</code> or <code>*mut T</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.TypeReference.html" title="struct syn::TypeReference">Type<wbr>Reference</a></div><div class="desc docblock-short">A reference type: <code>&'a T</code> or <code>&'a mut T</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.TypeSlice.html" title="struct syn::TypeSlice">Type<wbr>Slice</a></div><div class="desc docblock-short">A dynamically sized slice type: <code>[T]</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.TypeTraitObject.html" title="struct syn::TypeTraitObject">Type<wbr>Trait<wbr>Object</a></div><div class="desc docblock-short">A trait object type <code>dyn Bound1 + Bound2 + Bound3</code> where <code>Bound</code> is a
|
|||
|
|
trait or a lifetime.</div></li><li><div class="item-name"><a class="struct" href="struct.TypeTuple.html" title="struct syn::TypeTuple">Type<wbr>Tuple</a></div><div class="desc docblock-short">A tuple type: <code>(A, B, C, String)</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.UseGlob.html" title="struct syn::UseGlob">UseGlob</a></div><div class="desc docblock-short">A glob import in a <code>use</code> item: <code>*</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.UseGroup.html" title="struct syn::UseGroup">UseGroup</a></div><div class="desc docblock-short">A braced group of imports in a <code>use</code> item: <code>{A, B, C}</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.UseName.html" title="struct syn::UseName">UseName</a></div><div class="desc docblock-short">An identifier imported by a <code>use</code> item: <code>HashMap</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.UsePath.html" title="struct syn::UsePath">UsePath</a></div><div class="desc docblock-short">A path prefix of imports in a <code>use</code> item: <code>std::...</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.UseRename.html" title="struct syn::UseRename">UseRename</a></div><div class="desc docblock-short">An renamed identifier imported by a <code>use</code> item: <code>HashMap as Map</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Variadic.html" title="struct syn::Variadic">Variadic</a></div><div class="desc docblock-short">The variadic argument of a foreign function.</div></li><li><div class="item-name"><a class="struct" href="struct.Variant.html" title="struct syn::Variant">Variant</a></div><div class="desc docblock-short">An enum variant.</div></li><li><div class="item-name"><a class="struct" href="struct.VisCrate.html" title="struct syn::VisCrate">VisCrate</a></div><div class="desc docblock-short">A crate-level visibility: <code>crate</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.VisPublic.html" title="struct syn::VisPublic">VisPublic</a></div><div class="desc docblock-short">A public visibility level: <code>pub</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.VisRestricted.html" title="struct syn::VisRestricted">VisRestricted</a></div><div class="desc docblock-short">A visibility level restricted to some path: <code>pub(self)</code> or
|
|||
|
|
<code>pub(super)</code> or <code>pub(crate)</code> or <code>pub(in some::module)</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.WhereClause.html" title="struct syn::WhereClause">Where<wbr>Clause</a></div><div class="desc docblock-short">A <code>where</code> clause in a definition: <code>where T: Deserialize<'de>, D: 'static</code>.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.AttrStyle.html" title="enum syn::AttrStyle">Attr<wbr>Style</a></div><div class="desc docblock-short">Distinguishes between attributes that decorate an item and attributes
|
|||
|
|
that are contained within an item.</div></li><li><div class="item-name"><a class="enum" href="enum.BinOp.html" title="enum syn::BinOp">BinOp</a></div><div class="desc docblock-short">A binary operator: <code>+</code>, <code>+=</code>, <code>&</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.Data.html" title="enum syn::Data">Data</a></div><div class="desc docblock-short">The storage of a struct, enum or union data structure.</div></li><li><div class="item-name"><a class="enum" href="enum.Expr.html" title="enum syn::Expr">Expr</a></div><div class="desc docblock-short">A Rust expression.</div></li><li><div class="item-name"><a class="enum" href="enum.Fields.html" title="enum syn::Fields">Fields</a></div><div class="desc docblock-short">Data stored within an enum variant or struct.</div></li><li><div class="item-name"><a class="enum" href="enum.FnArg.html" title="enum syn::FnArg">FnArg</a></div><div class="desc docblock-short">An argument in a function signature: the <code>n: usize</code> in <code>fn f(n: usize)</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.ForeignItem.html" title="enum syn::ForeignItem">Foreign<wbr>Item</a></div><div class="desc docblock-short">An item within an <code>extern</code> block.</div></li><li><div class="item-name"><a class="enum" href="enum.GenericArgument.html" title="enum syn::GenericArgument">Generic<wbr>Argument</a></div><div class="desc docblock-short">An individual generic argument, like <code>'a</code>, <code>T</code>, or <code>Item = T</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.GenericMethodArgument.html" title="enum syn::GenericMethodArgument">Generic<wbr>Method<wbr>Argument</a></div><div class="desc docblock-short">An individual generic argument to a method, like <code>T</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.GenericParam.html" title="enum syn::GenericParam">Generic<wbr>Param</a></div><div class="desc docblock-short">A generic type parameter, lifetime, or const generic: <code>T: Into<String></code>,
|
|||
|
|
<code>'a: 'b</code>, <code>const LEN: usize</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.ImplItem.html" title="enum syn::ImplItem">Impl<wbr>Item</a></div><div class="desc docblock-short">An item within an impl block.</div></li><li><div class="item-name"><a class="enum" href="enum.Item.html" title="enum syn::Item">Item</a></div><div class="desc docblock-short">Things that can appear directly inside of a module or scope.</div></li><li><div class="item-name"><a class="enum" href="enum.Lit.html" title="enum syn::Lit">Lit</a></div><div class="desc docblock-short">A Rust literal such as a string or integer or boolean.</div></li><li><div class="item-name"><a class="enum" href="enum.MacroDelimiter.html" title="enum syn::MacroDelimiter">Macro<wbr>Delimiter</a></div><div class="desc docblock-short">A grouping token that surrounds a macro body: <code>m!(...)</code> or <code>m!{...}</code> or <code>m![...]</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.Member.html" title="enum syn::Member">Member</a></div><div class="desc docblock-short">A struct or tuple struct field accessed in a struct literal or field
|
|||
|
|
expression.</div></li><li><div class="item-name"><a class="enum" href="enum.Meta.html" title="enum syn::Meta">Meta</a></div><div class="desc docblock-short">Content of a compile-time structured attribute.</div></li><li><div class="item-name"><a class="enum" href="enum.NestedMeta.html" title="enum syn::NestedMeta">Nested<wbr>Meta</a></div><div class="desc docblock-short">Element of a compile-time attribute list.</div></li><li><div class="item-name"><a class="enum" href="enum.Pat.html" title="enum syn::Pat">Pat</a></div><div class="desc docblock-short">A pattern in a local binding, function signature, match expression, or
|
|||
|
|
various other places.</div></li><li><div class="item-name"><a class="enum" href="enum.PathArguments.html" title="enum syn::PathArguments">Path<wbr>Arguments</a></div><div class="desc docblock-short">Angle bracketed or parenthesized arguments of a path segment.</div></li><li><div class="item-name"><a class="enum" href="enum.RangeLimits.html" title="enum syn::RangeLimits">Range<wbr>Limits</a></div><div class="desc docblock-short">Limit types of a range, inclusive or exclusive.</div></li><li><div class="item-name"><a class="enum" href="enum.ReturnType.html" title="enum syn::ReturnType">Return<wbr>Type</a></div><div class="desc docblock-short">Return type of a function signature.</div></li><li><div class="item-name"><a class="enum" href="enum.Stmt.html" title="enum syn::Stmt">Stmt</a></div><div class="desc docblock-short">A statement, usually ending in a semicolon.</div></li><li><div class="item-name"><a class="enum" href="enum.StrStyle.html" title="enum syn::StrStyle">StrStyle</a></div><div class="desc docblock-short">The style of a string literal, either plain quoted or a raw string like
|
|||
|
|
<code>r##"data"##</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.TraitBoundModifier.html" title="enum syn::TraitBoundModifier">Trait<wbr>Bound<wbr>Modifier</a></div><div class="desc docblock-short">A modifier on a trait bound, currently only used for the <code>?</code> in
|
|||
|
|
<code>?Sized</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.TraitItem.html" title="enum syn::TraitItem">Trait<wbr>Item</a></div><div class="desc docblock-short">An item declaration within the definition of a trait.</div></li><li><div class="item-name"><a class="enum" href="enum.Type.html" title="enum syn::Type">Type</a></div><div class="desc docblock-short">The possible types that a Rust value could have.</div></li><li><div class="item-name"><a class="enum" href="enum.TypeParamBound.html" title="enum syn::TypeParamBound">Type<wbr>Param<wbr>Bound</a></div><div class="desc docblock-short">A trait or lifetime used as a bound on a type parameter.</div></li><li><div class="item-name"><a class="enum" href="enum.UnOp.html" title="enum syn::UnOp">UnOp</a></div><div class="desc docblock-short">A unary operator: <code>*</code>, <code>!</code>, <code>-</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.UseTree.html" title="enum syn::UseTree">UseTree</a></div><div class="desc docblock-short">A suffix of an import tree in a <code>use</code> item: <code>Type as Renamed</code> or <code>*</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.Visibility.html" title="enum syn::Visibility">Visibility</a></div><div class="desc docblock-short">The visibility level of an item: inherited or <code>pub</code> or
|
|||
|
|
<code>pub(restricted)</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.WherePredicate.html" title="enum syn::WherePredicate">Where<wbr>Predicate</a></div><div class="desc docblock-short">A single predicate in a <code>where</code> clause: <code>T: Deserialize<'de></code>.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.parse.html" title="fn syn::parse">parse</a></div><div class="desc docblock-short">Parse tokens of source code into the chosen syntax tree node.</div></li><li><div class="item-name"><a class="fn" href="fn.parse2.html" title="fn syn::parse2">parse2</a></div><div class="desc docblock-short">Parse a proc-macro2 token stream into the chosen syntax tree node.</div></li><li><div class="item-name"><a class="fn" href="fn.parse_file.html" title="fn syn::parse_file">parse_<wbr>file</a></div><div class="desc docblock-short">Parse the content of a file of Rust code.</div></li><li><div class="item-name"><a class="fn" href="fn.parse_str.html" title="fn syn::parse_str">parse_<wbr>str</a></div><div class="desc docblock-short">Parse a string of Rust code into the chosen syntax tree node.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.AttributeArgs.html" title="type syn::AttributeArgs">Attribute<wbr>Args</a></div><div class="desc docblock-short">Conventional argument type associated with an invocation of an attribute
|
|||
|
|
macro.</div></li><li><div class="item-name"><a class="type" href="type.Result.html" title="type syn::Result">Result</a></div><div class="desc docblock-short">The result of a Syn parser.</div></li></ul></section></div></main></body></html>
|