mentat/docs/apis/rust/mentat_core/macro.interpose.html

139 lines
5.6 KiB
HTML
Raw Normal View History

2018-06-21 14:44:35 +00:00
<!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 `interpose` macro in crate `mentat_core`.">
<meta name="keywords" content="rust, rustlang, rust-lang, interpose">
<title>mentat_core::interpose - 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'>mentat_core</a></p><script>window.sidebarCurrent = {name: 'interpose', 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">
</div>
</form>
</nav>
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Macro <a href='index.html'>mentat_core</a>::<wbr><a class="macro" href=''>interpose</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>
2018-06-22 17:25:54 +00:00
</span><a class='srclink' href='../src/mentat_core/lib.rs.html#389-393' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class="rust macro">
2018-06-21 14:44:35 +00:00
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">interpose</span> {
( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>: <span class="ident">pat</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">across</span>: <span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">body</span>: <span class="ident">block</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">inter</span>: <span class="ident">block</span> ) <span class="op">=&gt;</span> { ... };
}</pre>
</div><div class='docblock'><p>A helper macro to sequentially process an iterable sequence,
evaluating a block between each pair of items.</p>
<p>This is used to simply and efficiently produce output like</p>
<pre><code class="language-sql"> 1, 2, 3
</code></pre>
<p>or</p>
<pre><code class="language-sql">x = 1 AND y = 2
</code></pre>
<p>without producing an intermediate string sequence.</p>
</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>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "mentat_core";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>