macro.not.html 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `not` macro in crate `synom`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, not">
  9. <title>synom::not - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
  14. <script src="../storage.js"></script>
  15. </head>
  16. <body class="rustdoc macro">
  17. <!--[if lte IE 8]>
  18. <div class="warning">
  19. This old browser is unsupported and will most likely display funky
  20. things.
  21. </div>
  22. <![endif]-->
  23. <nav class="sidebar">
  24. <div class="sidebar-menu">&#9776;</div>
  25. <p class='location'><a href='index.html'>synom</a></p><script>window.sidebarCurrent = {name: 'not', ty: 'macro', relpath: ''};</script><script defer src="sidebar-items.js"></script>
  26. </nav>
  27. <div class="theme-picker">
  28. <button id="theme-picker" aria-label="Pick another theme!">
  29. <img src="../brush.svg" width="18" alt="Pick another theme!">
  30. </button>
  31. <div id="theme-choices"></div>
  32. </div>
  33. <script src="../theme.js"></script>
  34. <nav class="sub">
  35. <form class="search-form js-only">
  36. <div class="search-container">
  37. <input class="search-input" name="search"
  38. autocomplete="off"
  39. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  40. type="search">
  41. </div>
  42. </form>
  43. </nav>
  44. <section id='main' class="content">
  45. <h1 class='fqn'><span class='in-band'>Macro <a href='index.html'>synom</a>::<wbr><a class="macro" href=''>not</a></span><span class='out-of-band'><span id='render-detail'>
  46. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  47. [<span class='inner'>&#x2212;</span>]
  48. </a>
  49. </span><a class='srclink' href='../src/synom/lib.rs.html#238-245' title='goto source code'>[src]</a></span></h1>
  50. <pre class="rust macro">
  51. <span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">not</span> {
  52. (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">submac</span>:<span class="macro">ident</span><span class="macro">!</span>( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">args</span>:<span class="ident">tt</span>)<span class="op">*</span> )) <span class="op">=&gt;</span> { ... };
  53. }</pre>
  54. <div class='docblock'><p>Parses successfully if the given parser fails to parse. Does not consume any
  55. of the input.</p>
  56. <ul>
  57. <li><strong>Syntax:</strong> <code>not!(THING)</code></li>
  58. <li><strong>Output:</strong> <code>()</code></li>
  59. </ul>
  60. <pre class="rust rust-example-rendered">
  61. <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">syn</span>;
  62. <span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">synom</span>;
  63. <span class="kw">use</span> <span class="ident">synom</span>::<span class="ident">IResult</span>;
  64. <span class="comment">// Parses a shebang line like `#!/bin/bash` and returns the part after `#!`.</span>
  65. <span class="comment">// Note that a line starting with `#![` is an inner attribute, not a</span>
  66. <span class="comment">// shebang.</span>
  67. <span class="macro">named</span><span class="macro">!</span>(<span class="ident">shebang</span> <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="ident">str</span>, <span class="macro">preceded</span><span class="macro">!</span>(
  68. <span class="macro">tuple</span><span class="macro">!</span>(<span class="macro">tag</span><span class="macro">!</span>(<span class="string">&quot;#!&quot;</span>), <span class="macro">not</span><span class="macro">!</span>(<span class="macro">tag</span><span class="macro">!</span>(<span class="string">&quot;[&quot;</span>))),
  69. <span class="macro">take_until</span><span class="macro">!</span>(<span class="string">&quot;\n&quot;</span>)
  70. ));
  71. <span class="kw">fn</span> <span class="ident">main</span>() {
  72. <span class="kw">let</span> <span class="ident">bin_bash</span> <span class="op">=</span> <span class="string">&quot;#!/bin/bash\n&quot;</span>;
  73. <span class="kw">let</span> <span class="ident">parsed</span> <span class="op">=</span> <span class="ident">shebang</span>(<span class="ident">bin_bash</span>).<span class="ident">expect</span>(<span class="string">&quot;shebang&quot;</span>);
  74. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">parsed</span>, <span class="string">&quot;/bin/bash&quot;</span>);
  75. <span class="kw">let</span> <span class="ident">inner_attr</span> <span class="op">=</span> <span class="string">&quot;#![feature(specialization)]\n&quot;</span>;
  76. <span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">shebang</span>(<span class="ident">inner_attr</span>);
  77. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">err</span>, <span class="ident">IResult</span>::<span class="ident">Error</span>);
  78. }</pre>
  79. </div></section>
  80. <section id='search' class="content hidden"></section>
  81. <section class="footer"></section>
  82. <aside id="help" class="hidden">
  83. <div>
  84. <h1 class="hidden">Help</h1>
  85. <div class="shortcuts">
  86. <h2>Keyboard Shortcuts</h2>
  87. <dl>
  88. <dt><kbd>?</kbd></dt>
  89. <dd>Show this help dialog</dd>
  90. <dt><kbd>S</kbd></dt>
  91. <dd>Focus the search field</dd>
  92. <dt><kbd>↑</kbd></dt>
  93. <dd>Move up in search results</dd>
  94. <dt><kbd>↓</kbd></dt>
  95. <dd>Move down in search results</dd>
  96. <dt><kbd>↹</kbd></dt>
  97. <dd>Switch tab</dd>
  98. <dt><kbd>&#9166;</kbd></dt>
  99. <dd>Go to active search result</dd>
  100. <dt><kbd>+</kbd></dt>
  101. <dd>Expand all sections</dd>
  102. <dt><kbd>-</kbd></dt>
  103. <dd>Collapse all sections</dd>
  104. </dl>
  105. </div>
  106. <div class="infos">
  107. <h2>Search Tricks</h2>
  108. <p>
  109. Prefix searches with a type followed by a colon (e.g.
  110. <code>fn:</code>) to restrict the search to a given type.
  111. </p>
  112. <p>
  113. Accepted types are: <code>fn</code>, <code>mod</code>,
  114. <code>struct</code>, <code>enum</code>,
  115. <code>trait</code>, <code>type</code>, <code>macro</code>,
  116. and <code>const</code>.
  117. </p>
  118. <p>
  119. Search functions by type signature (e.g.
  120. <code>vec -> usize</code> or <code>* -> vec</code>)
  121. </p>
  122. </div>
  123. </div>
  124. </aside>
  125. <script>
  126. window.rootPath = "../";
  127. window.currentCrate = "synom";
  128. </script>
  129. <script src="../main.js"></script>
  130. <script defer src="../search-index.js"></script>
  131. </body>
  132. </html>