mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-26 11:59:33 +01:00
142 lines
9.1 KiB
HTML
142 lines
9.1 KiB
HTML
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A 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-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="sidebar-items.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 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.85</span></h2></div><div class="sidebar-elems"></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>Macro <a href="index.html">syn</a>::<wbr><a class="macro" href="#">Token</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/token.rs.html#869-970">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><span class="macro">macro_rules!</span> Token {
|
||
|
|
[<span class="kw">abstract</span>] => { ... };
|
||
|
|
[<span class="kw">as</span>] => { ... };
|
||
|
|
[<span class="kw">async</span>] => { ... };
|
||
|
|
[auto] => { ... };
|
||
|
|
[<span class="kw">await</span>] => { ... };
|
||
|
|
[<span class="kw">become</span>] => { ... };
|
||
|
|
[<span class="kw">box</span>] => { ... };
|
||
|
|
[<span class="kw">break</span>] => { ... };
|
||
|
|
[<span class="kw">const</span>] => { ... };
|
||
|
|
[<span class="kw">continue</span>] => { ... };
|
||
|
|
[<span class="kw">crate</span>] => { ... };
|
||
|
|
[default] => { ... };
|
||
|
|
[<span class="kw">do</span>] => { ... };
|
||
|
|
[<span class="kw">dyn</span>] => { ... };
|
||
|
|
[<span class="kw">else</span>] => { ... };
|
||
|
|
[<span class="kw">enum</span>] => { ... };
|
||
|
|
[<span class="kw">extern</span>] => { ... };
|
||
|
|
[<span class="kw">final</span>] => { ... };
|
||
|
|
[<span class="kw">fn</span>] => { ... };
|
||
|
|
[<span class="kw">for</span>] => { ... };
|
||
|
|
[<span class="kw">if</span>] => { ... };
|
||
|
|
[<span class="kw">impl</span>] => { ... };
|
||
|
|
[<span class="kw">in</span>] => { ... };
|
||
|
|
[<span class="kw">let</span>] => { ... };
|
||
|
|
[<span class="kw">loop</span>] => { ... };
|
||
|
|
[<span class="kw">macro</span>] => { ... };
|
||
|
|
[<span class="kw">match</span>] => { ... };
|
||
|
|
[<span class="kw">mod</span>] => { ... };
|
||
|
|
[<span class="kw">move</span>] => { ... };
|
||
|
|
[<span class="kw-2">mut</span>] => { ... };
|
||
|
|
[<span class="kw">override</span>] => { ... };
|
||
|
|
[<span class="kw">priv</span>] => { ... };
|
||
|
|
[<span class="kw">pub</span>] => { ... };
|
||
|
|
[raw] => { ... };
|
||
|
|
[<span class="kw-2">ref</span>] => { ... };
|
||
|
|
[<span class="kw">return</span>] => { ... };
|
||
|
|
[<span class="self">Self</span>] => { ... };
|
||
|
|
[<span class="self">self</span>] => { ... };
|
||
|
|
[<span class="kw">static</span>] => { ... };
|
||
|
|
[<span class="kw">struct</span>] => { ... };
|
||
|
|
[<span class="kw">super</span>] => { ... };
|
||
|
|
[<span class="kw">trait</span>] => { ... };
|
||
|
|
[<span class="kw">try</span>] => { ... };
|
||
|
|
[<span class="kw">type</span>] => { ... };
|
||
|
|
[<span class="kw">typeof</span>] => { ... };
|
||
|
|
[union] => { ... };
|
||
|
|
[<span class="kw">unsafe</span>] => { ... };
|
||
|
|
[<span class="kw">unsized</span>] => { ... };
|
||
|
|
[<span class="kw">use</span>] => { ... };
|
||
|
|
[<span class="kw">virtual</span>] => { ... };
|
||
|
|
[<span class="kw">where</span>] => { ... };
|
||
|
|
[<span class="kw">while</span>] => { ... };
|
||
|
|
[<span class="kw">yield</span>] => { ... };
|
||
|
|
[<span class="kw-2">&</span>] => { ... };
|
||
|
|
[&&] => { ... };
|
||
|
|
[&=] => { ... };
|
||
|
|
[@] => { ... };
|
||
|
|
[^] => { ... };
|
||
|
|
[^=] => { ... };
|
||
|
|
[:] => { ... };
|
||
|
|
[,] => { ... };
|
||
|
|
[$] => { ... };
|
||
|
|
[.] => { ... };
|
||
|
|
[..] => { ... };
|
||
|
|
[...] => { ... };
|
||
|
|
[..=] => { ... };
|
||
|
|
[=] => { ... };
|
||
|
|
[==] => { ... };
|
||
|
|
[=>] => { ... };
|
||
|
|
[>=] => { ... };
|
||
|
|
[>] => { ... };
|
||
|
|
[<-] => { ... };
|
||
|
|
[<=] => { ... };
|
||
|
|
[<] => { ... };
|
||
|
|
[-] => { ... };
|
||
|
|
[-=] => { ... };
|
||
|
|
[!=] => { ... };
|
||
|
|
[!] => { ... };
|
||
|
|
[|] => { ... };
|
||
|
|
[|=] => { ... };
|
||
|
|
[||] => { ... };
|
||
|
|
[::] => { ... };
|
||
|
|
[%] => { ... };
|
||
|
|
[%=] => { ... };
|
||
|
|
[+] => { ... };
|
||
|
|
[+=] => { ... };
|
||
|
|
[#] => { ... };
|
||
|
|
[<span class="question-mark">?</span>] => { ... };
|
||
|
|
[->] => { ... };
|
||
|
|
[;] => { ... };
|
||
|
|
[<<] => { ... };
|
||
|
|
[<<=] => { ... };
|
||
|
|
[>>] => { ... };
|
||
|
|
[>>=] => { ... };
|
||
|
|
[/] => { ... };
|
||
|
|
[/=] => { ... };
|
||
|
|
[<span class="kw-2">*</span>] => { ... };
|
||
|
|
[<span class="kw-2">*</span>=] => { ... };
|
||
|
|
[~] => { ... };
|
||
|
|
[<span class="kw">_</span>] => { ... };
|
||
|
|
}</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>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>
|