154 lines
7.2 KiB
HTML
154 lines
7.2 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="API documentation for the Rust `tag` macro in crate `synom`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, tag">
|
||
|
||
<title>synom::tag - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../normalize.css">
|
||
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../main.css">
|
||
|
||
|
||
|
||
|
||
</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">
|
||
|
||
<p class='location'><a href='index.html'>synom</a></p><script>window.sidebarCurrent = {name: 'tag', ty: 'macro', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<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=''>tag</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#732-740' 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">tag</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">tag</span>:<span class="ident">expr</span>) <span class="op">=></span> { ... };
|
||
}</pre>
|
||
<div class='docblock'><p>Parse the given string from exactly the current position in the input. You
|
||
almost always want <code>punct!</code> or <code>keyword!</code> instead of this.</p>
|
||
|
||
<p>The <code>tag!</code> parser is equivalent to <code>punct!</code> but does not ignore leading
|
||
whitespace. Both <code>punct!</code> and <code>keyword!</code> skip over leading whitespace. See
|
||
an explanation of synom's whitespace handling strategy in the top-level
|
||
crate documentation.</p>
|
||
|
||
<ul>
|
||
<li><strong>Syntax:</strong> <code>tag!("...")</code></li>
|
||
<li><strong>Output:</strong> <code>"..."</code></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">StrLit</span>;
|
||
<span class="kw">use</span> <span class="ident">syn</span>::<span class="ident">parse</span>::<span class="ident">string</span>;
|
||
<span class="kw">use</span> <span class="ident">synom</span>::<span class="ident">IResult</span>;
|
||
|
||
<span class="comment">// Parse a proposed syntax for an owned string literal: "abc"s</span>
|
||
<span class="macro">named</span><span class="macro">!</span>(<span class="ident">owned_string</span> <span class="op">-></span> <span class="ident">String</span>,
|
||
<span class="macro">map</span><span class="macro">!</span>(
|
||
<span class="macro">terminated</span><span class="macro">!</span>(<span class="ident">string</span>, <span class="macro">tag</span><span class="macro">!</span>(<span class="string">"s"</span>)),
|
||
<span class="op">|</span><span class="ident">lit</span>: <span class="ident">StrLit</span><span class="op">|</span> <span class="ident">lit</span>.<span class="ident">value</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">r#" "abc"s "#</span>;
|
||
<span class="kw">let</span> <span class="ident">parsed</span> <span class="op">=</span> <span class="ident">owned_string</span>(<span class="ident">input</span>).<span class="ident">expect</span>(<span class="string">"owned string literal"</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">r#" "abc" s "#</span>;
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">owned_string</span>(<span class="ident">input</span>);
|
||
<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>);
|
||
}</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>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt>+</dt>
|
||
<dd>Collapse/expand 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> |