Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -1,42 +1,36 @@
|
||||
<!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 given identifier as if it were a keyword."><meta name="keywords" content="rust, rustlang, rust-lang, custom_keyword"><title>custom_keyword 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="custom_keyword" 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="">custom_keyword</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/custom_keyword.rs.html#90-120" 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">custom_keyword</span> {
|
||||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ident</span>:<span class="ident">ident</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||||
}</pre></div>
|
||||
</div><div class="docblock"><p>Define a type that supports parsing and printing a given identifier as if it
|
||||
<!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 given identifier as if it were a keyword."><title>custom_keyword 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="#">custom_<wbr>keyword</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#usage" title="Usage">Usage</a></li><li><a href="#example" title="Example">Example</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">custom_keyword</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/custom_keyword.rs.html#90-123">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! custom_keyword {
|
||||
($ident:ident) => { ... };
|
||||
}</code></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 given identifier as if it
|
||||
were a keyword.</p>
|
||||
<h1 id="usage" class="section-header"><a href="#usage">Usage</a></h1>
|
||||
<h2 id="usage"><a class="doc-anchor" href="#usage">§</a>Usage</h2>
|
||||
<p>As a convention, it is recommended that this macro be invoked within a
|
||||
module called <code>kw</code> or <code>keyword</code> and that the resulting parser be invoked
|
||||
with a <code>kw::</code> or <code>keyword::</code> prefix.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">mod</span> <span class="ident">kw</span> {
|
||||
<span class="macro">syn::custom_keyword!</span>(<span class="ident">whatever</span>);
|
||||
}</pre></div>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">mod </span>kw {
|
||||
<span class="macro">syn::custom_keyword!</span>(whatever);
|
||||
}</code></pre></div>
|
||||
<p>The generated syntax tree node supports the following operations just like
|
||||
any built-in keyword token.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p><a href="parse/struct.ParseBuffer.html#method.peek">Peeking</a> — <code>input.peek(kw::whatever)</code></p>
|
||||
<p><a href="parse/struct.ParseBuffer.html#method.peek" title="method syn::parse::ParseBuffer::peek">Peeking</a> — <code>input.peek(kw::whatever)</code></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="parse/struct.ParseBuffer.html#method.parse">Parsing</a> — <code>input.parse::<kw::whatever>()?</code></p>
|
||||
<p><a href="parse/struct.ParseBuffer.html#method.parse" title="method syn::parse::ParseBuffer::parse">Parsing</a> — <code>input.parse::<kw::whatever>()?</code></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="../quote/to_tokens/trait.ToTokens.html">Printing</a> — <code>quote!( ... #whatever_token ... )</code></p>
|
||||
<p><a href="../quote/to_tokens/trait.ToTokens.html" title="trait quote::to_tokens::ToTokens">Printing</a> — <code>quote!( ... #whatever_token ... )</code></p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Construction from a <a href="../proc_macro2/struct.Span.html"><code>Span</code></a> — <code>let whatever_token = kw::whatever(sp)</code></p>
|
||||
<p>Construction from a <a href="../proc_macro2/struct.Span.html" title="struct proc_macro2::Span"><code>Span</code></a> — <code>let whatever_token = kw::whatever(sp)</code></p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Field access to its span — <code>let sp = whatever_token.span</code></p>
|
||||
</li>
|
||||
</ul>
|
||||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||||
<p>This example parses input that looks like <code>bool = true</code> or <code>str = "value"</code>.
|
||||
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
||||
<p>This example parses input that looks like <code>bool = true</code> or <code>str = "value"</code>.
|
||||
The key must be either the identifier <code>bool</code> or the identifier <code>str</code>. If
|
||||
<code>bool</code>, the value may be either <code>true</code> or <code>false</code>. If <code>str</code>, the value may
|
||||
be any string literal.</p>
|
||||
@@ -45,47 +39,45 @@ not considered keywords in the <code>syn::token</code> module. Like any other
|
||||
identifier that is not a keyword, these can be declared as custom keywords
|
||||
by crates that need to use them as such.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">LitBool</span>, <span class="ident">LitStr</span>, <span class="prelude-ty">Result</span>, <span class="ident">Token</span>};
|
||||
<span class="kw">use</span> <span class="ident">syn::parse</span>::{<span class="ident">Parse</span>, <span class="ident">ParseStream</span>};
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>syn::{LitBool, LitStr, <span class="prelude-ty">Result</span>, Token};
|
||||
<span class="kw">use </span>syn::parse::{Parse, ParseStream};
|
||||
|
||||
<span class="kw">mod</span> <span class="ident">kw</span> {
|
||||
<span class="macro">syn::custom_keyword!</span>(<span class="ident">bool</span>);
|
||||
<span class="macro">syn::custom_keyword!</span>(<span class="ident">str</span>);
|
||||
<span class="kw">mod </span>kw {
|
||||
<span class="macro">syn::custom_keyword!</span>(bool);
|
||||
<span class="macro">syn::custom_keyword!</span>(str);
|
||||
}
|
||||
|
||||
<span class="kw">enum</span> <span class="ident">Argument</span> {
|
||||
<span class="ident">Bool</span> {
|
||||
<span class="ident">bool_token</span>: <span class="ident">kw::bool</span>,
|
||||
<span class="ident">eq_token</span>: <span class="macro">Token!</span>[<span class="op">=</span>],
|
||||
<span class="ident">value</span>: <span class="ident">LitBool</span>,
|
||||
<span class="kw">enum </span>Argument {
|
||||
Bool {
|
||||
bool_token: kw::bool,
|
||||
eq_token: <span class="macro">Token!</span>[=],
|
||||
value: LitBool,
|
||||
},
|
||||
<span class="ident">Str</span> {
|
||||
<span class="ident">str_token</span>: <span class="ident">kw::str</span>,
|
||||
<span class="ident">eq_token</span>: <span class="macro">Token!</span>[<span class="op">=</span>],
|
||||
<span class="ident">value</span>: <span class="ident">LitStr</span>,
|
||||
Str {
|
||||
str_token: kw::str,
|
||||
eq_token: <span class="macro">Token!</span>[=],
|
||||
value: LitStr,
|
||||
},
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Parse</span> <span class="kw">for</span> <span class="ident">Argument</span> {
|
||||
<span class="kw">fn</span> <span class="ident">parse</span>(<span class="ident">input</span>: <span class="ident">ParseStream</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">lookahead</span> <span class="op">=</span> <span class="ident">input</span>.<span class="ident">lookahead1</span>();
|
||||
<span class="kw">if</span> <span class="ident">lookahead</span>.<span class="ident">peek</span>(<span class="ident">kw::bool</span>) {
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">Argument::Bool</span> {
|
||||
<span class="ident">bool_token</span>: <span class="ident">input</span>.<span class="ident">parse</span>::<span class="op"><</span><span class="ident">kw::bool</span><span class="op">></span>()<span class="question-mark">?</span>,
|
||||
<span class="ident">eq_token</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||||
<span class="ident">value</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||||
<span class="kw">impl </span>Parse <span class="kw">for </span>Argument {
|
||||
<span class="kw">fn </span>parse(input: ParseStream) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>> {
|
||||
<span class="kw">let </span>lookahead = input.lookahead1();
|
||||
<span class="kw">if </span>lookahead.peek(kw::bool) {
|
||||
<span class="prelude-val">Ok</span>(Argument::Bool {
|
||||
bool_token: input.parse::<kw::bool>()<span class="question-mark">?</span>,
|
||||
eq_token: input.parse()<span class="question-mark">?</span>,
|
||||
value: input.parse()<span class="question-mark">?</span>,
|
||||
})
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="ident">lookahead</span>.<span class="ident">peek</span>(<span class="ident">kw::str</span>) {
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">Argument::Str</span> {
|
||||
<span class="ident">str_token</span>: <span class="ident">input</span>.<span class="ident">parse</span>::<span class="op"><</span><span class="ident">kw::str</span><span class="op">></span>()<span class="question-mark">?</span>,
|
||||
<span class="ident">eq_token</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||||
<span class="ident">value</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||||
} <span class="kw">else if </span>lookahead.peek(kw::str) {
|
||||
<span class="prelude-val">Ok</span>(Argument::Str {
|
||||
str_token: input.parse::<kw::str>()<span class="question-mark">?</span>,
|
||||
eq_token: input.parse()<span class="question-mark">?</span>,
|
||||
value: input.parse()<span class="question-mark">?</span>,
|
||||
})
|
||||
} <span class="kw">else</span> {
|
||||
<span class="prelude-val">Err</span>(<span class="ident">lookahead</span>.<span class="ident">error</span>())
|
||||
} <span class="kw">else </span>{
|
||||
<span class="prelude-val">Err</span>(lookahead.error())
|
||||
}
|
||||
}
|
||||
}</pre></div>
|
||||
</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>
|
||||
}</code></pre></div>
|
||||
</div></details></section></div></main></body></html>
|
||||
Reference in New Issue
Block a user