mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-25 02:12:13 +00:00
46 lines
13 KiB
HTML
46 lines
13 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 `arg_enum` macro in crate `clap`."><meta name="keywords" content="rust, rustlang, rust-lang, arg_enum"><title>clap::arg_enum - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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><a href='../clap/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>clap</a></p><script>window.sidebarCurrent = {name: 'arg_enum', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/clap/macros.rs.html#307-408' title='goto source code'>[src]</a></span><span class='in-band'>Macro <a href='index.html'>clap</a>::<wbr><a class="macro" href=''>arg_enum</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><div class="example-wrap"><pre class="rust macro">
|
||
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">arg_enum</span> {
|
||
(@<span class="ident">as_item</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">item</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">impls</span> ( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tts</span>:<span class="ident">tt</span>)<span class="op">*</span> ) <span class="op">-</span><span class="op">></span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">e</span>:<span class="ident">ident</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">v</span>:<span class="ident">ident</span>),<span class="op">+</span>)) <span class="op">=</span><span class="op">></span> { ... };
|
||
($(<span class="attribute">#[$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">m</span>:<span class="ident">meta</span>),<span class="op">+</span>]</span>)<span class="op">+</span> <span class="kw">pub</span> <span class="kw">enum</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">e</span>:<span class="ident">ident</span> { $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">v</span>:<span class="ident">ident</span> $(<span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">val</span>:<span class="ident">expr</span>)<span class="kw-2">*</span>,)<span class="op">+</span> } ) <span class="op">=</span><span class="op">></span> { ... };
|
||
($(<span class="attribute">#[$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">m</span>:<span class="ident">meta</span>),<span class="op">+</span>]</span>)<span class="op">+</span> <span class="kw">pub</span> <span class="kw">enum</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">e</span>:<span class="ident">ident</span> { $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">v</span>:<span class="ident">ident</span> $(<span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">val</span>:<span class="ident">expr</span>)<span class="kw-2">*</span>),<span class="op">+</span> } ) <span class="op">=</span><span class="op">></span> { ... };
|
||
($(<span class="attribute">#[$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">m</span>:<span class="ident">meta</span>),<span class="op">+</span>]</span>)<span class="op">+</span> <span class="kw">enum</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">e</span>:<span class="ident">ident</span> { $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">v</span>:<span class="ident">ident</span> $(<span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">val</span>:<span class="ident">expr</span>)<span class="kw-2">*</span>,)<span class="op">+</span> } ) <span class="op">=</span><span class="op">></span> { ... };
|
||
($(<span class="attribute">#[$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">m</span>:<span class="ident">meta</span>),<span class="op">+</span>]</span>)<span class="op">+</span> <span class="kw">enum</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">e</span>:<span class="ident">ident</span> { $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">v</span>:<span class="ident">ident</span> $(<span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">val</span>:<span class="ident">expr</span>)<span class="kw-2">*</span>),<span class="op">+</span> } ) <span class="op">=</span><span class="op">></span> { ... };
|
||
(<span class="kw">pub</span> <span class="kw">enum</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">e</span>:<span class="ident">ident</span> { $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">v</span>:<span class="ident">ident</span> $(<span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">val</span>:<span class="ident">expr</span>)<span class="kw-2">*</span>,)<span class="op">+</span> } ) <span class="op">=</span><span class="op">></span> { ... };
|
||
(<span class="kw">pub</span> <span class="kw">enum</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">e</span>:<span class="ident">ident</span> { $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">v</span>:<span class="ident">ident</span> $(<span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">val</span>:<span class="ident">expr</span>)<span class="kw-2">*</span>),<span class="op">+</span> } ) <span class="op">=</span><span class="op">></span> { ... };
|
||
(<span class="kw">enum</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">e</span>:<span class="ident">ident</span> { $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">v</span>:<span class="ident">ident</span> $(<span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">val</span>:<span class="ident">expr</span>)<span class="kw-2">*</span>,)<span class="op">+</span> } ) <span class="op">=</span><span class="op">></span> { ... };
|
||
(<span class="kw">enum</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">e</span>:<span class="ident">ident</span> { $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">v</span>:<span class="ident">ident</span> $(<span class="op">=</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">val</span>:<span class="ident">expr</span>)<span class="kw-2">*</span>),<span class="op">+</span> } ) <span class="op">=</span><span class="op">></span> { ... };
|
||
}</pre></div>
|
||
</div><div class='docblock'><p>Convenience macro to generate more complete enums with variants to be used as a type when
|
||
parsing arguments. This enum also provides a <code>variants()</code> function which can be used to
|
||
retrieve a <code>Vec<&'static str></code> of the variant names, as well as implementing <a href="https://doc.rust-lang.org/std/str/trait.FromStr.html"><code>FromStr</code></a> and
|
||
<a href="https://doc.rust-lang.org/std/fmt/trait.Display.html"><code>Display</code></a> automatically.</p>
|
||
<p><strong>NOTE:</strong> Case insensitivity is supported for ASCII characters only. It's highly recommended to
|
||
use <a href="./struct.Arg.html#method.case_insensitive"><code>Arg::case_insensitive(true)</code></a> for args that will be used with these enums</p>
|
||
<p><strong>NOTE:</strong> This macro automatically implements <a href="https://doc.rust-lang.org/std/str/trait.FromStr.html"><code>std::str::FromStr</code></a> and <a href="https://doc.rust-lang.org/std/fmt/trait.Display.html"><code>std::fmt::Display</code></a></p>
|
||
<p><strong>NOTE:</strong> These enums support pub (or not) and uses of the <code>#[derive()]</code> traits</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="macro">arg_enum</span><span class="macro">!</span>{
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">PartialEq</span>, <span class="ident">Debug</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">Foo</span> {
|
||
<span class="ident">Bar</span>,
|
||
<span class="ident">Baz</span>,
|
||
<span class="ident">Qux</span>
|
||
}
|
||
}
|
||
<span class="comment">// Foo enum can now be used via Foo::Bar, or Foo::Baz, etc</span>
|
||
<span class="comment">// and implements std::str::FromStr to use with the value_t! macros</span>
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"app"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">from_usage</span>(<span class="string">"<foo> 'the foo'"</span>)
|
||
.<span class="ident">possible_values</span>(<span class="kw-2">&</span><span class="ident">Foo</span>::<span class="ident">variants</span>())
|
||
.<span class="ident">case_insensitive</span>(<span class="bool-val">true</span>))
|
||
.<span class="ident">get_matches_from</span>(<span class="macro">vec</span><span class="macro">!</span>[
|
||
<span class="string">"app"</span>, <span class="string">"baz"</span>
|
||
]);
|
||
<span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="macro">value_t</span><span class="macro">!</span>(<span class="ident">m</span>, <span class="string">"foo"</span>, <span class="ident">Foo</span>).<span class="ident">unwrap_or_else</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> <span class="ident">e</span>.<span class="ident">exit</span>());
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="ident">Foo</span>::<span class="ident">Baz</span>);
|
||
}</pre></div>
|
||
</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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "clap";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |