156 lines
7.8 KiB
HTML
156 lines
7.8 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 `call` macro in crate `synom`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, call">
|
||
|
||
<title>synom::call - 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: 'call', 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=''>call</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#152-156' 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">call</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">fun</span>:<span class="ident">expr</span> $(, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">args</span>:<span class="ident">expr</span>)<span class="kw-2">*</span>) <span class="op">=></span> { ... };
|
||
}</pre>
|
||
<div class='docblock'><p>Invoke the given parser function with the passed in arguments.</p>
|
||
|
||
<ul>
|
||
<li><p><strong>Syntax:</strong> <code>call!(FUNCTION, ARGS...)</code></p>
|
||
|
||
<p>where the signature of the function is <code>fn(&str, ARGS...) -> IResult<&str, T></code></p></li>
|
||
<li><p><strong>Output:</strong> <code>T</code>, the result of invoking the function <code>FUNCTION</code></p></li>
|
||
</ul>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<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">synom</span>::<span class="ident">IResult</span>;
|
||
|
||
<span class="comment">// Parses any string up to but not including the given character, returning</span>
|
||
<span class="comment">// the content up to the given character. The given character is required to</span>
|
||
<span class="comment">// be present in the input string.</span>
|
||
<span class="kw">fn</span> <span class="ident">skip_until</span>(<span class="ident">input</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">ch</span>: <span class="ident">char</span>) <span class="op">-></span> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span>, <span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> {
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">pos</span>) <span class="op">=</span> <span class="ident">input</span>.<span class="ident">find</span>(<span class="ident">ch</span>) {
|
||
<span class="ident">IResult</span>::<span class="ident">Done</span>(<span class="kw-2">&</span><span class="ident">input</span>[<span class="ident">pos</span>..], <span class="kw-2">&</span><span class="ident">input</span>[..<span class="ident">pos</span>])
|
||
} <span class="kw">else</span> {
|
||
<span class="ident">IResult</span>::<span class="ident">Error</span>
|
||
}
|
||
}
|
||
|
||
<span class="comment">// Parses any string surrounded by tilde characters '~'. Returns the content</span>
|
||
<span class="comment">// between the tilde characters.</span>
|
||
<span class="macro">named</span><span class="macro">!</span>(<span class="ident">surrounded_by_tilde</span> <span class="op">-></span> <span class="kw-2">&</span><span class="ident">str</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="macro">call</span><span class="macro">!</span>(<span class="ident">skip_until</span>, <span class="string">'~'</span>),
|
||
<span class="macro">punct</span><span class="macro">!</span>(<span class="string">"~"</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">"~ abc def ~"</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">inner</span> <span class="op">=</span> <span class="ident">surrounded_by_tilde</span>(<span class="ident">input</span>).<span class="ident">expect</span>(<span class="string">"surrounded by tilde"</span>);
|
||
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">inner</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> |