Auto Generated Documentation
This commit is contained in:
github-actions[bot]
+141
-109
@@ -1,110 +1,142 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A type-macro that expands to the name of the Rust type representation of a given token."><meta name="keywords" content="rust, rustlang, rust-lang, Token"><title>Token in syn - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../syn/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class="location"><a href="index.html">syn</a></p><div id="sidebar-vars" data-name="Token" data-ty="macro" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Macro <a href="index.html">syn</a>::<wbr><a class="macro" href="">Token</a><button id="copy-path" onclick="copy_path(this)">⎘</button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/syn/await.rs.html#2" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><div class="example-wrap"><pre class="rust macro">
|
||||
<span class="macro">macro_rules!</span> <span class="ident">Token</span> {
|
||||
[<span class="kw">abstract</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">as</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">async</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="ident">auto</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">await</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">become</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">box</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">break</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">const</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">continue</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">crate</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="ident">default</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">do</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">dyn</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">else</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">enum</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">extern</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">final</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">fn</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">for</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">if</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">impl</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">in</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">let</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">loop</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">macro</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">match</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">mod</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">move</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw-2">mut</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">override</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">priv</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">pub</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw-2">ref</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">return</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="self">Self</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="self">self</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">static</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">struct</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">super</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">trait</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">try</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">type</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">typeof</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="ident">union</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">unsafe</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">unsized</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">use</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">virtual</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">where</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">while</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">yield</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">+</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">+</span><span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw-2">&</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">&&</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">&=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[@] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">!</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">^</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">^</span><span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[:] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[::] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[,] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">/</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">/</span><span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[$] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[.] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[..] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[...] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[..<span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">=</span><span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">></span><span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">></span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op"><</span><span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op"><</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw-2">*</span><span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">!</span><span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">|</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">|</span><span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">|</span><span class="op">|</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[#] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="question-mark">?</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">-</span><span class="op">></span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op"><</span><span class="op">-</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">%</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">%</span><span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">=</span><span class="op">></span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[;] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op"><</span><span class="op"><</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op"><</span><span class="op"><</span><span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">></span><span class="op">></span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">></span><span class="op">></span><span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw-2">*</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">-</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="op">-</span><span class="op">=</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[~] <span class="op">=</span><span class="op">></span> { ... };
|
||||
[<span class="kw">_</span>] <span class="op">=</span><span class="op">></span> { ... };
|
||||
}</pre></div>
|
||||
</div><div class="docblock"><p>A type-macro that expands to the name of the Rust type representation of a
|
||||
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A type-macro that expands to the name of the Rust type representation of a given token."><title>Token in syn - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-46132b98.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.85.1 (4eb161250 2025-03-15)" data-channel="1.85.1" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc macro"><!--[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">2.0.100</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">syn</a></span><h1>Macro <span class="macro">Token</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/syn/token.rs.html#871-972">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! Token {
|
||||
[abstract] => { ... };
|
||||
[as] => { ... };
|
||||
[async] => { ... };
|
||||
[auto] => { ... };
|
||||
[await] => { ... };
|
||||
[become] => { ... };
|
||||
[box] => { ... };
|
||||
[break] => { ... };
|
||||
[const] => { ... };
|
||||
[continue] => { ... };
|
||||
[crate] => { ... };
|
||||
[default] => { ... };
|
||||
[do] => { ... };
|
||||
[dyn] => { ... };
|
||||
[else] => { ... };
|
||||
[enum] => { ... };
|
||||
[extern] => { ... };
|
||||
[final] => { ... };
|
||||
[fn] => { ... };
|
||||
[for] => { ... };
|
||||
[if] => { ... };
|
||||
[impl] => { ... };
|
||||
[in] => { ... };
|
||||
[let] => { ... };
|
||||
[loop] => { ... };
|
||||
[macro] => { ... };
|
||||
[match] => { ... };
|
||||
[mod] => { ... };
|
||||
[move] => { ... };
|
||||
[mut] => { ... };
|
||||
[override] => { ... };
|
||||
[priv] => { ... };
|
||||
[pub] => { ... };
|
||||
[raw] => { ... };
|
||||
[ref] => { ... };
|
||||
[return] => { ... };
|
||||
[Self] => { ... };
|
||||
[self] => { ... };
|
||||
[static] => { ... };
|
||||
[struct] => { ... };
|
||||
[super] => { ... };
|
||||
[trait] => { ... };
|
||||
[try] => { ... };
|
||||
[type] => { ... };
|
||||
[typeof] => { ... };
|
||||
[union] => { ... };
|
||||
[unsafe] => { ... };
|
||||
[unsized] => { ... };
|
||||
[use] => { ... };
|
||||
[virtual] => { ... };
|
||||
[where] => { ... };
|
||||
[while] => { ... };
|
||||
[yield] => { ... };
|
||||
[&] => { ... };
|
||||
[&&] => { ... };
|
||||
[&=] => { ... };
|
||||
[@] => { ... };
|
||||
[^] => { ... };
|
||||
[^=] => { ... };
|
||||
[:] => { ... };
|
||||
[,] => { ... };
|
||||
[$] => { ... };
|
||||
[.] => { ... };
|
||||
[..] => { ... };
|
||||
[...] => { ... };
|
||||
[..=] => { ... };
|
||||
[=] => { ... };
|
||||
[==] => { ... };
|
||||
[=>] => { ... };
|
||||
[>=] => { ... };
|
||||
[>] => { ... };
|
||||
[<-] => { ... };
|
||||
[<=] => { ... };
|
||||
[<] => { ... };
|
||||
[-] => { ... };
|
||||
[-=] => { ... };
|
||||
[!=] => { ... };
|
||||
[!] => { ... };
|
||||
[|] => { ... };
|
||||
[|=] => { ... };
|
||||
[||] => { ... };
|
||||
[::] => { ... };
|
||||
[%] => { ... };
|
||||
[%=] => { ... };
|
||||
[+] => { ... };
|
||||
[+=] => { ... };
|
||||
[#] => { ... };
|
||||
[?] => { ... };
|
||||
[->] => { ... };
|
||||
[;] => { ... };
|
||||
[<<] => { ... };
|
||||
[<<=] => { ... };
|
||||
[>>] => { ... };
|
||||
[>>=] => { ... };
|
||||
[/] => { ... };
|
||||
[/=] => { ... };
|
||||
[*] => { ... };
|
||||
[*=] => { ... };
|
||||
[~] => { ... };
|
||||
[_] => { ... };
|
||||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A type-macro that expands to the name of the Rust type representation of a
|
||||
given token.</p>
|
||||
<p>See the <a href="token/index.html">token module</a> documentation for details and examples.</p>
|
||||
</div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="syn" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
|
||||
<script src="../main.js"></script></body></html>
|
||||
<p>As a type, <code>Token!</code> is commonly used in the type of struct fields, the type
|
||||
of a <code>let</code> statement, or in turbofish for a <code>parse</code> function.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>syn::{Ident, Token};
|
||||
<span class="kw">use </span>syn::parse::{Parse, ParseStream, <span class="prelude-ty">Result</span>};
|
||||
|
||||
<span class="comment">// `struct Foo;`
|
||||
</span><span class="kw">pub struct </span>UnitStruct {
|
||||
struct_token: <span class="macro">Token!</span>[<span class="kw">struct</span>],
|
||||
ident: Ident,
|
||||
semi_token: <span class="macro">Token!</span>[;],
|
||||
}
|
||||
|
||||
<span class="kw">impl </span>Parse <span class="kw">for </span>UnitStruct {
|
||||
<span class="kw">fn </span>parse(input: ParseStream) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>> {
|
||||
<span class="kw">let </span>struct_token: <span class="macro">Token!</span>[<span class="kw">struct</span>] = input.parse()<span class="question-mark">?</span>;
|
||||
<span class="kw">let </span>ident: Ident = input.parse()<span class="question-mark">?</span>;
|
||||
<span class="kw">let </span>semi_token = input.parse::<<span class="macro">Token!</span>[;]>()<span class="question-mark">?</span>;
|
||||
<span class="prelude-val">Ok</span>(UnitStruct { struct_token, ident, semi_token })
|
||||
}
|
||||
}</code></pre></div>
|
||||
<p>As an expression, <code>Token!</code> is used for peeking tokens or instantiating
|
||||
tokens from a span.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">fn </span>make_unit_struct(name: Ident) -> UnitStruct {
|
||||
<span class="kw">let </span>span = name.span();
|
||||
UnitStruct {
|
||||
struct_token: <span class="macro">Token!</span>[<span class="kw">struct</span>](span),
|
||||
ident: name,
|
||||
semi_token: <span class="macro">Token!</span>[;](span),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">if </span>input.peek(<span class="macro">Token!</span>[<span class="kw">struct</span>]) {
|
||||
<span class="kw">let </span>unit_struct: UnitStruct = input.parse()<span class="question-mark">?</span>;
|
||||
<span class="comment">/* ... */
|
||||
</span>}</code></pre></div>
|
||||
<p>See the <a href="token/index.html" title="mod syn::token">token module</a> documentation for details and examples.</p>
|
||||
</div></details></section></div></main></body></html>
|
||||
Reference in New Issue
Block a user