123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187 |
- <!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 `switch` macro in crate `synom`.">
- <meta name="keywords" content="rust, rustlang, rust-lang, switch">
- <title>synom::switch - 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="../main.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">☰</div>
-
- <p class='location'><a href='index.html'>synom</a></p><script>window.sidebarCurrent = {name: 'switch', ty: 'macro', relpath: ''};</script><script defer src="sidebar-items.js"></script>
- </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">
- </div>
- </form>
- </nav>
- <section id='main' class="content">
- <h1 class='fqn'><span class='in-band'>Macro <a href='index.html'>synom</a>::<wbr><a class="macro" href=''>switch</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'>−</span>]
- </a>
- </span><a class='srclink' href='../src/synom/lib.rs.html#799-811' title='goto source code'>[src]</a></span></h1>
- <pre class="rust macro">
- <span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">switch</span> {
- (<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="macro-nonterminal">$</span><span class="macro-nonterminal">p</span>:<span class="ident">pat</span> <span class="op">=></span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">subrule</span>:<span class="macro">ident</span><span class="macro">!</span>( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">args2</span>:<span class="ident">tt</span>)<span class="op">*</span> ))<span class="op">|</span><span class="op">*</span> ) <span class="op">=></span> { ... };
- }</pre>
- <div class='docblock'><p>Pattern-match the result of a parser to select which other parser to run.</p>
- <ul>
- <li><strong>Syntax:</strong> <code>switch!(TARGET, PAT1 => THEN1 | PAT2 => THEN2 | ...)</code></li>
- <li><strong>Output:</strong> <code>T</code>, the return type of <code>THEN1</code> and <code>THEN2</code> and ...</li>
- </ul>
- <pre class="rust rust-example-rendered">
- <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">syn</span>;
- <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>;
- <span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">Ident</span>, <span class="ident">Ty</span>};
- <span class="kw">use</span> <span class="ident">syn</span>::<span class="ident">parse</span>::{<span class="ident">ident</span>, <span class="ident">ty</span>};
- <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
- <span class="kw">enum</span> <span class="ident">UnitType</span> {
- <span class="ident">Struct</span> {
- <span class="ident">name</span>: <span class="ident">Ident</span>,
- },
- <span class="ident">Enum</span> {
- <span class="ident">name</span>: <span class="ident">Ident</span>,
- <span class="ident">variant</span>: <span class="ident">Ident</span>,
- },
- }
- <span class="comment">// Parse a unit struct or enum: either `struct S;` or `enum E { V }`.</span>
- <span class="macro">named</span><span class="macro">!</span>(<span class="ident">unit_type</span> <span class="op">-></span> <span class="ident">UnitType</span>, <span class="macro">do_parse</span><span class="macro">!</span>(
- <span class="ident">which</span>: <span class="macro">alt</span><span class="macro">!</span>(<span class="macro">keyword</span><span class="macro">!</span>(<span class="string">"struct"</span>) <span class="op">|</span> <span class="macro">keyword</span><span class="macro">!</span>(<span class="string">"enum"</span>)) <span class="op">>></span>
- <span class="ident">id</span>: <span class="ident">ident</span> <span class="op">>></span>
- <span class="ident">item</span>: <span class="macro">switch</span><span class="macro">!</span>(<span class="macro">value</span><span class="macro">!</span>(<span class="ident">which</span>),
- <span class="string">"struct"</span> <span class="op">=></span> <span class="macro">map</span><span class="macro">!</span>(
- <span class="macro">punct</span><span class="macro">!</span>(<span class="string">";"</span>),
- <span class="kw">move</span> <span class="op">|</span>_<span class="op">|</span> <span class="ident">UnitType</span>::<span class="ident">Struct</span> {
- <span class="ident">name</span>: <span class="ident">id</span>,
- }
- )
- <span class="op">|</span>
- <span class="string">"enum"</span> <span class="op">=></span> <span class="macro">map</span><span class="macro">!</span>(
- <span class="macro">delimited</span><span class="macro">!</span>(<span class="macro">punct</span><span class="macro">!</span>(<span class="string">"{"</span>), <span class="ident">ident</span>, <span class="macro">punct</span><span class="macro">!</span>(<span class="string">"}"</span>)),
- <span class="kw">move</span> <span class="op">|</span><span class="ident">variant</span><span class="op">|</span> <span class="ident">UnitType</span>::<span class="ident">Enum</span> {
- <span class="ident">name</span>: <span class="ident">id</span>,
- <span class="ident">variant</span>: <span class="ident">variant</span>,
- }
- )
- ) <span class="op">>></span>
- (<span class="ident">item</span>)
- ));
- <span class="kw">fn</span> <span class="ident">main</span>() {
- <span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"struct S;"</span>;
- <span class="kw">let</span> <span class="ident">parsed</span> <span class="op">=</span> <span class="ident">unit_type</span>(<span class="ident">input</span>).<span class="ident">expect</span>(<span class="string">"unit struct or enum"</span>);
- <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">parsed</span>);
- <span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"enum E { V }"</span>;
- <span class="kw">let</span> <span class="ident">parsed</span> <span class="op">=</span> <span class="ident">unit_type</span>(<span class="ident">input</span>).<span class="ident">expect</span>(<span class="string">"unit struct or enum"</span>);
- <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">parsed</span>);
- }</pre>
- </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>⏎</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>
- </div>
- </div>
- </aside>
-
- <script>
- window.rootPath = "../";
- window.currentCrate = "synom";
- </script>
- <script src="../main.js"></script>
- <script defer src="../search-index.js"></script>
- </body>
- </html>
|