greg/mentat
1
0
Fork 0
Code Issues 294 Pull requests Projects Releases 9 Packages Wiki Activity
mentat/docs/apis/rust/maplit/macro.convert_args.html
Emily Toop bb09064a5d Add docs to documentation site
2018-06-22 12:08:32 +01:00

181 lines
No EOL
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `convert_args` macro in crate `maplit`.">
<meta name="keywords" content="rust, rustlang, rust-lang, convert_args">
<title>maplit::convert_args - 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">&#9776;</div>
<p class='location'><a href='index.html'>maplit</a></p><script>window.sidebarCurrent = {name: 'convert_args', 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'>maplit</a>::<wbr><a class="macro" href=''>convert_args</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>
</span><a class='srclink' href='../src/maplit/lib.rs.html#219-252' 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">convert_args</span> {
(<span class="ident">keys</span><span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">kf</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">macro_name</span>:<span class="ident">ident</span> <span class="op">!</span>($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">k</span>:<span class="ident">expr</span>),<span class="op">*</span> $(,)<span class="kw-2">*</span>)) <span class="op">=&gt;</span> { ... };
(<span class="ident">keys</span><span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">kf</span>:<span class="ident">expr</span>, <span class="ident">values</span><span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">vf</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">macro_name</span>:<span class="ident">ident</span> <span class="op">!</span>($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">k</span>:<span class="ident">expr</span>),<span class="op">*</span> $(,)<span class="kw-2">*</span>)) <span class="op">=&gt;</span> { ... };
(<span class="ident">keys</span><span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">kf</span>:<span class="ident">expr</span>, <span class="ident">values</span><span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">vf</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">macro_name</span>:<span class="ident">ident</span> <span class="op">!</span>( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">k</span>:<span class="ident">expr</span> <span class="op">=&gt;</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">v</span>:<span class="ident">expr</span>),<span class="op">*</span> $(,)<span class="kw-2">*</span>)) <span class="op">=&gt;</span> { ... };
(<span class="ident">keys</span><span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">kf</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">macro_name</span>:<span class="ident">ident</span> <span class="op">!</span>($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">rest</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>)) <span class="op">=&gt;</span> { ... };
(<span class="ident">values</span><span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">vf</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">macro_name</span>:<span class="ident">ident</span> <span class="op">!</span>($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">rest</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>)) <span class="op">=&gt;</span> { ... };
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">macro_name</span>:<span class="ident">ident</span> <span class="op">!</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">rest</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> { ... };
}</pre>
<div class='docblock'><p>Macro that converts the keys or key-value pairs passed to another maplit
macro. The default conversion is to use the <a href="https://doc.rust-lang.org/std/convert/trait.Into.html"><code>Into</code></a> trait, if no
custom conversion is passed.</p>
<p>The syntax is:</p>
<p><code>convert_args!(</code> <code>keys=</code> <em>function</em> <code>,</code> <code>values=</code> <em>function</em> <code>,</code>
<em>macro_name</em> <code>!(</code> [ <em>key</em> =&gt; <em>value</em> [, <em>key</em> =&gt; <em>value</em> ... ] ] <code>))</code></p>
<p>Here <em>macro_name</em> is any other maplit macro and either or both of the
explicit <code>keys=</code> and <code>values=</code> parameters can be omitted.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<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">maplit</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">collections</span>::<span class="ident">HashMap</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">collections</span>::<span class="ident">BTreeSet</span>;
<span class="comment">// a. Use the default conversion with the Into trait.</span>
<span class="comment">// Here this converts both the key and value string literals to `String`,</span>
<span class="comment">// but we need to specify the map type exactly!</span>
<span class="kw">let</span> <span class="ident">map1</span>: <span class="ident">HashMap</span><span class="op">&lt;</span><span class="ident">String</span>, <span class="ident">String</span><span class="op">&gt;</span> <span class="op">=</span> <span class="macro">convert_args</span><span class="macro">!</span>(<span class="macro">hashmap</span><span class="macro">!</span>(
<span class="string">&quot;a&quot;</span> <span class="op">=&gt;</span> <span class="string">&quot;b&quot;</span>,
<span class="string">&quot;c&quot;</span> <span class="op">=&gt;</span> <span class="string">&quot;d&quot;</span>,
));
<span class="comment">// b. Specify an explicit custom conversion for the keys. If we don&#39;t specify</span>
<span class="comment">// a conversion for the values, they are not converted at all.</span>
<span class="kw">let</span> <span class="ident">map2</span> <span class="op">=</span> <span class="macro">convert_args</span><span class="macro">!</span>(<span class="ident">keys</span><span class="op">=</span><span class="ident">String</span>::<span class="ident">from</span>, <span class="macro">hashmap</span><span class="macro">!</span>(
<span class="string">&quot;a&quot;</span> <span class="op">=&gt;</span> <span class="number">1</span>,
<span class="string">&quot;c&quot;</span> <span class="op">=&gt;</span> <span class="number">2</span>,
));
<span class="comment">// Note: map2 is a HashMap&lt;String, i32&gt;, but we didn&#39;t need to specify the type</span>
<span class="kw">let</span> _: <span class="ident">HashMap</span><span class="op">&lt;</span><span class="ident">String</span>, <span class="ident">i32</span><span class="op">&gt;</span> <span class="op">=</span> <span class="ident">map2</span>;
<span class="comment">// c. convert_args! works with all the maplit macros -- and macros from other</span>
<span class="comment">// crates that have the same &quot;signature&quot;.</span>
<span class="comment">// For example, btreeset and conversion from &amp;str to Vec&lt;u8&gt;.</span>
<span class="kw">let</span> <span class="ident">set</span>: <span class="ident">BTreeSet</span><span class="op">&lt;</span><span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;&gt;</span> <span class="op">=</span> <span class="macro">convert_args</span><span class="macro">!</span>(<span class="macro">btreeset</span><span class="macro">!</span>(
<span class="string">&quot;a&quot;</span>, <span class="string">&quot;b&quot;</span>, <span class="string">&quot;c&quot;</span>, <span class="string">&quot;d&quot;</span>, <span class="string">&quot;a&quot;</span>, <span class="string">&quot;e&quot;</span>, <span class="string">&quot;f&quot;</span>,
));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">set</span>.<span class="ident">len</span>(), <span class="number">6</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>&#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 = "maplit";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink