mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-25 19:39:32 +01:00
29 lines
No EOL
5.1 KiB
HTML
29 lines
No EOL
5.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="Parse tokens of source code into the chosen syntax tree node."><title>parse 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-b0742ba02757f159.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.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-0111fcff984fae8f.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 fn"><!--[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"><section id="rustdoc-toc"><h2 class="location"><a href="#">parse</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</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>Function <span class="fn">parse</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/lib.rs.html#868-870">source</a> </span></div><pre class="rust item-decl"><code>pub fn parse<T: <a class="trait" href="parse/trait.Parse.html" title="trait syn::parse::Parse">Parse</a>>(tokens: <a class="struct" href="https://doc.rust-lang.org/1.83.0/proc_macro/struct.TokenStream.html" title="struct proc_macro::TokenStream">TokenStream</a>) -> <a class="type" href="parse/type.Result.html" title="type syn::parse::Result">Result</a><T></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parse tokens of source code into the chosen syntax tree node.</p>
|
||
<p>This is preferred over parsing a string because tokens are able to preserve
|
||
information about where in the user’s code they were originally written (the
|
||
“span” of the token), possibly allowing the compiler to produce better error
|
||
messages.</p>
|
||
<p>This function parses a <code>proc_macro::TokenStream</code> which is the type used for
|
||
interop with the compiler in a procedural macro. To parse a
|
||
<code>proc_macro2::TokenStream</code>, use <a href="fn.parse2.html" title="fn syn::parse2"><code>syn::parse2</code></a> instead.</p>
|
||
<p><em>This function is available only if Syn is built with both the <code>"parsing"</code> and
|
||
<code>"proc-macro"</code> features.</em></p>
|
||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
<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::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 tokens into a syntax tree
|
||
</span><span class="kw">let </span>ast: DeriveInput = syn::parse(input).unwrap();
|
||
|
||
<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">// Convert into a token stream and return it
|
||
</span>expanded.into()
|
||
}</code></pre></div>
|
||
</div></details></section></div></main></body></html> |