Home Explore Help
Sign In
RONCC
/
HPC-Tools-for-Quantum-Computing
Watch 1
Star 0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: e971e022d2
Branches Tags
HPC-Tools-fo...
/
doc
/
syn
/
macro.keyword.html

macro.keyword.html 12 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950 
  1. <!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="API documentation for the Rust `keyword` macro in crate `syn`."><meta name="keywords" content="rust, rustlang, rust-lang, keyword"><title>syn::keyword - 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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></head><body class="rustdoc macro"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><div class="sidebar-elems"><p class='location'><a href='index.html'>syn</a></p><script>window.sidebarCurrent = {name: 'keyword', ty: 'macro', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="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=''>keyword</a></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'>&#x2212;</span>]</a></span><a class='srclink' href='../src/syn/token.rs.html#682-726' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class="rust macro">
    2. 

  2. <span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">keyword</span> {
    3. 

  3.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">as</span>) <span class="op">=&gt;</span> { ... };
    4. 

  4.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="ident">async</span>) <span class="op">=&gt;</span> { ... };
    5. 

  5.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="ident">auto</span>) <span class="op">=&gt;</span> { ... };
    6. 

  6.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">box</span>) <span class="op">=&gt;</span> { ... };
    7. 

  7.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">break</span>) <span class="op">=&gt;</span> { ... };
    8. 

  8.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="self">Self</span>) <span class="op">=&gt;</span> { ... };
    9. 

  9.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="ident">catch</span>) <span class="op">=&gt;</span> { ... };
    10. 

  10.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">const</span>) <span class="op">=&gt;</span> { ... };
    11. 

  11.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">continue</span>) <span class="op">=&gt;</span> { ... };
    12. 

  12.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">crate</span>) <span class="op">=&gt;</span> { ... };
    13. 

  13.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="ident">default</span>) <span class="op">=&gt;</span> { ... };
    14. 

  14.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">do</span>) <span class="op">=&gt;</span> { ... };
    15. 

  15.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="ident">dyn</span>) <span class="op">=&gt;</span> { ... };
    16. 

  16.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">else</span>) <span class="op">=&gt;</span> { ... };
    17. 

  17.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">enum</span>) <span class="op">=&gt;</span> { ... };
    18. 

  18.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">extern</span>) <span class="op">=&gt;</span> { ... };
    19. 

  19.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">fn</span>) <span class="op">=&gt;</span> { ... };
    20. 

  20.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">for</span>) <span class="op">=&gt;</span> { ... };
    21. 

  21.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">if</span>) <span class="op">=&gt;</span> { ... };
    22. 

  22.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">impl</span>) <span class="op">=&gt;</span> { ... };
    23. 

  23.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">in</span>) <span class="op">=&gt;</span> { ... };
    24. 

  24.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">let</span>) <span class="op">=&gt;</span> { ... };
    25. 

  25.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">loop</span>) <span class="op">=&gt;</span> { ... };
    26. 

  26.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">macro</span>) <span class="op">=&gt;</span> { ... };
    27. 

  27.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">match</span>) <span class="op">=&gt;</span> { ... };
    28. 

  28.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">mod</span>) <span class="op">=&gt;</span> { ... };
    29. 

  29.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">move</span>) <span class="op">=&gt;</span> { ... };
    30. 

  30.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw-2">mut</span>) <span class="op">=&gt;</span> { ... };
    31. 

  31.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">pub</span>) <span class="op">=&gt;</span> { ... };
    32. 

  32.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw-2">ref</span>) <span class="op">=&gt;</span> { ... };
    33. 

  33.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">return</span>) <span class="op">=&gt;</span> { ... };
    34. 

  34.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="self">self</span>) <span class="op">=&gt;</span> { ... };
    35. 

  35.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">static</span>) <span class="op">=&gt;</span> { ... };
    36. 

  36.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">struct</span>) <span class="op">=&gt;</span> { ... };
    37. 

  37.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">super</span>) <span class="op">=&gt;</span> { ... };
    38. 

  38.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">trait</span>) <span class="op">=&gt;</span> { ... };
    39. 

  39.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">type</span>) <span class="op">=&gt;</span> { ... };
    40. 

  40.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="ident">union</span>) <span class="op">=&gt;</span> { ... };
    41. 

  41.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">unsafe</span>) <span class="op">=&gt;</span> { ... };
    42. 

  42.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">use</span>) <span class="op">=&gt;</span> { ... };
    43. 

  43.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">where</span>) <span class="op">=&gt;</span> { ... };
    44. 

  44.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">while</span>) <span class="op">=&gt;</span> { ... };
    45. 

  45.     (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="kw">yield</span>) <span class="op">=&gt;</span> { ... };
    46. 

  46. }</pre>
    47. 

  47. </div><div class='docblock'><p>Parse a single Rust keyword token.</p>
    48. 

  48. <p>See the <a href="token/index.html">token module</a> documentation for details and examples.</p>
    49. 

  49. <p><em>This macro is available if Syn is built with the <code>&quot;parsing&quot;</code> feature.</em></p>
    50. 

  50. </div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "syn";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
    51.