Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -1,61 +1,59 @@
|
||||
<!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."><meta name="keywords" content="rust, rustlang, rust-lang, parse_quote"><title>parse_quote 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="parse_quote" 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="">parse_quote</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/parse_quote.rs.html#74-82" 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">parse_quote</span> {
|
||||
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||||
}</pre></div>
|
||||
</div><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
|
||||
<!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-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"><section id="rustdoc-toc"><h2 class="location"><a href="#">parse_<wbr>quote</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li><li><a href="#special-cases" title="Special cases">Special cases</a></li><li><a href="#panics" title="Panics">Panics</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate syn</a></h2></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">parse_quote</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/parse_quote.rs.html#80-84">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! parse_quote {
|
||||
($($tt:tt)*) => { ... };
|
||||
}</code></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"><code>Parse</code></a>
|
||||
<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">
|
||||
<span class="kw">use</span> <span class="ident">quote::quote</span>;
|
||||
<span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">parse_quote</span>, <span class="ident">Stmt</span>};
|
||||
<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> <span class="ident">main</span>() {
|
||||
<span class="kw">let</span> <span class="ident">name</span> <span class="op">=</span> <span class="macro">quote!</span>(<span class="ident">v</span>);
|
||||
<span class="kw">let</span> <span class="ident">ty</span> <span class="op">=</span> <span class="macro">quote!</span>(<span class="ident">u8</span>);
|
||||
<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> <span class="ident">stmt</span>: <span class="ident">Stmt</span> <span class="op">=</span> <span class="macro">parse_quote!</span> {
|
||||
<span class="kw">let</span> #<span class="ident">name</span>: #<span class="ident">ty</span> <span class="op">=</span> <span class="ident">Default::default</span>();
|
||||
<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>, <span class="ident">stmt</span>);
|
||||
}</pre></div>
|
||||
<p><em>This macro is available only if Syn is built with the <code>"parsing"</code> feature,
|
||||
although interpolation of syntax tree nodes into the quoted tokens is only
|
||||
supported if Syn is built with the <code>"printing"</code> feature as well.</em></p>
|
||||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||||
<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">
|
||||
<span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">parse_quote</span>, <span class="ident">Generics</span>, <span class="ident">GenericParam</span>};
|
||||
<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> <span class="ident">add_trait_bounds</span>(<span class="kw-2">mut</span> <span class="ident">generics</span>: <span class="ident">Generics</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Generics</span> {
|
||||
<span class="kw">for</span> <span class="ident">param</span> <span class="kw">in</span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">generics</span>.<span class="ident">params</span> {
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="ident">GenericParam::Type</span>(<span class="ident">type_param</span>) <span class="op">=</span> <span class="ident">param</span> {
|
||||
<span class="ident">type_param</span>.<span class="ident">bounds</span>.<span class="ident">push</span>(<span class="macro">parse_quote!</span>(<span class="ident">HeapSize</span>));
|
||||
<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));
|
||||
}
|
||||
}
|
||||
<span class="ident">generics</span>
|
||||
}</pre></div>
|
||||
<h1 id="special-cases" class="section-header"><a href="#special-cases">Special cases</a></h1>
|
||||
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="Attribute"><code>Attribute</code></a> — parses one attribute, allowing either outer like <code>#[...]</code>
|
||||
<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"><code>Punctuated<T, P></code></a> — parses zero or more <code>T</code> separated by punctuation
|
||||
<li><a href="struct.Attribute.html" title="struct syn::Attribute"><code>Vec<Attribute></code></a> — parses multiple attributes, including mixed kinds in
|
||||
any order</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"><code>Vec<Stmt></code></a> — parses the same as <code>Block::parse_within</code></li>
|
||||
<li><a href="struct.Arm.html" title="struct syn::Arm"><code>Vec<Arm></code></a> — parses arms separated by optional commas according to the
|
||||
same grammar as the inside of a <code>match</code> expression</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>
|
||||
<li><a href="enum.Pat.html#method.parse_multi_with_leading_vert" title="associated function syn::Pat::parse_multi_with_leading_vert"><code>Pat</code></a>, <a href="enum.Pat.html#method.parse_multi_with_leading_vert" title="associated function syn::Pat::parse_multi_with_leading_vert"><code>Box<Pat></code></a> — parses the same as
|
||||
<code>Pat::parse_multi_with_leading_vert</code></li>
|
||||
<li><a href="struct.Field.html" title="struct syn::Field"><code>Field</code></a> — parses a named or unnamed struct field</li>
|
||||
</ul>
|
||||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||||
<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></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>
|
||||
</div></details></section></div></main></body></html>
|
||||
Reference in New Issue
Block a user