mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-27 20:39:33 +01:00
73 lines
6.9 KiB
HTML
73 lines
6.9 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="Define a type that supports parsing and printing a multi-character symbol as if it were a punctuation token."><title>custom_punctuation 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="#">custom_punctuation</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/custom_punctuation.rs.html#78-109">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> custom_punctuation {
|
||
|
|
(<span class="macro-nonterminal">$ident</span>:ident, $(<span class="macro-nonterminal">$tt</span>:tt)+) => { ... };
|
||
|
|
}</pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Define a type that supports parsing and printing a multi-character symbol
|
||
|
|
as if it were a punctuation token.</p>
|
||
|
|
<h2 id="usage"><a class="doc-anchor" href="#usage">§</a>Usage</h2>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">syn::custom_punctuation!</span>(LeftRightArrow, <=>);</code></pre></div>
|
||
|
|
<p>The generated syntax tree node supports the following operations just like
|
||
|
|
any built-in punctuation token.</p>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<p><a href="parse/struct.ParseBuffer.html#method.peek" title="method syn::parse::ParseBuffer::peek">Peeking</a> — <code>input.peek(LeftRightArrow)</code></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><a href="parse/struct.ParseBuffer.html#method.parse" title="method syn::parse::ParseBuffer::parse">Parsing</a> — <code>input.parse::<LeftRightArrow>()?</code></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><a href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">Printing</a> — <code>quote!( ... #lrarrow ... )</code></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p>Construction from a <a href="../proc_macro2/struct.Span.html" title="struct proc_macro2::Span"><code>Span</code></a> — <code>let lrarrow = LeftRightArrow(sp)</code></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p>Construction from multiple <a href="../proc_macro2/struct.Span.html" title="struct proc_macro2::Span"><code>Span</code></a> — <code>let lrarrow = LeftRightArrow([sp, sp, sp])</code></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p>Field access to its spans — <code>let spans = lrarrow.spans</code></p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>proc_macro2::{TokenStream, TokenTree};
|
||
|
|
<span class="kw">use </span>syn::parse::{Parse, ParseStream, Peek, <span class="prelude-ty">Result</span>};
|
||
|
|
<span class="kw">use </span>syn::punctuated::Punctuated;
|
||
|
|
<span class="kw">use </span>syn::Expr;
|
||
|
|
|
||
|
|
<span class="macro">syn::custom_punctuation!</span>(PathSeparator, </>);
|
||
|
|
|
||
|
|
<span class="comment">// expr </> expr </> expr ...
|
||
|
|
</span><span class="kw">struct </span>PathSegments {
|
||
|
|
segments: Punctuated<Expr, PathSeparator>,
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="kw">impl </span>Parse <span class="kw">for </span>PathSegments {
|
||
|
|
<span class="kw">fn </span>parse(input: ParseStream) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>> {
|
||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>segments = Punctuated::new();
|
||
|
|
|
||
|
|
<span class="kw">let </span>first = parse_until(input, PathSeparator)<span class="question-mark">?</span>;
|
||
|
|
segments.push_value(syn::parse2(first)<span class="question-mark">?</span>);
|
||
|
|
|
||
|
|
<span class="kw">while </span>input.peek(PathSeparator) {
|
||
|
|
segments.push_punct(input.parse()<span class="question-mark">?</span>);
|
||
|
|
|
||
|
|
<span class="kw">let </span>next = parse_until(input, PathSeparator)<span class="question-mark">?</span>;
|
||
|
|
segments.push_value(syn::parse2(next)<span class="question-mark">?</span>);
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="prelude-val">Ok</span>(PathSegments { segments })
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="kw">fn </span>parse_until<E: Peek>(input: ParseStream, end: E) -> <span class="prelude-ty">Result</span><TokenStream> {
|
||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>tokens = TokenStream::new();
|
||
|
|
<span class="kw">while </span>!input.is_empty() && !input.peek(end) {
|
||
|
|
<span class="kw">let </span>next: TokenTree = input.parse()<span class="question-mark">?</span>;
|
||
|
|
tokens.extend(<span class="prelude-val">Some</span>(next));
|
||
|
|
}
|
||
|
|
<span class="prelude-val">Ok</span>(tokens)
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="kw">fn </span>main() {
|
||
|
|
<span class="kw">let </span>input = <span class="string">r#" a::b </> c::d::e "#</span>;
|
||
|
|
<span class="kw">let _</span>: PathSegments = syn::parse_str(input).unwrap();
|
||
|
|
}</code></pre></div>
|
||
|
|
</div></details></section></div></main></body></html>
|