blob: 8f14f8de3090ceac37ee4bc1ab41fb4620405a31 [file] [log] [blame]
<!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="Convenience macro getting a typed value `Vec&lt;T&gt;` where `T` implements `std::str::FromStr` or exiting upon error."><meta name="keywords" content="rust, rustlang, rust-lang, values_t_or_exit"><title>values_t_or_exit in clap - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../clap/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../clap/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2><a href="index.html">In clap</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Macro <a href="index.html">clap</a>::<wbr><a class="macro" href="#">values_t_or_exit</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/clap/macros.rs.html#220-239">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules! </span>values_t_or_exit {
(<span class="macro-nonterminal">$m</span>:ident, <span class="macro-nonterminal">$v</span>:expr, <span class="macro-nonterminal">$t</span>:ty) =&gt; { ... };
(<span class="macro-nonterminal">$m</span>:ident.values_of(<span class="macro-nonterminal">$v</span>:expr), <span class="macro-nonterminal">$t</span>:ty) =&gt; { ... };
}</code></pre></div>
</div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Convenience macro getting a typed value <a href="https://doc.rust-lang.org/std/vec/struct.Vec.html"><code>Vec&lt;T&gt;</code></a> where <code>T</code> implements <a href="https://doc.rust-lang.org/std/str/trait.FromStr.html"><code>std::str::FromStr</code></a>
or exiting upon error.</p>
<p><strong>NOTE:</strong> This macro is for backwards compatibility sake. Prefer
<a href="./macro.values_t!.html"><code>values_t!(/* ... */).unwrap_or_else(|e| e.exit())</code></a></p>
<h2 id="examples"><a href="#examples">Examples</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>matches = App::new(<span class="string">&quot;myapp&quot;</span>)
.arg_from_usage(<span class="string">&quot;[seq]... &#39;A sequence of pos whole nums, i.e. 20 45&#39;&quot;</span>)
.get_matches();
<span class="kw">let </span>vals = <span class="macro">values_t_or_exit!</span>(matches.values_of(<span class="string">&quot;seq&quot;</span>), u32);
<span class="kw">for </span>v <span class="kw">in </span><span class="kw-2">&amp;</span>vals {
<span class="macro">println!</span>(<span class="string">&quot;{} + 2: {}&quot;</span>, v, v + <span class="number">2</span>);
}
<span class="comment">// type for example only
</span><span class="kw">let </span>vals: Vec&lt;u32&gt; = <span class="macro">values_t_or_exit!</span>(matches, <span class="string">&quot;seq&quot;</span>, u32);
<span class="kw">for </span>v <span class="kw">in </span><span class="kw-2">&amp;</span>vals {
<span class="macro">println!</span>(<span class="string">&quot;{} + 2: {}&quot;</span>, v, v + <span class="number">2</span>);
}</code></pre></div>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>