mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-02 00:14:33 +01:00
52 lines
6.1 KiB
HTML
52 lines
6.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="Quasi-quotation macro that accepts input like the `quote!` macro but uses type inference to figure out a return type for those tokens."><title>parse_quote 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.89</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="#">parse_quote</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/parse_quote.rs.html#69-73">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> parse_quote {
|
||
|
|
($(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => { ... };
|
||
|
|
}</pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>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.</p>
|
||
|
|
<p>The return type can be any syntax tree node that implements the <a href="parse/trait.Parse.html" title="trait syn::parse::Parse"><code>Parse</code></a>
|
||
|
|
trait.</p>
|
||
|
|
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>quote::quote;
|
||
|
|
<span class="kw">use </span>syn::{parse_quote, Stmt};
|
||
|
|
|
||
|
|
<span class="kw">fn </span>main() {
|
||
|
|
<span class="kw">let </span>name = <span class="macro">quote!</span>(v);
|
||
|
|
<span class="kw">let </span>ty = <span class="macro">quote!</span>(u8);
|
||
|
|
|
||
|
|
<span class="kw">let </span>stmt: Stmt = <span class="macro">parse_quote!</span> {
|
||
|
|
<span class="kw">let </span>#name: #ty = Default::default();
|
||
|
|
};
|
||
|
|
|
||
|
|
<span class="macro">println!</span>(<span class="string">"{:#?}"</span>, stmt);
|
||
|
|
}</code></pre></div>
|
||
|
|
<p><em>This macro is available only if Syn is built with both the <code>"parsing"</code> and
|
||
|
|
<code>"printing"</code> features.</em></p>
|
||
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
||
|
|
<p>The following helper function adds a bound <code>T: HeapSize</code> to every type
|
||
|
|
parameter <code>T</code> in the input generics.</p>
|
||
|
|
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>syn::{parse_quote, Generics, GenericParam};
|
||
|
|
|
||
|
|
<span class="comment">// Add a bound `T: HeapSize` to every type parameter T.
|
||
|
|
</span><span class="kw">fn </span>add_trait_bounds(<span class="kw-2">mut </span>generics: Generics) -> Generics {
|
||
|
|
<span class="kw">for </span>param <span class="kw">in </span><span class="kw-2">&mut </span>generics.params {
|
||
|
|
<span class="kw">if let </span>GenericParam::Type(type_param) = param {
|
||
|
|
type_param.bounds.push(<span class="macro">parse_quote!</span>(HeapSize));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
generics
|
||
|
|
}</code></pre></div>
|
||
|
|
<h2 id="special-cases"><a class="doc-anchor" href="#special-cases">§</a>Special cases</h2>
|
||
|
|
<p>This macro can parse the following additional types as a special case even
|
||
|
|
though they do not implement the <code>Parse</code> trait.</p>
|
||
|
|
<ul>
|
||
|
|
<li><a href="struct.Attribute.html" title="struct syn::Attribute"><code>Attribute</code></a> — parses one attribute, allowing either outer like <code>#[...]</code>
|
||
|
|
or inner like <code>#![...]</code></li>
|
||
|
|
<li><a href="punctuated/struct.Punctuated.html" title="struct syn::punctuated::Punctuated"><code>Punctuated<T, P></code></a> — parses zero or more <code>T</code> separated by punctuation
|
||
|
|
<code>P</code> with optional trailing punctuation</li>
|
||
|
|
<li><a href="struct.Block.html#method.parse_within" title="associated function syn::Block::parse_within"><code>Vec<Stmt></code></a> — parses the same as <code>Block::parse_within</code></li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h2>
|
||
|
|
<p>Panics if the tokens fail to parse as the expected syntax tree type. The
|
||
|
|
caller is responsible for ensuring that the input tokens are syntactically
|
||
|
|
valid.</p>
|
||
|
|
</div></details></section></div></main></body></html>
|