343 lines
89 KiB
HTML
343 lines
89 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="Parse/validate argument values"><meta name="keywords" content="rust, rustlang, rust-lang, ValueParser"><title>ValueParser in clap::builder - 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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" 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 struct"><!--[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">☰</button><a class="sidebar-logo" href="../../clap/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../clap/index.html"><div class="logo-container">
|
||
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a><h2 class="location"><a href="#">ValueParser</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul><li><a href="#method.bool">bool</a></li><li><a href="#method.new">new</a></li><li><a href="#method.os_string">os_string</a></li><li><a href="#method.path_buf">path_buf</a></li><li><a href="#method.possible_values">possible_values</a></li><li><a href="#method.string">string</a></li><li><a href="#method.type_id">type_id</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><ul><li><a href="#impl-Clone-for-ValueParser">Clone</a></li><li><a href="#impl-Debug-for-ValueParser">Debug</a></li><li><a href="#impl-From%3C%5BP%3B%20C%5D%3E-for-ValueParser">From<[P; C]></a></li><li><a href="#impl-From%3CP%3E-for-ValueParser">From<P></a></li><li><a href="#impl-From%3CRange%3Ci64%3E%3E-for-ValueParser">From<Range<i64>></a></li><li><a href="#impl-From%3CRangeFrom%3Ci64%3E%3E-for-ValueParser">From<RangeFrom<i64>></a></li><li><a href="#impl-From%3CRangeFull%3E-for-ValueParser">From<RangeFull></a></li><li><a href="#impl-From%3CRangeInclusive%3Ci64%3E%3E-for-ValueParser">From<RangeInclusive<i64>></a></li><li><a href="#impl-From%3CRangeTo%3Ci64%3E%3E-for-ValueParser">From<RangeTo<i64>></a></li><li><a href="#impl-From%3CRangeToInclusive%3Ci64%3E%3E-for-ValueParser">From<RangeToInclusive<i64>></a></li><li><a href="#impl-From%3CVec%3CP%2C%20Global%3E%3E-for-ValueParser">From<Vec<P, Global>></a></li><li><a href="#impl-IntoResettable%3CValueParser%3E-for-I">IntoResettable<ValueParser></a></li><li><a href="#impl-IntoResettable%3CValueParser%3E-for-Option%3CValueParser%3E">IntoResettable<ValueParser></a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul><li><a href="#impl-RefUnwindSafe-for-ValueParser">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-ValueParser">Send</a></li><li><a href="#impl-Sync-for-ValueParser">Sync</a></li><li><a href="#impl-Unpin-for-ValueParser">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ValueParser">!UnwindSafe</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><ul><li><a href="#impl-Any-for-ValueParser">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ValueParser">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ValueParser">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-ValueParser">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-ValueParser">Into<U></a></li><li><a href="#impl-ToOwned-for-ValueParser">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-ValueParser">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-ValueParser">TryInto<U></a></li></ul></div></section><h2 class="location"><a href="index.html">In clap::builder</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../clap/index.html">
|
||
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Struct <a href="../index.html">clap</a>::<wbr><a href="index.html">builder</a>::<wbr><a class="struct" href="#">ValueParser</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></span></h1><span class="out-of-band"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#59">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust struct"><code>pub struct ValueParser(_);</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parse/validate argument values</p>
|
||
<p>Specified with <a href="struct.Arg.html#method.value_parser" title="crate::Arg::value_parser"><code>Arg::value_parser</code></a>.</p>
|
||
<p><code>ValueParser</code> defines how to convert a raw argument value into a validated and typed value for
|
||
use within an application.</p>
|
||
<p>See</p>
|
||
<ul>
|
||
<li><a href="../macro.value_parser.html" title="crate::value_parser"><code>value_parser!</code></a> for automatically selecting an implementation for a given type</li>
|
||
<li><a href="struct.ValueParser.html#method.new" title="ValueParser::new"><code>ValueParser::new</code></a> for additional <a href="trait.TypedValueParser.html" title="TypedValueParser"><code>TypedValueParser</code></a> that can be used</li>
|
||
</ul>
|
||
<h2 id="example"><a href="#example">Example</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">clap::Command::new</span>(<span class="string">"raw"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">value_parser</span>([<span class="string">"always"</span>, <span class="string">"auto"</span>, <span class="string">"never"</span>])
|
||
.<span class="ident">default_value</span>(<span class="string">"auto"</span>)
|
||
)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"hostname"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"hostname"</span>)
|
||
.<span class="ident">value_parser</span>(<span class="ident">clap::builder::NonEmptyStringValueParser::new</span>())
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Set</span>)
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>)
|
||
)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">value_parser</span>(<span class="macro">clap::value_parser!</span>(<span class="ident">u16</span>).<span class="ident">range</span>(<span class="number">3000</span>..))
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Set</span>)
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>(
|
||
[<span class="string">"cmd"</span>, <span class="string">"--hostname"</span>, <span class="string">"rust-lang.org"</span>, <span class="string">"--port"</span>, <span class="string">"3001"</span>]
|
||
).<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">color</span>: <span class="kw-2">&</span><span class="ident">String</span> <span class="op">=</span> <span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"default"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">color</span>, <span class="string">"auto"</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">hostname</span>: <span class="kw-2">&</span><span class="ident">String</span> <span class="op">=</span> <span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"hostname"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"required"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">hostname</span>, <span class="string">"rust-lang.org"</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">port</span>: <span class="ident">u16</span> <span class="op">=</span> <span class="kw-2">*</span><span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"required"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">port</span>, <span class="number">3001</span>);</code></pre></div>
|
||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#73-219">source</a></span><a href="#impl-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#107-112">source</a></span><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a><P>(other: P) -> Self <span class="where fmt-newline">where<br> P: <a class="trait" href="trait.TypedValueParser.html" title="trait clap::builder::TypedValueParser">TypedValueParser</a>, </span></h4></section></summary><div class="docblock"><p>Custom parser for argument values</p>
|
||
<p>Pre-existing <a href="trait.TypedValueParser.html" title="TypedValueParser"><code>TypedValueParser</code></a> implementations include:</p>
|
||
<ul>
|
||
<li><code>Fn(&str) -> Result<T, E></code></li>
|
||
<li><a href="struct.EnumValueParser.html" title="EnumValueParser"><code>EnumValueParser</code></a> and <a href="struct.PossibleValuesParser.html" title="PossibleValuesParser"><code>PossibleValuesParser</code></a> for static enumerated values</li>
|
||
<li><a href="struct.BoolishValueParser.html" title="BoolishValueParser"><code>BoolishValueParser</code></a> and <a href="struct.FalseyValueParser.html" title="FalseyValueParser"><code>FalseyValueParser</code></a> for alternative <code>bool</code> implementations</li>
|
||
<li><a href="struct.RangedI64ValueParser.html" title="RangedI64ValueParser"><code>RangedI64ValueParser</code></a> and <a href="struct.RangedU64ValueParser.html" title="RangedU64ValueParser"><code>RangedU64ValueParser</code></a></li>
|
||
<li><a href="struct.NonEmptyStringValueParser.html" title="NonEmptyStringValueParser"><code>NonEmptyStringValueParser</code></a></li>
|
||
</ul>
|
||
<h5 id="example-1"><a href="#example-1">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">type</span> <span class="ident">EnvVar</span> <span class="op">=</span> (<span class="ident">String</span>, <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>);
|
||
<span class="kw">fn</span> <span class="ident">parse_env_var</span>(<span class="ident">env</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">EnvVar</span>, <span class="ident">std::io::Error</span><span class="op">></span> {
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>((<span class="ident">var</span>, <span class="ident">value</span>)) <span class="op">=</span> <span class="ident">env</span>.<span class="ident">split_once</span>(<span class="string">'='</span>) {
|
||
<span class="prelude-val">Ok</span>((<span class="ident">var</span>.<span class="ident">to_owned</span>(), <span class="prelude-val">Some</span>(<span class="ident">value</span>.<span class="ident">to_owned</span>())))
|
||
} <span class="kw">else</span> {
|
||
<span class="prelude-val">Ok</span>((<span class="ident">env</span>.<span class="ident">to_owned</span>(), <span class="prelude-val">None</span>))
|
||
}
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">clap::Command::new</span>(<span class="string">"raw"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"env"</span>)
|
||
.<span class="ident">value_parser</span>(<span class="ident">clap::builder::ValueParser::new</span>(<span class="ident">parse_env_var</span>))
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>([<span class="string">"cmd"</span>, <span class="string">"key=value"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">port</span>: <span class="kw-2">&</span><span class="ident">EnvVar</span> <span class="op">=</span> <span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"env"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"required"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span><span class="ident">port</span>, (<span class="string">"key"</span>.<span class="ident">into</span>(), <span class="prelude-val">Some</span>(<span class="string">"value"</span>.<span class="ident">into</span>())));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.bool" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#137-139">source</a></span><h4 class="code-header">pub const fn <a href="#method.bool" class="fnname">bool</a>() -> Self</h4></section></summary><div class="docblock"><p><a href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html" title="bool"><code>bool</code></a> parser for argument values</p>
|
||
<p>See also:</p>
|
||
<ul>
|
||
<li><a href="struct.BoolishValueParser.html" title="BoolishValueParser"><code>BoolishValueParser</code></a> for different human readable bool representations</li>
|
||
<li><a href="struct.FalseyValueParser.html" title="FalseyValueParser"><code>FalseyValueParser</code></a> for assuming non-false is true</li>
|
||
</ul>
|
||
<h5 id="example-2"><a href="#example-2">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">clap::Command::new</span>(<span class="string">"raw"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"download"</span>)
|
||
.<span class="ident">value_parser</span>(<span class="macro">clap::value_parser!</span>(<span class="ident">bool</span>))
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>([<span class="string">"cmd"</span>, <span class="string">"true"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">port</span>: <span class="ident">bool</span> <span class="op">=</span> <span class="kw-2">*</span><span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"download"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"required"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">port</span>, <span class="bool-val">true</span>);
|
||
|
||
<span class="macro">assert!</span>(<span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>([<span class="string">"cmd"</span>, <span class="string">"forever"</span>]).<span class="ident">is_err</span>());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.string" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#161-163">source</a></span><h4 class="code-header">pub const fn <a href="#method.string" class="fnname">string</a>() -> Self</h4></section></summary><div class="docblock"><p><a href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="String"><code>String</code></a> parser for argument values</p>
|
||
<p>See also:</p>
|
||
<ul>
|
||
<li><a href="struct.NonEmptyStringValueParser.html" title="NonEmptyStringValueParser"><code>NonEmptyStringValueParser</code></a></li>
|
||
</ul>
|
||
<h5 id="example-3"><a href="#example-3">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">clap::Command::new</span>(<span class="string">"raw"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">value_parser</span>(<span class="macro">clap::value_parser!</span>(<span class="ident">String</span>))
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>([<span class="string">"cmd"</span>, <span class="string">"80"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">port</span>: <span class="kw-2">&</span><span class="ident">String</span> <span class="op">=</span> <span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"required"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">port</span>, <span class="string">"80"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.os_string" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#191-193">source</a></span><h4 class="code-header">pub const fn <a href="#method.os_string" class="fnname">os_string</a>() -> Self</h4></section></summary><div class="docblock"><p><a href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsString.html" title="std::ffi::OsString"><code>OsString</code></a> parser for argument values</p>
|
||
<h5 id="example-4"><a href="#example-4">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::ffi::OsString</span>;
|
||
<span class="kw">use</span> <span class="ident">std::os::unix::ffi</span>::{<span class="ident">OsStrExt</span>,<span class="ident">OsStringExt</span>};
|
||
<span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"myprog"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">Arg::new</span>(<span class="string">"arg"</span>)
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>)
|
||
.<span class="ident">value_parser</span>(<span class="ident">ValueParser::os_string</span>())
|
||
)
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[
|
||
<span class="ident">OsString::from</span>(<span class="string">"myprog"</span>),
|
||
<span class="ident">OsString::from_vec</span>(<span class="macro">vec!</span>[<span class="number">0xe9</span>])
|
||
]);
|
||
|
||
<span class="macro">assert!</span>(<span class="ident">r</span>.<span class="ident">is_ok</span>());
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">r</span>.<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">arg</span>: <span class="kw-2">&</span><span class="ident">OsString</span> <span class="op">=</span> <span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"arg"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"required"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">arg</span>.<span class="ident">as_bytes</span>(), <span class="kw-2">&</span>[<span class="number">0xe9</span>]);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.path_buf" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#216-218">source</a></span><h4 class="code-header">pub const fn <a href="#method.path_buf" class="fnname">path_buf</a>() -> Self</h4></section></summary><div class="docblock"><p><a href="https://doc.rust-lang.org/1.64.0/std/path/struct.PathBuf.html" title="std::path::PathBuf"><code>PathBuf</code></a> parser for argument values</p>
|
||
<h5 id="example-5"><a href="#example-5">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">clap::Command::new</span>(<span class="string">"raw"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"output"</span>)
|
||
.<span class="ident">value_parser</span>(<span class="macro">clap::value_parser!</span>(<span class="ident">PathBuf</span>))
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>([<span class="string">"cmd"</span>, <span class="string">"hello.txt"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">port</span>: <span class="kw-2">&</span><span class="ident">PathBuf</span> <span class="op">=</span> <span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"output"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"required"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">port</span>, <span class="ident">Path::new</span>(<span class="string">"hello.txt"</span>));
|
||
|
||
<span class="macro">assert!</span>(<span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>([<span class="string">"cmd"</span>, <span class="string">""</span>]).<span class="ident">is_err</span>());</code></pre></div>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ValueParser-1" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#221-258">source</a></span><a href="#impl-ValueParser-1" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#235-237">source</a></span><h4 class="code-header">pub fn <a href="#method.type_id" class="fnname">type_id</a>(&self) -> AnyValueId</h4></section></summary><div class="docblock"><p>Describes the content of <code>AnyValue</code></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.possible_values" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#243-247">source</a></span><h4 class="code-header">pub fn <a href="#method.possible_values" class="fnname">possible_values</a>(<br> &self<br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = <a class="struct" href="struct.PossibleValue.html" title="struct clap::builder::PossibleValue">PossibleValue</a>> + '_>></h4></section></summary><div class="docblock"><p>Reflect on enumerated value properties</p>
|
||
<p>Error checking should not be done with this; it is mostly targeted at user-facing
|
||
applications like errors and completion.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#558-568">source</a></span><a href="#impl-Clone-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#559-567">source</a></span><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> Self</h4></section></summary><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/clone.rs.html#132-134">source</a></span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>Self)</h4></section></summary><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#546-556">source</a></span><a href="#impl-Debug-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#547-555">source</a></span><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></h4></section></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3C%5BP%3B%20C%5D%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#501-509">source</a></span><a href="#impl-From%3C%5BP%3B%20C%5D%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl<P, const C: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.array.html">[</a>P<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.array.html">; C]</a>> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a> <span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="struct.PossibleValue.html" title="struct clap::builder::PossibleValue">PossibleValue</a>>, </span></h3></section></summary><div class="docblock"><p>Create a <a href="struct.ValueParser.html" title="ValueParser"><code>ValueParser</code></a> with <a href="struct.PossibleValuesParser.html" title="PossibleValuesParser"><code>PossibleValuesParser</code></a></p>
|
||
<p>See <a href="struct.PossibleValuesParser.html" title="PossibleValuesParser"><code>PossibleValuesParser</code></a> for more flexibility in creating the
|
||
<a href="struct.PossibleValue.html" title="crate::builder::PossibleValue"><code>PossibleValue</code></a>s.</p>
|
||
<h4 id="examples-6"><a href="#examples-6">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">clap::Command::new</span>(<span class="string">"raw"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">value_parser</span>([<span class="string">"always"</span>, <span class="string">"auto"</span>, <span class="string">"never"</span>])
|
||
.<span class="ident">default_value</span>(<span class="string">"auto"</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>(
|
||
[<span class="string">"cmd"</span>, <span class="string">"--color"</span>, <span class="string">"never"</span>]
|
||
).<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">color</span>: <span class="kw-2">&</span><span class="ident">String</span> <span class="op">=</span> <span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"default"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">color</span>, <span class="string">"never"</span>);</code></pre></div>
|
||
</div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-7" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#505-508">source</a></span><a href="#method.from-7" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(values: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.array.html">[</a>P<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.array.html">; C]</a>) -> Self</h4></section></summary><div class='docblock'><p>Converts to this type from the input type.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CP%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#282-289">source</a></span><a href="#impl-From%3CP%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl<P> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><P> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a> <span class="where fmt-newline">where<br> P: <a class="trait" href="trait.TypedValueParser.html" title="trait clap::builder::TypedValueParser">TypedValueParser</a> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static, </span></h3></section></summary><div class="docblock"><p>Convert a <a href="trait.TypedValueParser.html" title="TypedValueParser"><code>TypedValueParser</code></a> to <a href="struct.ValueParser.html" title="ValueParser"><code>ValueParser</code></a></p>
|
||
<h4 id="example-6"><a href="#example-6">Example</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">clap::Command::new</span>(<span class="string">"raw"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"hostname"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"hostname"</span>)
|
||
.<span class="ident">value_parser</span>(<span class="ident">clap::builder::NonEmptyStringValueParser::new</span>())
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Set</span>)
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>(
|
||
[<span class="string">"cmd"</span>, <span class="string">"--hostname"</span>, <span class="string">"rust-lang.org"</span>]
|
||
).<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">hostname</span>: <span class="kw-2">&</span><span class="ident">String</span> <span class="op">=</span> <span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"hostname"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"required"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">hostname</span>, <span class="string">"rust-lang.org"</span>);</code></pre></div>
|
||
</div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#286-288">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(p: P) -> Self</h4></section></summary><div class='docblock'><p>Converts to this type from the input type.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CRange%3Ci64%3E%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#320-325">source</a></span><a href="#impl-From%3CRange%3Ci64%3E%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i64.html">i64</a>>> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section></summary><div class="docblock"><p>Create an <code>i64</code> <a href="struct.ValueParser.html" title="ValueParser"><code>ValueParser</code></a> from a <code>N..M</code> range</p>
|
||
<p>See <a href="struct.RangedI64ValueParser.html" title="RangedI64ValueParser"><code>RangedI64ValueParser</code></a> for more control over the output type.</p>
|
||
<p>See also <a href="struct.RangedU64ValueParser.html" title="RangedU64ValueParser"><code>RangedU64ValueParser</code></a></p>
|
||
<h4 id="examples"><a href="#examples">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">clap::Command::new</span>(<span class="string">"raw"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">value_parser</span>(<span class="number">3000</span>..<span class="number">4000</span>)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Set</span>)
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>([<span class="string">"cmd"</span>, <span class="string">"--port"</span>, <span class="string">"3001"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">port</span>: <span class="ident">i64</span> <span class="op">=</span> <span class="kw-2">*</span><span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"required"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">port</span>, <span class="number">3001</span>);</code></pre></div>
|
||
</div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#321-324">source</a></span><a href="#method.from-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(value: <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i64.html">i64</a>>) -> Self</h4></section></summary><div class='docblock'><p>Converts to this type from the input type.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CRangeFrom%3Ci64%3E%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#380-385">source</a></span><a href="#impl-From%3CRangeFrom%3Ci64%3E%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/core/ops/range/struct.RangeFrom.html" title="struct core::ops::range::RangeFrom">RangeFrom</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i64.html">i64</a>>> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section></summary><div class="docblock"><p>Create an <code>i64</code> <a href="struct.ValueParser.html" title="ValueParser"><code>ValueParser</code></a> from a <code>N..</code> range</p>
|
||
<p>See <a href="struct.RangedI64ValueParser.html" title="RangedI64ValueParser"><code>RangedI64ValueParser</code></a> for more control over the output type.</p>
|
||
<p>See also <a href="struct.RangedU64ValueParser.html" title="RangedU64ValueParser"><code>RangedU64ValueParser</code></a></p>
|
||
<h4 id="examples-2"><a href="#examples-2">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">clap::Command::new</span>(<span class="string">"raw"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">value_parser</span>(<span class="number">3000</span>..)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Set</span>)
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>([<span class="string">"cmd"</span>, <span class="string">"--port"</span>, <span class="string">"3001"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">port</span>: <span class="ident">i64</span> <span class="op">=</span> <span class="kw-2">*</span><span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"required"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">port</span>, <span class="number">3001</span>);</code></pre></div>
|
||
</div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-3" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#381-384">source</a></span><a href="#method.from-3" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(value: <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/ops/range/struct.RangeFrom.html" title="struct core::ops::range::RangeFrom">RangeFrom</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i64.html">i64</a>>) -> Self</h4></section></summary><div class='docblock'><p>Converts to this type from the input type.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CRangeFull%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#470-475">source</a></span><a href="#impl-From%3CRangeFull%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/core/ops/range/struct.RangeFull.html" title="struct core::ops::range::RangeFull">RangeFull</a>> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section></summary><div class="docblock"><p>Create an <code>i64</code> <a href="struct.ValueParser.html" title="ValueParser"><code>ValueParser</code></a> from a <code>..</code> range</p>
|
||
<p>See <a href="struct.RangedI64ValueParser.html" title="RangedI64ValueParser"><code>RangedI64ValueParser</code></a> for more control over the output type.</p>
|
||
<p>See also <a href="struct.RangedU64ValueParser.html" title="RangedU64ValueParser"><code>RangedU64ValueParser</code></a></p>
|
||
<h4 id="examples-5"><a href="#examples-5">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">clap::Command::new</span>(<span class="string">"raw"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">value_parser</span>(..)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Set</span>)
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>([<span class="string">"cmd"</span>, <span class="string">"--port"</span>, <span class="string">"3001"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">port</span>: <span class="ident">i64</span> <span class="op">=</span> <span class="kw-2">*</span><span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"required"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">port</span>, <span class="number">3001</span>);</code></pre></div>
|
||
</div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-6" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#471-474">source</a></span><a href="#method.from-6" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(value: <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/ops/range/struct.RangeFull.html" title="struct core::ops::range::RangeFull">RangeFull</a>) -> Self</h4></section></summary><div class='docblock'><p>Converts to this type from the input type.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CRangeInclusive%3Ci64%3E%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#350-355">source</a></span><a href="#impl-From%3CRangeInclusive%3Ci64%3E%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/core/ops/range/struct.RangeInclusive.html" title="struct core::ops::range::RangeInclusive">RangeInclusive</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i64.html">i64</a>>> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section></summary><div class="docblock"><p>Create an <code>i64</code> <a href="struct.ValueParser.html" title="ValueParser"><code>ValueParser</code></a> from a <code>N..=M</code> range</p>
|
||
<p>See <a href="struct.RangedI64ValueParser.html" title="RangedI64ValueParser"><code>RangedI64ValueParser</code></a> for more control over the output type.</p>
|
||
<p>See also <a href="struct.RangedU64ValueParser.html" title="RangedU64ValueParser"><code>RangedU64ValueParser</code></a></p>
|
||
<h4 id="examples-1"><a href="#examples-1">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">clap::Command::new</span>(<span class="string">"raw"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">value_parser</span>(<span class="number">3000</span>..<span class="op">=</span><span class="number">4000</span>)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Set</span>)
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>([<span class="string">"cmd"</span>, <span class="string">"--port"</span>, <span class="string">"3001"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">port</span>: <span class="ident">i64</span> <span class="op">=</span> <span class="kw-2">*</span><span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"required"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">port</span>, <span class="number">3001</span>);</code></pre></div>
|
||
</div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-2" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#351-354">source</a></span><a href="#method.from-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(value: <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/ops/range/struct.RangeInclusive.html" title="struct core::ops::range::RangeInclusive">RangeInclusive</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i64.html">i64</a>>) -> Self</h4></section></summary><div class='docblock'><p>Converts to this type from the input type.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CRangeTo%3Ci64%3E%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#410-415">source</a></span><a href="#impl-From%3CRangeTo%3Ci64%3E%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/core/ops/range/struct.RangeTo.html" title="struct core::ops::range::RangeTo">RangeTo</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i64.html">i64</a>>> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section></summary><div class="docblock"><p>Create an <code>i64</code> <a href="struct.ValueParser.html" title="ValueParser"><code>ValueParser</code></a> from a <code>..M</code> range</p>
|
||
<p>See <a href="struct.RangedI64ValueParser.html" title="RangedI64ValueParser"><code>RangedI64ValueParser</code></a> for more control over the output type.</p>
|
||
<p>See also <a href="struct.RangedU64ValueParser.html" title="RangedU64ValueParser"><code>RangedU64ValueParser</code></a></p>
|
||
<h4 id="examples-3"><a href="#examples-3">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">clap::Command::new</span>(<span class="string">"raw"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">value_parser</span>(..<span class="number">3000</span>)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Set</span>)
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>([<span class="string">"cmd"</span>, <span class="string">"--port"</span>, <span class="string">"80"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">port</span>: <span class="ident">i64</span> <span class="op">=</span> <span class="kw-2">*</span><span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"required"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">port</span>, <span class="number">80</span>);</code></pre></div>
|
||
</div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-4" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#411-414">source</a></span><a href="#method.from-4" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(value: <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/ops/range/struct.RangeTo.html" title="struct core::ops::range::RangeTo">RangeTo</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i64.html">i64</a>>) -> Self</h4></section></summary><div class='docblock'><p>Converts to this type from the input type.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CRangeToInclusive%3Ci64%3E%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#440-445">source</a></span><a href="#impl-From%3CRangeToInclusive%3Ci64%3E%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/core/ops/range/struct.RangeToInclusive.html" title="struct core::ops::range::RangeToInclusive">RangeToInclusive</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i64.html">i64</a>>> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section></summary><div class="docblock"><p>Create an <code>i64</code> <a href="struct.ValueParser.html" title="ValueParser"><code>ValueParser</code></a> from a <code>..=M</code> range</p>
|
||
<p>See <a href="struct.RangedI64ValueParser.html" title="RangedI64ValueParser"><code>RangedI64ValueParser</code></a> for more control over the output type.</p>
|
||
<p>See also <a href="struct.RangedU64ValueParser.html" title="RangedU64ValueParser"><code>RangedU64ValueParser</code></a></p>
|
||
<h4 id="examples-4"><a href="#examples-4">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">clap::Command::new</span>(<span class="string">"raw"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">value_parser</span>(..<span class="op">=</span><span class="number">3000</span>)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Set</span>)
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>([<span class="string">"cmd"</span>, <span class="string">"--port"</span>, <span class="string">"80"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">port</span>: <span class="ident">i64</span> <span class="op">=</span> <span class="kw-2">*</span><span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"port"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"required"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">port</span>, <span class="number">80</span>);</code></pre></div>
|
||
</div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-5" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#441-444">source</a></span><a href="#method.from-5" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(value: <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/ops/range/struct.RangeToInclusive.html" title="struct core::ops::range::RangeToInclusive">RangeToInclusive</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i64.html">i64</a>>) -> Self</h4></section></summary><div class='docblock'><p>Converts to this type from the input type.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CVec%3CP%2C%20Global%3E%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#536-544">source</a></span><a href="#impl-From%3CVec%3CP%2C%20Global%3E%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl<P> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><P, <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>>> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a> <span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="struct.PossibleValue.html" title="struct clap::builder::PossibleValue">PossibleValue</a>>, </span></h3></section></summary><div class="docblock"><p>Create a <a href="struct.ValueParser.html" title="ValueParser"><code>ValueParser</code></a> with <a href="struct.PossibleValuesParser.html" title="PossibleValuesParser"><code>PossibleValuesParser</code></a></p>
|
||
<p>See <a href="struct.PossibleValuesParser.html" title="PossibleValuesParser"><code>PossibleValuesParser</code></a> for more flexibility in creating the
|
||
<a href="struct.PossibleValue.html" title="crate::builder::PossibleValue"><code>PossibleValue</code></a>s.</p>
|
||
<h4 id="examples-7"><a href="#examples-7">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">possible</span> <span class="op">=</span> <span class="macro">vec!</span>[<span class="string">"always"</span>, <span class="string">"auto"</span>, <span class="string">"never"</span>];
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">clap::Command::new</span>(<span class="string">"raw"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">clap::Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">value_parser</span>(<span class="ident">possible</span>)
|
||
.<span class="ident">default_value</span>(<span class="string">"auto"</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from_mut</span>(
|
||
[<span class="string">"cmd"</span>, <span class="string">"--color"</span>, <span class="string">"never"</span>]
|
||
).<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">color</span>: <span class="kw-2">&</span><span class="ident">String</span> <span class="op">=</span> <span class="ident">m</span>.<span class="ident">get_one</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"default"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">color</span>, <span class="string">"never"</span>);</code></pre></div>
|
||
</div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-8" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#540-543">source</a></span><a href="#method.from-8" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(values: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><P>) -> Self</h4></section></summary><div class='docblock'><p>Converts to this type from the input type.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-IntoResettable%3CValueParser%3E-for-I" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/resettable.rs.html#177-181">source</a></span><a href="#impl-IntoResettable%3CValueParser%3E-for-I" class="anchor"></a><h3 class="code-header in-band">impl<I: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a>>> <a class="trait" href="trait.IntoResettable.html" title="trait clap::builder::IntoResettable">IntoResettable</a><<a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a>> for I</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_resettable-1" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/resettable.rs.html#178-180">source</a></span><a href="#method.into_resettable-1" class="anchor"></a><h4 class="code-header">fn <a href="trait.IntoResettable.html#tymethod.into_resettable" class="fnname">into_resettable</a>(self) -> <a class="enum" href="enum.Resettable.html" title="enum clap::builder::Resettable">Resettable</a><<a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a>></h4></section></summary><div class='docblock'><p>Convert to the intended resettable type</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-IntoResettable%3CValueParser%3E-for-Option%3CValueParser%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/resettable.rs.html#105-112">source</a></span><a href="#impl-IntoResettable%3CValueParser%3E-for-Option%3CValueParser%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.IntoResettable.html" title="trait clap::builder::IntoResettable">IntoResettable</a><<a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a>> for <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a>></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_resettable" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/resettable.rs.html#106-111">source</a></span><a href="#method.into_resettable" class="anchor"></a><h4 class="code-header">fn <a href="trait.IntoResettable.html#tymethod.into_resettable" class="fnname">into_resettable</a>(self) -> <a class="enum" href="enum.Resettable.html" title="enum clap::builder::Resettable">Resettable</a><<a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a>></h4></section></summary><div class='docblock'><p>Convert to the intended resettable type</p>
|
||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-ValueParser" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl !<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section><section id="impl-Send-for-ValueParser" class="impl has-srclink"><a href="#impl-Send-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section><section id="impl-Sync-for-ValueParser" class="impl has-srclink"><a href="#impl-Sync-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section><section id="impl-Unpin-for-ValueParser" class="impl has-srclink"><a href="#impl-Unpin-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section><section id="impl-UnwindSafe-for-ValueParser" class="impl has-srclink"><a href="#impl-UnwindSafe-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl !<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.ValueParser.html" title="struct clap::builder::ValueParser">ValueParser</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/any.rs.html#203">source</a></span><a href="#impl-Any-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id-1" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/any.rs.html#204">source</a></span><a href="#method.type_id-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#209">source</a></span><a href="#impl-Borrow%3CT%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#211">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#218">source</a></span><a href="#impl-BorrowMut%3CT%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#219">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#557">source</a></span><a href="#impl-From%3CT%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-9" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#559">source</a></span><a href="#method.from-9" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#541">source</a></span><a href="#impl-Into%3CU%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#549">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/borrow.rs.html#83">source</a></span><a href="#impl-ToOwned-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/borrow.rs.html#88">source</a></span><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/borrow.rs.html#92">source</a></span><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>T)</h4></section></summary><div class='docblock'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#598">source</a></span><a href="#impl-TryFrom%3CU%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#604">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-ValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#583">source</a></span><a href="#impl-TryInto%3CU%3E-for-ValueParser" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#589">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div></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.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |