Now a REAL lib
This commit is contained in:
Justine
3
doc/clap/all.html
Normal file
3
doc/clap/all.html
Normal file
File diff suppressed because one or more lines are too long
11
doc/clap/builder/action/enum.ArgAction.html
Normal file
11
doc/clap/builder/action/enum.ArgAction.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/enum.ArgAction.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/enum.ArgAction.html">../../../clap/builder/enum.ArgAction.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/enum.ArgAction.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/arg/struct.Arg.html
Normal file
11
doc/clap/builder/arg/struct.Arg.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.Arg.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.Arg.html">../../../clap/builder/struct.Arg.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.Arg.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/arg_group/struct.ArgGroup.html
Normal file
11
doc/clap/builder/arg_group/struct.ArgGroup.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.ArgGroup.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.ArgGroup.html">../../../clap/builder/struct.ArgGroup.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.ArgGroup.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/arg_predicate/enum.ArgPredicate.html
Normal file
11
doc/clap/builder/arg_predicate/enum.ArgPredicate.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/enum.ArgPredicate.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/enum.ArgPredicate.html">../../../clap/builder/enum.ArgPredicate.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/enum.ArgPredicate.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/command/struct.Command.html
Normal file
11
doc/clap/builder/command/struct.Command.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.Command.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.Command.html">../../../clap/builder/struct.Command.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.Command.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
228
doc/clap/builder/enum.ArgAction.html
Normal file
228
doc/clap/builder/enum.ArgAction.html
Normal file
@ -0,0 +1,228 @@
|
||||
<!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="Behavior of arguments when they are encountered while parsing"><meta name="keywords" content="rust, rustlang, rust-lang, ArgAction"><title>ArgAction 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 enum"><!--[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="#">ArgAction</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#variants">Variants</a></h3><ul><li><a href="#variant.Append">Append</a></li><li><a href="#variant.Count">Count</a></li><li><a href="#variant.Help">Help</a></li><li><a href="#variant.Set">Set</a></li><li><a href="#variant.SetFalse">SetFalse</a></li><li><a href="#variant.SetTrue">SetTrue</a></li><li><a href="#variant.Version">Version</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul><li><a href="#method.takes_values">takes_values</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-ArgAction">Clone</a></li><li><a href="#impl-Debug-for-ArgAction">Debug</a></li><li><a href="#impl-IntoResettable%3CArgAction%3E-for-ArgAction">IntoResettable<ArgAction></a></li><li><a href="#impl-IntoResettable%3CArgAction%3E-for-Option%3CArgAction%3E">IntoResettable<ArgAction></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-ArgAction">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ArgAction">Send</a></li><li><a href="#impl-Sync-for-ArgAction">Sync</a></li><li><a href="#impl-Unpin-for-ArgAction">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ArgAction">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-ArgAction">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ArgAction">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ArgAction">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-ArgAction">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-ArgAction">Into<U></a></li><li><a href="#impl-ToOwned-for-ArgAction">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-ArgAction">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-ArgAction">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">Enum <a href="../index.html">clap</a>::<wbr><a href="index.html">builder</a>::<wbr><a class="enum" href="#">ArgAction</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/action.rs.html#27-273">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 enum"><code>#[non_exhaustive]
|
||||
pub enum ArgAction {
|
||||
Set,
|
||||
Append,
|
||||
SetTrue,
|
||||
SetFalse,
|
||||
Count,
|
||||
Help,
|
||||
Version,
|
||||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Behavior of arguments when they are encountered while parsing</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> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"special-help"</span>)
|
||||
.<span class="ident">short</span>(<span class="string">'?'</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Help</span>)
|
||||
);
|
||||
|
||||
<span class="comment">// Existing help still exists</span>
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"-h"</span>]).<span class="ident">unwrap_err</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayHelp</span>);
|
||||
|
||||
<span class="comment">// New help available</span>
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"-?"</span>]).<span class="ident">unwrap_err</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayHelp</span>);</code></pre></div>
|
||||
</div></details><h2 id="variants" class="variants small-section-header">Variants (Non-exhaustive)<a href="#variants" class="anchor"></a></h2><details class="rustdoc-toggle non-exhaustive"><summary class="hideme"><span>This enum is marked as non-exhaustive</span></summary><div class="docblock">Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.</div></details><h3 id="variant.Set" class="variant small-section-header"><a href="#variant.Set" class="anchor field"></a><code>Set</code></h3><div class="docblock"><p>When encountered, store the associated value(s) in <a href="../parser/struct.ArgMatches.html" title="crate::ArgMatches"><code>ArgMatches</code></a></p>
|
||||
<p><strong>NOTE:</strong> If the argument has previously been seen, it will result in a
|
||||
<a href="../error/enum.ErrorKind.html#variant.ArgumentConflict" title="crate::error::ErrorKind::ArgumentConflict"><code>ArgumentConflict</code></a> unless
|
||||
<a href="struct.Command.html#method.args_override_self" title="crate::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</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="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Set</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>, <span class="string">"value"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_many</span>::<span class="op"><</span><span class="ident">String</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">unwrap_or_default</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">as_str</span>()).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span><span class="op">></span>(),
|
||||
<span class="macro">vec!</span>[<span class="string">"value"</span>]
|
||||
);</code></pre></div>
|
||||
</div><h3 id="variant.Append" class="variant small-section-header"><a href="#variant.Append" class="anchor field"></a><code>Append</code></h3><div class="docblock"><p>When encountered, store the associated value(s) in <a href="../parser/struct.ArgMatches.html" title="crate::ArgMatches"><code>ArgMatches</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="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Append</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>, <span class="string">"value1"</span>, <span class="string">"--flag"</span>, <span class="string">"value2"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_many</span>::<span class="op"><</span><span class="ident">String</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">unwrap_or_default</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">as_str</span>()).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span><span class="op">></span>(),
|
||||
<span class="macro">vec!</span>[<span class="string">"value1"</span>, <span class="string">"value2"</span>]
|
||||
);</code></pre></div>
|
||||
</div><h3 id="variant.SetTrue" class="variant small-section-header"><a href="#variant.SetTrue" class="anchor field"></a><code>SetTrue</code></h3><div class="docblock"><p>When encountered, act as if <code>"true"</code> was encountered on the command-line</p>
|
||||
<p>If no <a href="struct.Arg.html#method.default_value" title="super::Arg::default_value"><code>default_value</code></a> is set, it will be <code>false</code>.</p>
|
||||
<p>No value is allowed. To optionally accept a value, see
|
||||
<a href="struct.Arg.html#method.default_missing_value" title="super::Arg::default_missing_value"><code>Arg::default_missing_value</code></a></p>
|
||||
<p><strong>NOTE:</strong> If the argument has previously been seen, it will result in a
|
||||
<a href="../error/enum.ErrorKind.html#variant.ArgumentConflict" title="crate::error::ErrorKind::ArgumentConflict"><code>ArgumentConflict</code></a> unless
|
||||
<a href="struct.Command.html#method.args_override_self" title="crate::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</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="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::SetTrue</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||||
<span class="prelude-val">Some</span>(<span class="bool-val">true</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||||
<span class="prelude-val">Some</span>(<span class="bool-val">false</span>)
|
||||
);</code></pre></div>
|
||||
<p>You can use <a href="trait.TypedValueParser.html#method.map" title="crate::builder::TypedValueParser::map"><code>TypedValueParser::map</code></a> to have the
|
||||
flag control an application-specific type:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::SetTrue</span>)
|
||||
.<span class="ident">value_parser</span>(
|
||||
<span class="ident">BoolishValueParser::new</span>()
|
||||
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">b</span><span class="op">|</span> -> <span class="ident">usize</span> {
|
||||
<span class="kw">if</span> <span class="ident">b</span> { <span class="number">10</span> } <span class="kw">else</span> { <span class="number">5</span> }
|
||||
})
|
||||
)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">usize</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||||
<span class="prelude-val">Some</span>(<span class="number">10</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">usize</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||||
<span class="prelude-val">Some</span>(<span class="number">5</span>)
|
||||
);</code></pre></div>
|
||||
</div><h3 id="variant.SetFalse" class="variant small-section-header"><a href="#variant.SetFalse" class="anchor field"></a><code>SetFalse</code></h3><div class="docblock"><p>When encountered, act as if <code>"false"</code> was encountered on the command-line</p>
|
||||
<p>If no <a href="struct.Arg.html#method.default_value" title="super::Arg::default_value"><code>default_value</code></a> is set, it will be <code>true</code>.</p>
|
||||
<p>No value is allowed. To optionally accept a value, see
|
||||
<a href="struct.Arg.html#method.default_missing_value" title="super::Arg::default_missing_value"><code>Arg::default_missing_value</code></a></p>
|
||||
<p><strong>NOTE:</strong> If the argument has previously been seen, it will result in a
|
||||
<a href="../error/enum.ErrorKind.html#variant.ArgumentConflict" title="crate::error::ErrorKind::ArgumentConflict"><code>ArgumentConflict</code></a> unless
|
||||
<a href="struct.Command.html#method.args_override_self" title="crate::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</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="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::SetFalse</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||||
<span class="prelude-val">Some</span>(<span class="bool-val">false</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||||
<span class="prelude-val">Some</span>(<span class="bool-val">true</span>)
|
||||
);</code></pre></div>
|
||||
</div><h3 id="variant.Count" class="variant small-section-header"><a href="#variant.Count" class="anchor field"></a><code>Count</code></h3><div class="docblock"><p>When encountered, increment a <code>u8</code> counter</p>
|
||||
<p>If no <a href="struct.Arg.html#method.default_value" title="super::Arg::default_value"><code>default_value</code></a> is set, it will be <code>0</code>.</p>
|
||||
<p>No value is allowed. To optionally accept a value, see
|
||||
<a href="struct.Arg.html#method.default_missing_value" title="super::Arg::default_missing_value"><code>Arg::default_missing_value</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="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Count</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>, <span class="string">"--flag"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_count</span>(<span class="string">"flag"</span>),
|
||||
<span class="number">2</span>
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_count</span>(<span class="string">"flag"</span>),
|
||||
<span class="number">0</span>
|
||||
);</code></pre></div>
|
||||
</div><h3 id="variant.Help" class="variant small-section-header"><a href="#variant.Help" class="anchor field"></a><code>Help</code></h3><div class="docblock"><p>When encountered, display <a href="struct.Command.html#method.print_help" title="super::Command::print_help"><code>Command::print_help</code></a></p>
|
||||
<p>Depending on the flag, <a href="struct.Command.html#method.print_long_help" title="super::Command::print_long_help"><code>Command::print_long_help</code></a> may be shown</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="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"special-help"</span>)
|
||||
.<span class="ident">short</span>(<span class="string">'?'</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Help</span>)
|
||||
);
|
||||
|
||||
<span class="comment">// Existing help still exists</span>
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"-h"</span>]).<span class="ident">unwrap_err</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayHelp</span>);
|
||||
|
||||
<span class="comment">// New help available</span>
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"-?"</span>]).<span class="ident">unwrap_err</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayHelp</span>);</code></pre></div>
|
||||
</div><h3 id="variant.Version" class="variant small-section-header"><a href="#variant.Version" class="anchor field"></a><code>Version</code></h3><div class="docblock"><p>When encountered, display <a href="struct.Command.html#method.version" title="super::Command::version"><code>Command::version</code></a></p>
|
||||
<p>Depending on the flag, <a href="struct.Command.html#method.long_version" title="super::Command::long_version"><code>Command::long_version</code></a> may be shown</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">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">version</span>(<span class="string">"1.0.0"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"special-version"</span>)
|
||||
.<span class="ident">long</span>(<span class="string">"special-version"</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Version</span>)
|
||||
);
|
||||
|
||||
<span class="comment">// Existing help still exists</span>
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--version"</span>]).<span class="ident">unwrap_err</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayVersion</span>);
|
||||
|
||||
<span class="comment">// New help available</span>
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--special-version"</span>]).<span class="ident">unwrap_err</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayVersion</span>);</code></pre></div>
|
||||
</div><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-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/action.rs.html#275-342">source</a></span><a href="#impl-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl <a class="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.takes_values" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/action.rs.html#280-290">source</a></span><h4 class="code-header">pub fn <a href="#method.takes_values" class="fnname">takes_values</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether this action accepts values on the command-line</p>
|
||||
<p><a href="struct.Arg.html#method.default_values" title="super::Arg::default_values"><code>default_values</code></a> and [<code>env</code>][super::Arg::env] may still be
|
||||
processed.</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-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/action.rs.html#24">source</a></span><a href="#impl-Clone-for-ArgAction" 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="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</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/action.rs.html#24">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) -> <a class="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></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-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/action.rs.html#24">source</a></span><a href="#impl-Debug-for-ArgAction" 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="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</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/action.rs.html#24">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="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</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-IntoResettable%3CArgAction%3E-for-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/resettable.rs.html#159-163">source</a></span><a href="#impl-IntoResettable%3CArgAction%3E-for-ArgAction" 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="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a>> for <a class="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></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#160-162">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="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</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%3CArgAction%3E-for-Option%3CArgAction%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/resettable.rs.html#87-94">source</a></span><a href="#impl-IntoResettable%3CArgAction%3E-for-Option%3CArgAction%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="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</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="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</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#88-93">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="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</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-ArgAction" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-ArgAction" 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="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section><section id="impl-Send-for-ArgAction" class="impl has-srclink"><a href="#impl-Send-for-ArgAction" 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="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section><section id="impl-Sync-for-ArgAction" class="impl has-srclink"><a href="#impl-Sync-for-ArgAction" 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="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section><section id="impl-Unpin-for-ArgAction" class="impl has-srclink"><a href="#impl-Unpin-for-ArgAction" 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="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section><section id="impl-UnwindSafe-for-ArgAction" class="impl has-srclink"><a href="#impl-UnwindSafe-for-ArgAction" 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="enum" href="enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</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-ArgAction" 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-ArgAction" 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" 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" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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" 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" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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>
|
||||
31
doc/clap/builder/enum.ArgPredicate.html
Normal file
31
doc/clap/builder/enum.ArgPredicate.html
Normal file
File diff suppressed because one or more lines are too long
67
doc/clap/builder/enum.Resettable.html
Normal file
67
doc/clap/builder/enum.Resettable.html
Normal file
File diff suppressed because one or more lines are too long
83
doc/clap/builder/enum.ValueHint.html
Normal file
83
doc/clap/builder/enum.ValueHint.html
Normal file
File diff suppressed because one or more lines are too long
33
doc/clap/builder/index.html
Normal file
33
doc/clap/builder/index.html
Normal file
@ -0,0 +1,33 @@
|
||||
<!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="Define [`Command`] line [arguments][`Arg`]"><meta name="keywords" content="rust, rustlang, rust-lang, builder"><title>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="../../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 mod"><!--[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="#">Module builder</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div></section></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">Module <a href="../index.html">clap</a>::<wbr><a class="mod" href="#">builder</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/mod.rs.html#1-60">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Define <a href="struct.Command.html" title="Command"><code>Command</code></a> line <a href="struct.Arg.html" title="Arg">arguments</a></p>
|
||||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Arg.html" title="clap::builder::Arg struct">Arg</a></div><div class="item-right docblock-short"><p>The abstract representation of a command line argument. Used to set all the options and
|
||||
relationships that define a valid argument for the program.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ArgGroup.html" title="clap::builder::ArgGroup struct">ArgGroup</a></div><div class="item-right docblock-short"><p>Family of related <a href="struct.Arg.html">arguments</a>.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BoolValueParser.html" title="clap::builder::BoolValueParser struct">BoolValueParser</a></div><div class="item-right docblock-short"><p>Implementation for <a href="struct.ValueParser.html#method.bool" title="ValueParser::bool"><code>ValueParser::bool</code></a></p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BoolishValueParser.html" title="clap::builder::BoolishValueParser struct">BoolishValueParser</a></div><div class="item-right docblock-short"><p>Parse bool-like string values, everything else is <code>true</code></p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Command.html" title="clap::builder::Command struct">Command</a></div><div class="item-right docblock-short"><p>Build a command-line interface.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EnumValueParser.html" title="clap::builder::EnumValueParser struct">EnumValueParser</a></div><div class="item-right docblock-short"><p>Parse an <a href="../trait.ValueEnum.html" title="crate::ValueEnum"><code>ValueEnum</code></a> value.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FalseyValueParser.html" title="clap::builder::FalseyValueParser struct">FalseyValueParser</a></div><div class="item-right docblock-short"><p>Parse false-like string values, everything else is <code>true</code></p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MapValueParser.html" title="clap::builder::MapValueParser struct">MapValueParser</a></div><div class="item-right docblock-short"><p>Adapt a <code>TypedValueParser</code> from one value to another</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.NonEmptyStringValueParser.html" title="clap::builder::NonEmptyStringValueParser struct">NonEmptyStringValueParser</a></div><div class="item-right docblock-short"><p>Parse non-empty string values</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OsStr.html" title="clap::builder::OsStr struct">OsStr</a></div><div class="item-right docblock-short"><p>A UTF-8-encoded fixed string</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OsStringValueParser.html" title="clap::builder::OsStringValueParser struct">OsStringValueParser</a></div><div class="item-right docblock-short"><p>Implementation for <a href="struct.ValueParser.html#method.os_string" title="ValueParser::os_string"><code>ValueParser::os_string</code></a></p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PathBufValueParser.html" title="clap::builder::PathBufValueParser struct">PathBufValueParser</a></div><div class="item-right docblock-short"><p>Implementation for <a href="struct.ValueParser.html#method.path_buf" title="ValueParser::path_buf"><code>ValueParser::path_buf</code></a></p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PossibleValue.html" title="clap::builder::PossibleValue struct">PossibleValue</a></div><div class="item-right docblock-short"><p>A possible value of an argument.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PossibleValuesParser.html" title="clap::builder::PossibleValuesParser struct">PossibleValuesParser</a></div><div class="item-right docblock-short"><p>Verify the value is from an enumerated set of <a href="struct.PossibleValue.html" title="crate::builder::PossibleValue"><code>PossibleValue</code></a>.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RangedI64ValueParser.html" title="clap::builder::RangedI64ValueParser struct">RangedI64ValueParser</a></div><div class="item-right docblock-short"><p>Parse number that fall within a range of values</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RangedU64ValueParser.html" title="clap::builder::RangedU64ValueParser struct">RangedU64ValueParser</a></div><div class="item-right docblock-short"><p>Parse number that fall within a range of values</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Str.html" title="clap::builder::Str struct">Str</a></div><div class="item-right docblock-short"><p>A UTF-8-encoded fixed string</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StringValueParser.html" title="clap::builder::StringValueParser struct">StringValueParser</a></div><div class="item-right docblock-short"><p>Implementation for <a href="struct.ValueParser.html#method.string" title="ValueParser::string"><code>ValueParser::string</code></a></p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StyledStr.html" title="clap::builder::StyledStr struct">StyledStr</a></div><div class="item-right docblock-short"><p>Terminal-styling container</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ValueParser.html" title="clap::builder::ValueParser struct">ValueParser</a></div><div class="item-right docblock-short"><p>Parse/validate argument values</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ValueRange.html" title="clap::builder::ValueRange struct">ValueRange</a></div><div class="item-right docblock-short"><p>Values per occurrence for an argument</p>
|
||||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ArgAction.html" title="clap::builder::ArgAction enum">ArgAction</a></div><div class="item-right docblock-short"><p>Behavior of arguments when they are encountered while parsing</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ArgPredicate.html" title="clap::builder::ArgPredicate enum">ArgPredicate</a></div><div class="item-right docblock-short"><p>Operations to perform on argument values</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Resettable.html" title="clap::builder::Resettable enum">Resettable</a></div><div class="item-right docblock-short"><p>Clearable builder value</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ValueHint.html" title="clap::builder::ValueHint enum">ValueHint</a></div><div class="item-right docblock-short"><p>Provide shell with hint on how to complete an argument.</p>
|
||||
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.IntoResettable.html" title="clap::builder::IntoResettable trait">IntoResettable</a></div><div class="item-right docblock-short"><p>Convert to the intended resettable type</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.TypedValueParser.html" title="clap::builder::TypedValueParser trait">TypedValueParser</a></div><div class="item-right docblock-short"><p>Parse/validate argument values</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ValueParserFactory.html" title="clap::builder::ValueParserFactory trait">ValueParserFactory</a></div><div class="item-right docblock-short"><p>Register a type with <a href="../macro.value_parser.html" title="crate::value_parser!">value_parser!</a></p>
|
||||
</div></div></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>
|
||||
11
doc/clap/builder/os_str/struct.OsStr.html
Normal file
11
doc/clap/builder/os_str/struct.OsStr.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.OsStr.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.OsStr.html">../../../clap/builder/struct.OsStr.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.OsStr.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/possible_value/struct.PossibleValue.html
Normal file
11
doc/clap/builder/possible_value/struct.PossibleValue.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.PossibleValue.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.PossibleValue.html">../../../clap/builder/struct.PossibleValue.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.PossibleValue.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/range/struct.ValueRange.html
Normal file
11
doc/clap/builder/range/struct.ValueRange.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.ValueRange.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.ValueRange.html">../../../clap/builder/struct.ValueRange.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.ValueRange.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/resettable/enum.Resettable.html
Normal file
11
doc/clap/builder/resettable/enum.Resettable.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/enum.Resettable.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/enum.Resettable.html">../../../clap/builder/enum.Resettable.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/enum.Resettable.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/resettable/trait.IntoResettable.html
Normal file
11
doc/clap/builder/resettable/trait.IntoResettable.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/trait.IntoResettable.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/trait.IntoResettable.html">../../../clap/builder/trait.IntoResettable.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/trait.IntoResettable.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
1
doc/clap/builder/sidebar-items.js
Normal file
1
doc/clap/builder/sidebar-items.js
Normal file
@ -0,0 +1 @@
|
||||
window.SIDEBAR_ITEMS = {"enum":[["ArgAction","Behavior of arguments when they are encountered while parsing"],["ArgPredicate","Operations to perform on argument values"],["Resettable","Clearable builder value"],["ValueHint","Provide shell with hint on how to complete an argument."]],"struct":[["Arg","The abstract representation of a command line argument. Used to set all the options and relationships that define a valid argument for the program."],["ArgGroup","Family of related arguments."],["BoolValueParser","Implementation for [`ValueParser::bool`]"],["BoolishValueParser","Parse bool-like string values, everything else is `true`"],["Command","Build a command-line interface."],["EnumValueParser","Parse an [`ValueEnum`][crate::ValueEnum] value."],["FalseyValueParser","Parse false-like string values, everything else is `true`"],["MapValueParser","Adapt a `TypedValueParser` from one value to another"],["NonEmptyStringValueParser","Parse non-empty string values"],["OsStr","A UTF-8-encoded fixed string"],["OsStringValueParser","Implementation for [`ValueParser::os_string`]"],["PathBufValueParser","Implementation for [`ValueParser::path_buf`]"],["PossibleValue","A possible value of an argument."],["PossibleValuesParser","Verify the value is from an enumerated set of [`PossibleValue`][crate::builder::PossibleValue]."],["RangedI64ValueParser","Parse number that fall within a range of values"],["RangedU64ValueParser","Parse number that fall within a range of values"],["Str","A UTF-8-encoded fixed string"],["StringValueParser","Implementation for [`ValueParser::string`]"],["StyledStr","Terminal-styling container"],["ValueParser","Parse/validate argument values"],["ValueRange","Values per occurrence for an argument"]],"trait":[["IntoResettable","Convert to the intended resettable type"],["TypedValueParser","Parse/validate argument values"],["ValueParserFactory","Register a type with [value_parser!][crate::value_parser!]"]]};
|
||||
11
doc/clap/builder/str/struct.Str.html
Normal file
11
doc/clap/builder/str/struct.Str.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.Str.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.Str.html">../../../clap/builder/struct.Str.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.Str.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
2043
doc/clap/builder/struct.Arg.html
Normal file
2043
doc/clap/builder/struct.Arg.html
Normal file
File diff suppressed because one or more lines are too long
309
doc/clap/builder/struct.ArgGroup.html
Normal file
309
doc/clap/builder/struct.ArgGroup.html
Normal file
File diff suppressed because one or more lines are too long
30
doc/clap/builder/struct.BoolValueParser.html
Normal file
30
doc/clap/builder/struct.BoolValueParser.html
Normal file
@ -0,0 +1,30 @@
|
||||
<!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="Implementation for [`ValueParser::bool`]"><meta name="keywords" content="rust, rustlang, rust-lang, BoolValueParser"><title>BoolValueParser 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="#">BoolValueParser</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.new">new</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-BoolValueParser">Clone</a></li><li><a href="#impl-Copy-for-BoolValueParser">Copy</a></li><li><a href="#impl-Debug-for-BoolValueParser">Debug</a></li><li><a href="#impl-Default-for-BoolValueParser">Default</a></li><li><a href="#impl-TypedValueParser-for-BoolValueParser">TypedValueParser</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-BoolValueParser">RefUnwindSafe</a></li><li><a href="#impl-Send-for-BoolValueParser">Send</a></li><li><a href="#impl-Sync-for-BoolValueParser">Sync</a></li><li><a href="#impl-Unpin-for-BoolValueParser">Unpin</a></li><li><a href="#impl-UnwindSafe-for-BoolValueParser">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-BoolValueParser">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-BoolValueParser">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-BoolValueParser">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-BoolValueParser">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-BoolValueParser">Into<U></a></li><li><a href="#impl-ToOwned-for-BoolValueParser">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-BoolValueParser">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-BoolValueParser">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="#">BoolValueParser</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#1614">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><div class="code-attribute">#[non_exhaustive]</div>pub struct BoolValueParser {}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Implementation for <a href="struct.ValueParser.html#method.bool" title="ValueParser::bool"><code>ValueParser::bool</code></a></p>
|
||||
<p>Useful for composing new <a href="trait.TypedValueParser.html" title="TypedValueParser"><code>TypedValueParser</code></a>s</p>
|
||||
</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-BoolValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1616-1628">source</a></span><a href="#impl-BoolValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.BoolValueParser.html" title="struct clap::builder::BoolValueParser">BoolValueParser</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#1618-1620">source</a></span><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Implementation for <a href="struct.ValueParser.html#method.bool" title="ValueParser::bool"><code>ValueParser::bool</code></a></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-BoolValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1612">source</a></span><a href="#impl-Clone-for-BoolValueParser" 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.BoolValueParser.html" title="struct clap::builder::BoolValueParser">BoolValueParser</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#1612">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) -> <a class="struct" href="struct.BoolValueParser.html" title="struct clap::builder::BoolValueParser">BoolValueParser</a></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-BoolValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1612">source</a></span><a href="#impl-Debug-for-BoolValueParser" 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.BoolValueParser.html" title="struct clap::builder::BoolValueParser">BoolValueParser</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#1612">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="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</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-Default-for-BoolValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1667-1671">source</a></span><a href="#impl-Default-for-BoolValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.BoolValueParser.html" title="struct clap::builder::BoolValueParser">BoolValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1668-1670">source</a></span><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> Self</h4></section></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-TypedValueParser-for-BoolValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1630-1665">source</a></span><a href="#impl-TypedValueParser-for-BoolValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.TypedValueParser.html" title="trait clap::builder::TypedValueParser">TypedValueParser</a> for <a class="struct" href="struct.BoolValueParser.html" title="struct clap::builder::BoolValueParser">BoolValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Value" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Value" class="anchor"></a><h4 class="code-header">type <a href="trait.TypedValueParser.html#associatedtype.Value" class="associatedtype">Value</a> = <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'><p>Argument’s value type</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse_ref" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1633-1658">source</a></span><a href="#method.parse_ref" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#tymethod.parse_ref" class="fnname">parse_ref</a>(<br> &self,<br> cmd: &<a class="struct" href="struct.Command.html" title="struct clap::builder::Command">Command</a>,<br> arg: <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.Arg.html" title="struct clap::builder::Arg">Arg</a>>,<br> value: &<a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>, <a class="type" href="../type.Error.html" title="type clap::Error">Error</a>></h4></section></summary><div class='docblock'><p>Parse the argument value <a href="trait.TypedValueParser.html#tymethod.parse_ref">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.possible_values" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1660-1664">source</a></span><a href="#method.possible_values" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#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 <a href="trait.TypedValueParser.html#method.possible_values">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#702-709">source</a></span><a href="#method.parse" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.parse" class="fnname">parse</a>(<br> &self,<br> cmd: &<a class="struct" href="struct.Command.html" title="struct clap::builder::Command">Command</a>,<br> arg: <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.Arg.html" title="struct clap::builder::Arg">Arg</a>>,<br> value: <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>, <a class="type" href="../type.Error.html" title="type clap::Error">Error</a>></h4></section></summary><div class='docblock'><p>Parse the argument value <a href="trait.TypedValueParser.html#method.parse">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#757-763">source</a></span><a href="#method.map" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.map" class="fnname">map</a><T, F>(self, func: F) -> <a class="struct" href="struct.MapValueParser.html" title="struct clap::builder::MapValueParser">MapValueParser</a><Self, F> <span class="where fmt-newline">where<br> T: <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> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>) -> 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></h4></section></summary><div class='docblock'><p>Adapt a <code>TypedValueParser</code> from one value to another <a href="trait.TypedValueParser.html#method.map">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_map" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#806-813">source</a></span><a href="#method.try_map" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.try_map" class="fnname">try_map</a><T, E, F>(self, func: F) -> TryMapValueParser<Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</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><T, E> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</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,<br> T: <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> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> E: <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="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/std/error/trait.Error.html" title="trait std::error::Error">Error</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></h4></section></summary><div class='docblock'><p>Adapt a <code>TypedValueParser</code> from one value to another <a href="trait.TypedValueParser.html#method.try_map">Read more</a></p>
|
||||
</div></details></div></details><section id="impl-Copy-for-BoolValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1612">source</a></span><a href="#impl-Copy-for-BoolValueParser" 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.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="struct.BoolValueParser.html" title="struct clap::builder::BoolValueParser">BoolValueParser</a></h3></section></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-BoolValueParser" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-BoolValueParser" 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.BoolValueParser.html" title="struct clap::builder::BoolValueParser">BoolValueParser</a></h3></section><section id="impl-Send-for-BoolValueParser" class="impl has-srclink"><a href="#impl-Send-for-BoolValueParser" 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.BoolValueParser.html" title="struct clap::builder::BoolValueParser">BoolValueParser</a></h3></section><section id="impl-Sync-for-BoolValueParser" class="impl has-srclink"><a href="#impl-Sync-for-BoolValueParser" 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.BoolValueParser.html" title="struct clap::builder::BoolValueParser">BoolValueParser</a></h3></section><section id="impl-Unpin-for-BoolValueParser" class="impl has-srclink"><a href="#impl-Unpin-for-BoolValueParser" 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.BoolValueParser.html" title="struct clap::builder::BoolValueParser">BoolValueParser</a></h3></section><section id="impl-UnwindSafe-for-BoolValueParser" class="impl has-srclink"><a href="#impl-UnwindSafe-for-BoolValueParser" 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.BoolValueParser.html" title="struct clap::builder::BoolValueParser">BoolValueParser</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-BoolValueParser" 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-BoolValueParser" 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" 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" 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-BoolValueParser" 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-BoolValueParser" 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-BoolValueParser" 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-BoolValueParser" 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-BoolValueParser" 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-BoolValueParser" 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" 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" 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-BoolValueParser" 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-BoolValueParser" 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-BoolValueParser" 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-BoolValueParser" 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-BoolValueParser" 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-BoolValueParser" 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-BoolValueParser" 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-BoolValueParser" 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>
|
||||
62
doc/clap/builder/struct.BoolishValueParser.html
Normal file
62
doc/clap/builder/struct.BoolishValueParser.html
Normal file
@ -0,0 +1,62 @@
|
||||
<!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 bool-like string values, everything else is `true`"><meta name="keywords" content="rust, rustlang, rust-lang, BoolishValueParser"><title>BoolishValueParser 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="#">BoolishValueParser</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.new">new</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-BoolishValueParser">Clone</a></li><li><a href="#impl-Copy-for-BoolishValueParser">Copy</a></li><li><a href="#impl-Debug-for-BoolishValueParser">Debug</a></li><li><a href="#impl-Default-for-BoolishValueParser">Default</a></li><li><a href="#impl-TypedValueParser-for-BoolishValueParser">TypedValueParser</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-BoolishValueParser">RefUnwindSafe</a></li><li><a href="#impl-Send-for-BoolishValueParser">Send</a></li><li><a href="#impl-Sync-for-BoolishValueParser">Sync</a></li><li><a href="#impl-Unpin-for-BoolishValueParser">Unpin</a></li><li><a href="#impl-UnwindSafe-for-BoolishValueParser">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-BoolishValueParser">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-BoolishValueParser">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-BoolishValueParser">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-BoolishValueParser">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-BoolishValueParser">Into<U></a></li><li><a href="#impl-ToOwned-for-BoolishValueParser">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-BoolishValueParser">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-BoolishValueParser">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="#">BoolishValueParser</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#1810">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><div class="code-attribute">#[non_exhaustive]</div>pub struct BoolishValueParser {}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parse bool-like string values, everything else is <code>true</code></p>
|
||||
<p>See also:</p>
|
||||
<ul>
|
||||
<li><a href="struct.ValueParser.html#method.bool" title="ValueParser::bool"><code>ValueParser::bool</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>
|
||||
<h2 id="example"><a href="#example">Example</a></h2>
|
||||
<p>Usage:</p>
|
||||
|
||||
<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">"append"</span>)
|
||||
.<span class="ident">value_parser</span>(<span class="ident">clap::builder::BoolishValueParser::new</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">"append"</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>);</code></pre></div>
|
||||
<p>Semantics:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">value_parser</span> <span class="op">=</span> <span class="ident">clap::builder::BoolishValueParser::new</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"random"</span>)).<span class="ident">is_err</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">""</span>)).<span class="ident">is_err</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"100"</span>)).<span class="ident">is_err</span>());
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"true"</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">true</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"Yes"</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">true</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"oN"</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">true</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"1"</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">true</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"false"</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">false</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"No"</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">false</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"oFF"</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">false</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"0"</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">false</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-BoolishValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1812-1825">source</a></span><a href="#impl-BoolishValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.BoolishValueParser.html" title="struct clap::builder::BoolishValueParser">BoolishValueParser</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#1814-1816">source</a></span><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Parse bool-like string values, everything else is <code>true</code></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-BoolishValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1808">source</a></span><a href="#impl-Clone-for-BoolishValueParser" 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.BoolishValueParser.html" title="struct clap::builder::BoolishValueParser">BoolishValueParser</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#1808">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) -> <a class="struct" href="struct.BoolishValueParser.html" title="struct clap::builder::BoolishValueParser">BoolishValueParser</a></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-BoolishValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1808">source</a></span><a href="#impl-Debug-for-BoolishValueParser" 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.BoolishValueParser.html" title="struct clap::builder::BoolishValueParser">BoolishValueParser</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#1808">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="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</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-Default-for-BoolishValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1859-1863">source</a></span><a href="#impl-Default-for-BoolishValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.BoolishValueParser.html" title="struct clap::builder::BoolishValueParser">BoolishValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1860-1862">source</a></span><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> Self</h4></section></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-TypedValueParser-for-BoolishValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1827-1857">source</a></span><a href="#impl-TypedValueParser-for-BoolishValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.TypedValueParser.html" title="trait clap::builder::TypedValueParser">TypedValueParser</a> for <a class="struct" href="struct.BoolishValueParser.html" title="struct clap::builder::BoolishValueParser">BoolishValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Value" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Value" class="anchor"></a><h4 class="code-header">type <a href="trait.TypedValueParser.html#associatedtype.Value" class="associatedtype">Value</a> = <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'><p>Argument’s value type</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse_ref" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1830-1850">source</a></span><a href="#method.parse_ref" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#tymethod.parse_ref" class="fnname">parse_ref</a>(<br> &self,<br> cmd: &<a class="struct" href="struct.Command.html" title="struct clap::builder::Command">Command</a>,<br> arg: <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.Arg.html" title="struct clap::builder::Arg">Arg</a>>,<br> value: &<a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>, <a class="type" href="../type.Error.html" title="type clap::Error">Error</a>></h4></section></summary><div class='docblock'><p>Parse the argument value <a href="trait.TypedValueParser.html#tymethod.parse_ref">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.possible_values" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1852-1856">source</a></span><a href="#method.possible_values" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#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 <a href="trait.TypedValueParser.html#method.possible_values">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#702-709">source</a></span><a href="#method.parse" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.parse" class="fnname">parse</a>(<br> &self,<br> cmd: &<a class="struct" href="struct.Command.html" title="struct clap::builder::Command">Command</a>,<br> arg: <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.Arg.html" title="struct clap::builder::Arg">Arg</a>>,<br> value: <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>, <a class="type" href="../type.Error.html" title="type clap::Error">Error</a>></h4></section></summary><div class='docblock'><p>Parse the argument value <a href="trait.TypedValueParser.html#method.parse">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#757-763">source</a></span><a href="#method.map" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.map" class="fnname">map</a><T, F>(self, func: F) -> <a class="struct" href="struct.MapValueParser.html" title="struct clap::builder::MapValueParser">MapValueParser</a><Self, F> <span class="where fmt-newline">where<br> T: <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> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>) -> 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></h4></section></summary><div class='docblock'><p>Adapt a <code>TypedValueParser</code> from one value to another <a href="trait.TypedValueParser.html#method.map">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_map" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#806-813">source</a></span><a href="#method.try_map" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.try_map" class="fnname">try_map</a><T, E, F>(self, func: F) -> TryMapValueParser<Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</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><T, E> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</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,<br> T: <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> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> E: <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="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/std/error/trait.Error.html" title="trait std::error::Error">Error</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></h4></section></summary><div class='docblock'><p>Adapt a <code>TypedValueParser</code> from one value to another <a href="trait.TypedValueParser.html#method.try_map">Read more</a></p>
|
||||
</div></details></div></details><section id="impl-Copy-for-BoolishValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1808">source</a></span><a href="#impl-Copy-for-BoolishValueParser" 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.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="struct.BoolishValueParser.html" title="struct clap::builder::BoolishValueParser">BoolishValueParser</a></h3></section></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-BoolishValueParser" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-BoolishValueParser" 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.BoolishValueParser.html" title="struct clap::builder::BoolishValueParser">BoolishValueParser</a></h3></section><section id="impl-Send-for-BoolishValueParser" class="impl has-srclink"><a href="#impl-Send-for-BoolishValueParser" 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.BoolishValueParser.html" title="struct clap::builder::BoolishValueParser">BoolishValueParser</a></h3></section><section id="impl-Sync-for-BoolishValueParser" class="impl has-srclink"><a href="#impl-Sync-for-BoolishValueParser" 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.BoolishValueParser.html" title="struct clap::builder::BoolishValueParser">BoolishValueParser</a></h3></section><section id="impl-Unpin-for-BoolishValueParser" class="impl has-srclink"><a href="#impl-Unpin-for-BoolishValueParser" 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.BoolishValueParser.html" title="struct clap::builder::BoolishValueParser">BoolishValueParser</a></h3></section><section id="impl-UnwindSafe-for-BoolishValueParser" class="impl has-srclink"><a href="#impl-UnwindSafe-for-BoolishValueParser" 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.BoolishValueParser.html" title="struct clap::builder::BoolishValueParser">BoolishValueParser</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-BoolishValueParser" 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-BoolishValueParser" 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" 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" 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-BoolishValueParser" 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-BoolishValueParser" 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-BoolishValueParser" 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-BoolishValueParser" 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-BoolishValueParser" 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-BoolishValueParser" 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" 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" 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-BoolishValueParser" 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-BoolishValueParser" 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-BoolishValueParser" 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-BoolishValueParser" 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-BoolishValueParser" 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-BoolishValueParser" 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-BoolishValueParser" 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-BoolishValueParser" 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>
|
||||
1418
doc/clap/builder/struct.Command.html
Normal file
1418
doc/clap/builder/struct.Command.html
Normal file
File diff suppressed because one or more lines are too long
57
doc/clap/builder/struct.EnumValueParser.html
Normal file
57
doc/clap/builder/struct.EnumValueParser.html
Normal file
File diff suppressed because one or more lines are too long
58
doc/clap/builder/struct.FalseyValueParser.html
Normal file
58
doc/clap/builder/struct.FalseyValueParser.html
Normal file
@ -0,0 +1,58 @@
|
||||
<!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 false-like string values, everything else is `true`"><meta name="keywords" content="rust, rustlang, rust-lang, FalseyValueParser"><title>FalseyValueParser 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="#">FalseyValueParser</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.new">new</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-FalseyValueParser">Clone</a></li><li><a href="#impl-Copy-for-FalseyValueParser">Copy</a></li><li><a href="#impl-Debug-for-FalseyValueParser">Debug</a></li><li><a href="#impl-Default-for-FalseyValueParser">Default</a></li><li><a href="#impl-TypedValueParser-for-FalseyValueParser">TypedValueParser</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-FalseyValueParser">RefUnwindSafe</a></li><li><a href="#impl-Send-for-FalseyValueParser">Send</a></li><li><a href="#impl-Sync-for-FalseyValueParser">Sync</a></li><li><a href="#impl-Unpin-for-FalseyValueParser">Unpin</a></li><li><a href="#impl-UnwindSafe-for-FalseyValueParser">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-FalseyValueParser">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-FalseyValueParser">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-FalseyValueParser">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-FalseyValueParser">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-FalseyValueParser">Into<U></a></li><li><a href="#impl-ToOwned-for-FalseyValueParser">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-FalseyValueParser">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-FalseyValueParser">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="#">FalseyValueParser</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#1713">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><div class="code-attribute">#[non_exhaustive]</div>pub struct FalseyValueParser {}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parse false-like string values, everything else is <code>true</code></p>
|
||||
<p>See also:</p>
|
||||
<ul>
|
||||
<li><a href="struct.ValueParser.html#method.bool" title="ValueParser::bool"><code>ValueParser::bool</code></a> for assuming non-false is true</li>
|
||||
<li><a href="struct.BoolishValueParser.html" title="BoolishValueParser"><code>BoolishValueParser</code></a> for different human readable bool representations</li>
|
||||
</ul>
|
||||
<h2 id="example"><a href="#example">Example</a></h2>
|
||||
<p>Usage:</p>
|
||||
|
||||
<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">"append"</span>)
|
||||
.<span class="ident">value_parser</span>(<span class="ident">clap::builder::FalseyValueParser::new</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">"append"</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>);</code></pre></div>
|
||||
<p>Semantics:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">value_parser</span> <span class="op">=</span> <span class="ident">clap::builder::FalseyValueParser::new</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"random"</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">true</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"100"</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">true</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">""</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">false</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"false"</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">false</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"No"</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">false</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"oFF"</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">false</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"0"</span>)).<span class="ident">unwrap</span>(), <span class="bool-val">false</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-FalseyValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1715-1728">source</a></span><a href="#impl-FalseyValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.FalseyValueParser.html" title="struct clap::builder::FalseyValueParser">FalseyValueParser</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#1717-1719">source</a></span><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Parse false-like string values, everything else is <code>true</code></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-FalseyValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1711">source</a></span><a href="#impl-Clone-for-FalseyValueParser" 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.FalseyValueParser.html" title="struct clap::builder::FalseyValueParser">FalseyValueParser</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#1711">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) -> <a class="struct" href="struct.FalseyValueParser.html" title="struct clap::builder::FalseyValueParser">FalseyValueParser</a></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-FalseyValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1711">source</a></span><a href="#impl-Debug-for-FalseyValueParser" 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.FalseyValueParser.html" title="struct clap::builder::FalseyValueParser">FalseyValueParser</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#1711">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="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</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-Default-for-FalseyValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1760-1764">source</a></span><a href="#impl-Default-for-FalseyValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.FalseyValueParser.html" title="struct clap::builder::FalseyValueParser">FalseyValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1761-1763">source</a></span><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> Self</h4></section></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-TypedValueParser-for-FalseyValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1730-1758">source</a></span><a href="#impl-TypedValueParser-for-FalseyValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.TypedValueParser.html" title="trait clap::builder::TypedValueParser">TypedValueParser</a> for <a class="struct" href="struct.FalseyValueParser.html" title="struct clap::builder::FalseyValueParser">FalseyValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Value" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Value" class="anchor"></a><h4 class="code-header">type <a href="trait.TypedValueParser.html#associatedtype.Value" class="associatedtype">Value</a> = <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'><p>Argument’s value type</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse_ref" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1733-1751">source</a></span><a href="#method.parse_ref" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#tymethod.parse_ref" class="fnname">parse_ref</a>(<br> &self,<br> cmd: &<a class="struct" href="struct.Command.html" title="struct clap::builder::Command">Command</a>,<br> _arg: <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.Arg.html" title="struct clap::builder::Arg">Arg</a>>,<br> value: &<a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>, <a class="type" href="../type.Error.html" title="type clap::Error">Error</a>></h4></section></summary><div class='docblock'><p>Parse the argument value <a href="trait.TypedValueParser.html#tymethod.parse_ref">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.possible_values" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1753-1757">source</a></span><a href="#method.possible_values" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#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 <a href="trait.TypedValueParser.html#method.possible_values">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#702-709">source</a></span><a href="#method.parse" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.parse" class="fnname">parse</a>(<br> &self,<br> cmd: &<a class="struct" href="struct.Command.html" title="struct clap::builder::Command">Command</a>,<br> arg: <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.Arg.html" title="struct clap::builder::Arg">Arg</a>>,<br> value: <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>, <a class="type" href="../type.Error.html" title="type clap::Error">Error</a>></h4></section></summary><div class='docblock'><p>Parse the argument value <a href="trait.TypedValueParser.html#method.parse">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#757-763">source</a></span><a href="#method.map" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.map" class="fnname">map</a><T, F>(self, func: F) -> <a class="struct" href="struct.MapValueParser.html" title="struct clap::builder::MapValueParser">MapValueParser</a><Self, F> <span class="where fmt-newline">where<br> T: <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> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>) -> 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></h4></section></summary><div class='docblock'><p>Adapt a <code>TypedValueParser</code> from one value to another <a href="trait.TypedValueParser.html#method.map">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_map" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#806-813">source</a></span><a href="#method.try_map" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.try_map" class="fnname">try_map</a><T, E, F>(self, func: F) -> TryMapValueParser<Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</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><T, E> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</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,<br> T: <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> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> E: <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="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/std/error/trait.Error.html" title="trait std::error::Error">Error</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></h4></section></summary><div class='docblock'><p>Adapt a <code>TypedValueParser</code> from one value to another <a href="trait.TypedValueParser.html#method.try_map">Read more</a></p>
|
||||
</div></details></div></details><section id="impl-Copy-for-FalseyValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1711">source</a></span><a href="#impl-Copy-for-FalseyValueParser" 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.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="struct.FalseyValueParser.html" title="struct clap::builder::FalseyValueParser">FalseyValueParser</a></h3></section></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-FalseyValueParser" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-FalseyValueParser" 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.FalseyValueParser.html" title="struct clap::builder::FalseyValueParser">FalseyValueParser</a></h3></section><section id="impl-Send-for-FalseyValueParser" class="impl has-srclink"><a href="#impl-Send-for-FalseyValueParser" 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.FalseyValueParser.html" title="struct clap::builder::FalseyValueParser">FalseyValueParser</a></h3></section><section id="impl-Sync-for-FalseyValueParser" class="impl has-srclink"><a href="#impl-Sync-for-FalseyValueParser" 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.FalseyValueParser.html" title="struct clap::builder::FalseyValueParser">FalseyValueParser</a></h3></section><section id="impl-Unpin-for-FalseyValueParser" class="impl has-srclink"><a href="#impl-Unpin-for-FalseyValueParser" 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.FalseyValueParser.html" title="struct clap::builder::FalseyValueParser">FalseyValueParser</a></h3></section><section id="impl-UnwindSafe-for-FalseyValueParser" class="impl has-srclink"><a href="#impl-UnwindSafe-for-FalseyValueParser" 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.FalseyValueParser.html" title="struct clap::builder::FalseyValueParser">FalseyValueParser</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-FalseyValueParser" 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-FalseyValueParser" 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" 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" 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-FalseyValueParser" 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-FalseyValueParser" 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-FalseyValueParser" 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-FalseyValueParser" 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-FalseyValueParser" 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-FalseyValueParser" 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" 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" 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-FalseyValueParser" 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-FalseyValueParser" 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-FalseyValueParser" 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-FalseyValueParser" 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-FalseyValueParser" 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-FalseyValueParser" 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-FalseyValueParser" 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-FalseyValueParser" 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>
|
||||
28
doc/clap/builder/struct.MapValueParser.html
Normal file
28
doc/clap/builder/struct.MapValueParser.html
Normal file
File diff suppressed because one or more lines are too long
52
doc/clap/builder/struct.NonEmptyStringValueParser.html
Normal file
52
doc/clap/builder/struct.NonEmptyStringValueParser.html
Normal file
File diff suppressed because one or more lines are too long
206
doc/clap/builder/struct.OsStr.html
Normal file
206
doc/clap/builder/struct.OsStr.html
Normal file
File diff suppressed because one or more lines are too long
30
doc/clap/builder/struct.OsStringValueParser.html
Normal file
30
doc/clap/builder/struct.OsStringValueParser.html
Normal file
@ -0,0 +1,30 @@
|
||||
<!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="Implementation for [`ValueParser::os_string`]"><meta name="keywords" content="rust, rustlang, rust-lang, OsStringValueParser"><title>OsStringValueParser 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="#">OsStringValueParser</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.new">new</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-OsStringValueParser">Clone</a></li><li><a href="#impl-Copy-for-OsStringValueParser">Copy</a></li><li><a href="#impl-Debug-for-OsStringValueParser">Debug</a></li><li><a href="#impl-Default-for-OsStringValueParser">Default</a></li><li><a href="#impl-TypedValueParser-for-OsStringValueParser">TypedValueParser</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-OsStringValueParser">RefUnwindSafe</a></li><li><a href="#impl-Send-for-OsStringValueParser">Send</a></li><li><a href="#impl-Sync-for-OsStringValueParser">Sync</a></li><li><a href="#impl-Unpin-for-OsStringValueParser">Unpin</a></li><li><a href="#impl-UnwindSafe-for-OsStringValueParser">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-OsStringValueParser">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-OsStringValueParser">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-OsStringValueParser">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-OsStringValueParser">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-OsStringValueParser">Into<U></a></li><li><a href="#impl-ToOwned-for-OsStringValueParser">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-OsStringValueParser">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-OsStringValueParser">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="#">OsStringValueParser</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#899">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><div class="code-attribute">#[non_exhaustive]</div>pub struct OsStringValueParser {}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Implementation for <a href="struct.ValueParser.html#method.os_string" title="ValueParser::os_string"><code>ValueParser::os_string</code></a></p>
|
||||
<p>Useful for composing new <a href="trait.TypedValueParser.html" title="TypedValueParser"><code>TypedValueParser</code></a>s</p>
|
||||
</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-OsStringValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#901-906">source</a></span><a href="#impl-OsStringValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.OsStringValueParser.html" title="struct clap::builder::OsStringValueParser">OsStringValueParser</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#903-905">source</a></span><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Implementation for <a href="struct.ValueParser.html#method.os_string" title="ValueParser::os_string"><code>ValueParser::os_string</code></a></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-OsStringValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#897">source</a></span><a href="#impl-Clone-for-OsStringValueParser" 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.OsStringValueParser.html" title="struct clap::builder::OsStringValueParser">OsStringValueParser</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#897">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) -> <a class="struct" href="struct.OsStringValueParser.html" title="struct clap::builder::OsStringValueParser">OsStringValueParser</a></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-OsStringValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#897">source</a></span><a href="#impl-Debug-for-OsStringValueParser" 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.OsStringValueParser.html" title="struct clap::builder::OsStringValueParser">OsStringValueParser</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#897">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="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</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-Default-for-OsStringValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#930-934">source</a></span><a href="#impl-Default-for-OsStringValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.OsStringValueParser.html" title="struct clap::builder::OsStringValueParser">OsStringValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#931-933">source</a></span><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> Self</h4></section></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-TypedValueParser-for-OsStringValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#908-928">source</a></span><a href="#impl-TypedValueParser-for-OsStringValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.TypedValueParser.html" title="trait clap::builder::TypedValueParser">TypedValueParser</a> for <a class="struct" href="struct.OsStringValueParser.html" title="struct clap::builder::OsStringValueParser">OsStringValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Value" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Value" class="anchor"></a><h4 class="code-header">type <a href="trait.TypedValueParser.html#associatedtype.Value" class="associatedtype">Value</a> = <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a></h4></section></summary><div class='docblock'><p>Argument’s value type</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse_ref" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#911-918">source</a></span><a href="#method.parse_ref" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#tymethod.parse_ref" class="fnname">parse_ref</a>(<br> &self,<br> cmd: &<a class="struct" href="struct.Command.html" title="struct clap::builder::Command">Command</a>,<br> arg: <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.Arg.html" title="struct clap::builder::Arg">Arg</a>>,<br> value: &<a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>, <a class="type" href="../type.Error.html" title="type clap::Error">Error</a>></h4></section></summary><div class='docblock'><p>Parse the argument value <a href="trait.TypedValueParser.html#tymethod.parse_ref">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#920-927">source</a></span><a href="#method.parse" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.parse" class="fnname">parse</a>(<br> &self,<br> _cmd: &<a class="struct" href="struct.Command.html" title="struct clap::builder::Command">Command</a>,<br> _arg: <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.Arg.html" title="struct clap::builder::Arg">Arg</a>>,<br> value: <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>, <a class="type" href="../type.Error.html" title="type clap::Error">Error</a>></h4></section></summary><div class='docblock'><p>Parse the argument value <a href="trait.TypedValueParser.html#method.parse">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.possible_values" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#715-719">source</a></span><a href="#method.possible_values" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#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 <a href="trait.TypedValueParser.html#method.possible_values">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#757-763">source</a></span><a href="#method.map" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.map" class="fnname">map</a><T, F>(self, func: F) -> <a class="struct" href="struct.MapValueParser.html" title="struct clap::builder::MapValueParser">MapValueParser</a><Self, F> <span class="where fmt-newline">where<br> T: <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> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>) -> 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></h4></section></summary><div class='docblock'><p>Adapt a <code>TypedValueParser</code> from one value to another <a href="trait.TypedValueParser.html#method.map">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_map" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#806-813">source</a></span><a href="#method.try_map" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.try_map" class="fnname">try_map</a><T, E, F>(self, func: F) -> TryMapValueParser<Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</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><T, E> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</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,<br> T: <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> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> E: <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="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/std/error/trait.Error.html" title="trait std::error::Error">Error</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></h4></section></summary><div class='docblock'><p>Adapt a <code>TypedValueParser</code> from one value to another <a href="trait.TypedValueParser.html#method.try_map">Read more</a></p>
|
||||
</div></details></div></details><section id="impl-Copy-for-OsStringValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#897">source</a></span><a href="#impl-Copy-for-OsStringValueParser" 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.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="struct.OsStringValueParser.html" title="struct clap::builder::OsStringValueParser">OsStringValueParser</a></h3></section></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-OsStringValueParser" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-OsStringValueParser" 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.OsStringValueParser.html" title="struct clap::builder::OsStringValueParser">OsStringValueParser</a></h3></section><section id="impl-Send-for-OsStringValueParser" class="impl has-srclink"><a href="#impl-Send-for-OsStringValueParser" 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.OsStringValueParser.html" title="struct clap::builder::OsStringValueParser">OsStringValueParser</a></h3></section><section id="impl-Sync-for-OsStringValueParser" class="impl has-srclink"><a href="#impl-Sync-for-OsStringValueParser" 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.OsStringValueParser.html" title="struct clap::builder::OsStringValueParser">OsStringValueParser</a></h3></section><section id="impl-Unpin-for-OsStringValueParser" class="impl has-srclink"><a href="#impl-Unpin-for-OsStringValueParser" 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.OsStringValueParser.html" title="struct clap::builder::OsStringValueParser">OsStringValueParser</a></h3></section><section id="impl-UnwindSafe-for-OsStringValueParser" class="impl has-srclink"><a href="#impl-UnwindSafe-for-OsStringValueParser" 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.OsStringValueParser.html" title="struct clap::builder::OsStringValueParser">OsStringValueParser</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-OsStringValueParser" 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-OsStringValueParser" 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" 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" 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-OsStringValueParser" 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-OsStringValueParser" 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-OsStringValueParser" 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-OsStringValueParser" 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-OsStringValueParser" 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-OsStringValueParser" 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" 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" 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-OsStringValueParser" 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-OsStringValueParser" 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-OsStringValueParser" 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-OsStringValueParser" 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-OsStringValueParser" 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-OsStringValueParser" 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-OsStringValueParser" 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-OsStringValueParser" 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>
|
||||
30
doc/clap/builder/struct.PathBufValueParser.html
Normal file
30
doc/clap/builder/struct.PathBufValueParser.html
Normal file
@ -0,0 +1,30 @@
|
||||
<!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="Implementation for [`ValueParser::path_buf`]"><meta name="keywords" content="rust, rustlang, rust-lang, PathBufValueParser"><title>PathBufValueParser 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="#">PathBufValueParser</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.new">new</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-PathBufValueParser">Clone</a></li><li><a href="#impl-Copy-for-PathBufValueParser">Copy</a></li><li><a href="#impl-Debug-for-PathBufValueParser">Debug</a></li><li><a href="#impl-Default-for-PathBufValueParser">Default</a></li><li><a href="#impl-TypedValueParser-for-PathBufValueParser">TypedValueParser</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-PathBufValueParser">RefUnwindSafe</a></li><li><a href="#impl-Send-for-PathBufValueParser">Send</a></li><li><a href="#impl-Sync-for-PathBufValueParser">Sync</a></li><li><a href="#impl-Unpin-for-PathBufValueParser">Unpin</a></li><li><a href="#impl-UnwindSafe-for-PathBufValueParser">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-PathBufValueParser">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-PathBufValueParser">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-PathBufValueParser">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-PathBufValueParser">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-PathBufValueParser">Into<U></a></li><li><a href="#impl-ToOwned-for-PathBufValueParser">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-PathBufValueParser">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-PathBufValueParser">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="#">PathBufValueParser</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#941">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><div class="code-attribute">#[non_exhaustive]</div>pub struct PathBufValueParser {}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Implementation for <a href="struct.ValueParser.html#method.path_buf" title="ValueParser::path_buf"><code>ValueParser::path_buf</code></a></p>
|
||||
<p>Useful for composing new <a href="trait.TypedValueParser.html" title="TypedValueParser"><code>TypedValueParser</code></a>s</p>
|
||||
</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-PathBufValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#943-948">source</a></span><a href="#impl-PathBufValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.PathBufValueParser.html" title="struct clap::builder::PathBufValueParser">PathBufValueParser</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#945-947">source</a></span><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Implementation for <a href="struct.ValueParser.html#method.path_buf" title="ValueParser::path_buf"><code>ValueParser::path_buf</code></a></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-PathBufValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#939">source</a></span><a href="#impl-Clone-for-PathBufValueParser" 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.PathBufValueParser.html" title="struct clap::builder::PathBufValueParser">PathBufValueParser</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#939">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) -> <a class="struct" href="struct.PathBufValueParser.html" title="struct clap::builder::PathBufValueParser">PathBufValueParser</a></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-PathBufValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#939">source</a></span><a href="#impl-Debug-for-PathBufValueParser" 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.PathBufValueParser.html" title="struct clap::builder::PathBufValueParser">PathBufValueParser</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#939">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="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</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-Default-for-PathBufValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#980-984">source</a></span><a href="#impl-Default-for-PathBufValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.PathBufValueParser.html" title="struct clap::builder::PathBufValueParser">PathBufValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#981-983">source</a></span><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> Self</h4></section></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-TypedValueParser-for-PathBufValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#950-978">source</a></span><a href="#impl-TypedValueParser-for-PathBufValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.TypedValueParser.html" title="trait clap::builder::TypedValueParser">TypedValueParser</a> for <a class="struct" href="struct.PathBufValueParser.html" title="struct clap::builder::PathBufValueParser">PathBufValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Value" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Value" class="anchor"></a><h4 class="code-header">type <a href="trait.TypedValueParser.html#associatedtype.Value" class="associatedtype">Value</a> = <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a></h4></section></summary><div class='docblock'><p>Argument’s value type</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse_ref" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#953-960">source</a></span><a href="#method.parse_ref" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#tymethod.parse_ref" class="fnname">parse_ref</a>(<br> &self,<br> cmd: &<a class="struct" href="struct.Command.html" title="struct clap::builder::Command">Command</a>,<br> arg: <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.Arg.html" title="struct clap::builder::Arg">Arg</a>>,<br> value: &<a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>, <a class="type" href="../type.Error.html" title="type clap::Error">Error</a>></h4></section></summary><div class='docblock'><p>Parse the argument value <a href="trait.TypedValueParser.html#tymethod.parse_ref">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#962-977">source</a></span><a href="#method.parse" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.parse" class="fnname">parse</a>(<br> &self,<br> cmd: &<a class="struct" href="struct.Command.html" title="struct clap::builder::Command">Command</a>,<br> arg: <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.Arg.html" title="struct clap::builder::Arg">Arg</a>>,<br> value: <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>, <a class="type" href="../type.Error.html" title="type clap::Error">Error</a>></h4></section></summary><div class='docblock'><p>Parse the argument value <a href="trait.TypedValueParser.html#method.parse">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.possible_values" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#715-719">source</a></span><a href="#method.possible_values" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#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 <a href="trait.TypedValueParser.html#method.possible_values">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#757-763">source</a></span><a href="#method.map" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.map" class="fnname">map</a><T, F>(self, func: F) -> <a class="struct" href="struct.MapValueParser.html" title="struct clap::builder::MapValueParser">MapValueParser</a><Self, F> <span class="where fmt-newline">where<br> T: <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> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>) -> 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></h4></section></summary><div class='docblock'><p>Adapt a <code>TypedValueParser</code> from one value to another <a href="trait.TypedValueParser.html#method.map">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_map" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#806-813">source</a></span><a href="#method.try_map" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.try_map" class="fnname">try_map</a><T, E, F>(self, func: F) -> TryMapValueParser<Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</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><T, E> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</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,<br> T: <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> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> E: <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="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/std/error/trait.Error.html" title="trait std::error::Error">Error</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></h4></section></summary><div class='docblock'><p>Adapt a <code>TypedValueParser</code> from one value to another <a href="trait.TypedValueParser.html#method.try_map">Read more</a></p>
|
||||
</div></details></div></details><section id="impl-Copy-for-PathBufValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#939">source</a></span><a href="#impl-Copy-for-PathBufValueParser" 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.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="struct.PathBufValueParser.html" title="struct clap::builder::PathBufValueParser">PathBufValueParser</a></h3></section></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-PathBufValueParser" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-PathBufValueParser" 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.PathBufValueParser.html" title="struct clap::builder::PathBufValueParser">PathBufValueParser</a></h3></section><section id="impl-Send-for-PathBufValueParser" class="impl has-srclink"><a href="#impl-Send-for-PathBufValueParser" 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.PathBufValueParser.html" title="struct clap::builder::PathBufValueParser">PathBufValueParser</a></h3></section><section id="impl-Sync-for-PathBufValueParser" class="impl has-srclink"><a href="#impl-Sync-for-PathBufValueParser" 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.PathBufValueParser.html" title="struct clap::builder::PathBufValueParser">PathBufValueParser</a></h3></section><section id="impl-Unpin-for-PathBufValueParser" class="impl has-srclink"><a href="#impl-Unpin-for-PathBufValueParser" 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.PathBufValueParser.html" title="struct clap::builder::PathBufValueParser">PathBufValueParser</a></h3></section><section id="impl-UnwindSafe-for-PathBufValueParser" class="impl has-srclink"><a href="#impl-UnwindSafe-for-PathBufValueParser" 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.PathBufValueParser.html" title="struct clap::builder::PathBufValueParser">PathBufValueParser</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-PathBufValueParser" 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-PathBufValueParser" 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" 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" 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-PathBufValueParser" 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-PathBufValueParser" 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-PathBufValueParser" 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-PathBufValueParser" 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-PathBufValueParser" 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-PathBufValueParser" 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" 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" 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-PathBufValueParser" 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-PathBufValueParser" 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-PathBufValueParser" 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-PathBufValueParser" 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-PathBufValueParser" 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-PathBufValueParser" 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-PathBufValueParser" 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-PathBufValueParser" 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>
|
||||
82
doc/clap/builder/struct.PossibleValue.html
Normal file
82
doc/clap/builder/struct.PossibleValue.html
Normal file
File diff suppressed because one or more lines are too long
57
doc/clap/builder/struct.PossibleValuesParser.html
Normal file
57
doc/clap/builder/struct.PossibleValuesParser.html
Normal file
@ -0,0 +1,57 @@
|
||||
<!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="Verify the value is from an enumerated set of [`PossibleValue`][crate::builder::PossibleValue]."><meta name="keywords" content="rust, rustlang, rust-lang, PossibleValuesParser"><title>PossibleValuesParser 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="#">PossibleValuesParser</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.new">new</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-PossibleValuesParser">Clone</a></li><li><a href="#impl-Debug-for-PossibleValuesParser">Debug</a></li><li><a href="#impl-From%3CI%3E-for-PossibleValuesParser">From<I></a></li><li><a href="#impl-TypedValueParser-for-PossibleValuesParser">TypedValueParser</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-PossibleValuesParser">RefUnwindSafe</a></li><li><a href="#impl-Send-for-PossibleValuesParser">Send</a></li><li><a href="#impl-Sync-for-PossibleValuesParser">Sync</a></li><li><a href="#impl-Unpin-for-PossibleValuesParser">Unpin</a></li><li><a href="#impl-UnwindSafe-for-PossibleValuesParser">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-PossibleValuesParser">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-PossibleValuesParser">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-PossibleValuesParser">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-PossibleValuesParser">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-PossibleValuesParser">Into<U></a></li><li><a href="#impl-ToOwned-for-PossibleValuesParser">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-PossibleValuesParser">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-PossibleValuesParser">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="#">PossibleValuesParser</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#1139">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 PossibleValuesParser(_);</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Verify the value is from an enumerated set of <a href="struct.PossibleValue.html" title="crate::builder::PossibleValue"><code>PossibleValue</code></a>.</p>
|
||||
<p>See also:</p>
|
||||
<ul>
|
||||
<li><a href="struct.EnumValueParser.html" title="EnumValueParser"><code>EnumValueParser</code></a> for directly supporting <a href="../trait.ValueEnum.html" title="crate::ValueEnum"><code>ValueEnum</code></a> types</li>
|
||||
<li><a href="trait.TypedValueParser.html#method.map" title="TypedValueParser::map"><code>TypedValueParser::map</code></a> for adapting values to a more specialized type, like an external
|
||||
enums that can’t implement <a href="../trait.ValueEnum.html" title="crate::ValueEnum"><code>ValueEnum</code></a></li>
|
||||
</ul>
|
||||
<h2 id="example"><a href="#example">Example</a></h2>
|
||||
<p>Usage:</p>
|
||||
|
||||
<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">value_parser</span>(<span class="ident">clap::builder::PossibleValuesParser::new</span>([<span class="string">"always"</span>, <span class="string">"auto"</span>, <span class="string">"never"</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">"always"</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">"color"</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">"always"</span>);</code></pre></div>
|
||||
<p>Semantics:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">value_parser</span> <span class="op">=</span> <span class="ident">clap::builder::PossibleValuesParser::new</span>([<span class="string">"always"</span>, <span class="string">"auto"</span>, <span class="string">"never"</span>]);
|
||||
<span class="macro">assert!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"random"</span>)).<span class="ident">is_err</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">""</span>)).<span class="ident">is_err</span>());
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"always"</span>)).<span class="ident">unwrap</span>(), <span class="string">"always"</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"auto"</span>)).<span class="ident">unwrap</span>(), <span class="string">"auto"</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value_parser</span>.<span class="ident">parse_ref</span>(<span class="kw-2">&</span><span class="ident">cmd</span>, <span class="ident">arg</span>, <span class="ident">OsStr::new</span>(<span class="string">"never"</span>)).<span class="ident">unwrap</span>(), <span class="string">"never"</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-PossibleValuesParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1141-1146">source</a></span><a href="#impl-PossibleValuesParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.PossibleValuesParser.html" title="struct clap::builder::PossibleValuesParser">PossibleValuesParser</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#1143-1145">source</a></span><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>(values: impl <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.PossibleValuesParser.html" title="struct clap::builder::PossibleValuesParser">PossibleValuesParser</a>>) -> Self</h4></section></summary><div class="docblock"><p>Verify the value is from an enumerated set pf <a href="struct.PossibleValue.html" title="crate::builder::PossibleValue"><code>PossibleValue</code></a>.</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-PossibleValuesParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1138">source</a></span><a href="#impl-Clone-for-PossibleValuesParser" 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.PossibleValuesParser.html" title="struct clap::builder::PossibleValuesParser">PossibleValuesParser</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#1138">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) -> <a class="struct" href="struct.PossibleValuesParser.html" title="struct clap::builder::PossibleValuesParser">PossibleValuesParser</a></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-PossibleValuesParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1138">source</a></span><a href="#impl-Debug-for-PossibleValuesParser" 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.PossibleValuesParser.html" title="struct clap::builder::PossibleValuesParser">PossibleValuesParser</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#1138">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="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</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%3CI%3E-for-PossibleValuesParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1201-1209">source</a></span><a href="#impl-From%3CI%3E-for-PossibleValuesParser" class="anchor"></a><h3 class="code-header in-band">impl<I, 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><I> for <a class="struct" href="struct.PossibleValuesParser.html" title="struct clap::builder::PossibleValuesParser">PossibleValuesParser</a> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,<br> T: <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="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#1206-1208">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>(values: I) -> 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-TypedValueParser-for-PossibleValuesParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1148-1199">source</a></span><a href="#impl-TypedValueParser-for-PossibleValuesParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.TypedValueParser.html" title="trait clap::builder::TypedValueParser">TypedValueParser</a> for <a class="struct" href="struct.PossibleValuesParser.html" title="struct clap::builder::PossibleValuesParser">PossibleValuesParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Value" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Value" class="anchor"></a><h4 class="code-header">type <a href="trait.TypedValueParser.html#associatedtype.Value" class="associatedtype">Value</a> = <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class='docblock'><p>Argument’s value type</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse_ref" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1151-1158">source</a></span><a href="#method.parse_ref" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#tymethod.parse_ref" class="fnname">parse_ref</a>(<br> &self,<br> cmd: &<a class="struct" href="struct.Command.html" title="struct clap::builder::Command">Command</a>,<br> arg: <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.Arg.html" title="struct clap::builder::Arg">Arg</a>>,<br> value: &<a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>, <a class="type" href="../type.Error.html" title="type clap::Error">Error</a>></h4></section></summary><div class='docblock'><p>Parse the argument value <a href="trait.TypedValueParser.html#tymethod.parse_ref">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1160-1192">source</a></span><a href="#method.parse" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.parse" class="fnname">parse</a>(<br> &self,<br> cmd: &<a class="struct" href="struct.Command.html" title="struct clap::builder::Command">Command</a>,<br> arg: <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.Arg.html" title="struct clap::builder::Arg">Arg</a>>,<br> value: <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a><br>) -> <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="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="type" href="../type.Error.html" title="type clap::Error">Error</a>></h4></section></summary><div class='docblock'><p>Parse the argument value <a href="trait.TypedValueParser.html#method.parse">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.possible_values" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#1194-1198">source</a></span><a href="#method.possible_values" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#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 <a href="trait.TypedValueParser.html#method.possible_values">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#757-763">source</a></span><a href="#method.map" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.map" class="fnname">map</a><T, F>(self, func: F) -> <a class="struct" href="struct.MapValueParser.html" title="struct clap::builder::MapValueParser">MapValueParser</a><Self, F> <span class="where fmt-newline">where<br> T: <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> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>) -> 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></h4></section></summary><div class='docblock'><p>Adapt a <code>TypedValueParser</code> from one value to another <a href="trait.TypedValueParser.html#method.map">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_map" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#806-813">source</a></span><a href="#method.try_map" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.try_map" class="fnname">try_map</a><T, E, F>(self, func: F) -> TryMapValueParser<Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</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><T, E> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</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,<br> T: <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> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> E: <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="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/std/error/trait.Error.html" title="trait std::error::Error">Error</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></h4></section></summary><div class='docblock'><p>Adapt a <code>TypedValueParser</code> from one value to another <a href="trait.TypedValueParser.html#method.try_map">Read more</a></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-PossibleValuesParser" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-PossibleValuesParser" 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.PossibleValuesParser.html" title="struct clap::builder::PossibleValuesParser">PossibleValuesParser</a></h3></section><section id="impl-Send-for-PossibleValuesParser" class="impl has-srclink"><a href="#impl-Send-for-PossibleValuesParser" 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.PossibleValuesParser.html" title="struct clap::builder::PossibleValuesParser">PossibleValuesParser</a></h3></section><section id="impl-Sync-for-PossibleValuesParser" class="impl has-srclink"><a href="#impl-Sync-for-PossibleValuesParser" 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.PossibleValuesParser.html" title="struct clap::builder::PossibleValuesParser">PossibleValuesParser</a></h3></section><section id="impl-Unpin-for-PossibleValuesParser" class="impl has-srclink"><a href="#impl-Unpin-for-PossibleValuesParser" 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.PossibleValuesParser.html" title="struct clap::builder::PossibleValuesParser">PossibleValuesParser</a></h3></section><section id="impl-UnwindSafe-for-PossibleValuesParser" class="impl has-srclink"><a href="#impl-UnwindSafe-for-PossibleValuesParser" 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.PossibleValuesParser.html" title="struct clap::builder::PossibleValuesParser">PossibleValuesParser</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-PossibleValuesParser" 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-PossibleValuesParser" 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" 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" 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-PossibleValuesParser" 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-PossibleValuesParser" 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-PossibleValuesParser" 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-PossibleValuesParser" 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-PossibleValuesParser" 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-PossibleValuesParser" 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-1" 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-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>(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-PossibleValuesParser" 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-PossibleValuesParser" 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-PossibleValuesParser" 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-PossibleValuesParser" 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-PossibleValuesParser" 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-PossibleValuesParser" 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-PossibleValuesParser" 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-PossibleValuesParser" 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>
|
||||
60
doc/clap/builder/struct.RangedI64ValueParser.html
Normal file
60
doc/clap/builder/struct.RangedI64ValueParser.html
Normal file
File diff suppressed because one or more lines are too long
57
doc/clap/builder/struct.RangedU64ValueParser.html
Normal file
57
doc/clap/builder/struct.RangedU64ValueParser.html
Normal file
File diff suppressed because one or more lines are too long
1258
doc/clap/builder/struct.Str.html
Normal file
1258
doc/clap/builder/struct.Str.html
Normal file
File diff suppressed because one or more lines are too long
30
doc/clap/builder/struct.StringValueParser.html
Normal file
30
doc/clap/builder/struct.StringValueParser.html
Normal file
@ -0,0 +1,30 @@
|
||||
<!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="Implementation for [`ValueParser::string`]"><meta name="keywords" content="rust, rustlang, rust-lang, StringValueParser"><title>StringValueParser 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="#">StringValueParser</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.new">new</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-StringValueParser">Clone</a></li><li><a href="#impl-Copy-for-StringValueParser">Copy</a></li><li><a href="#impl-Debug-for-StringValueParser">Debug</a></li><li><a href="#impl-Default-for-StringValueParser">Default</a></li><li><a href="#impl-TypedValueParser-for-StringValueParser">TypedValueParser</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-StringValueParser">RefUnwindSafe</a></li><li><a href="#impl-Send-for-StringValueParser">Send</a></li><li><a href="#impl-Sync-for-StringValueParser">Sync</a></li><li><a href="#impl-Unpin-for-StringValueParser">Unpin</a></li><li><a href="#impl-UnwindSafe-for-StringValueParser">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-StringValueParser">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-StringValueParser">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-StringValueParser">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-StringValueParser">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-StringValueParser">Into<U></a></li><li><a href="#impl-ToOwned-for-StringValueParser">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-StringValueParser">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-StringValueParser">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="#">StringValueParser</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#851">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><div class="code-attribute">#[non_exhaustive]</div>pub struct StringValueParser {}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Implementation for <a href="struct.ValueParser.html#method.string" title="ValueParser::string"><code>ValueParser::string</code></a></p>
|
||||
<p>Useful for composing new <a href="trait.TypedValueParser.html" title="TypedValueParser"><code>TypedValueParser</code></a>s</p>
|
||||
</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-StringValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#853-858">source</a></span><a href="#impl-StringValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.StringValueParser.html" title="struct clap::builder::StringValueParser">StringValueParser</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#855-857">source</a></span><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Implementation for <a href="struct.ValueParser.html#method.string" title="ValueParser::string"><code>ValueParser::string</code></a></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-StringValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#849">source</a></span><a href="#impl-Clone-for-StringValueParser" 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.StringValueParser.html" title="struct clap::builder::StringValueParser">StringValueParser</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#849">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) -> <a class="struct" href="struct.StringValueParser.html" title="struct clap::builder::StringValueParser">StringValueParser</a></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-StringValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#849">source</a></span><a href="#impl-Debug-for-StringValueParser" 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.StringValueParser.html" title="struct clap::builder::StringValueParser">StringValueParser</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#849">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="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</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-Default-for-StringValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#888-892">source</a></span><a href="#impl-Default-for-StringValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.StringValueParser.html" title="struct clap::builder::StringValueParser">StringValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#889-891">source</a></span><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> Self</h4></section></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-TypedValueParser-for-StringValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#860-886">source</a></span><a href="#impl-TypedValueParser-for-StringValueParser" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.TypedValueParser.html" title="trait clap::builder::TypedValueParser">TypedValueParser</a> for <a class="struct" href="struct.StringValueParser.html" title="struct clap::builder::StringValueParser">StringValueParser</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Value" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Value" class="anchor"></a><h4 class="code-header">type <a href="trait.TypedValueParser.html#associatedtype.Value" class="associatedtype">Value</a> = <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class='docblock'><p>Argument’s value type</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse_ref" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#863-870">source</a></span><a href="#method.parse_ref" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#tymethod.parse_ref" class="fnname">parse_ref</a>(<br> &self,<br> cmd: &<a class="struct" href="struct.Command.html" title="struct clap::builder::Command">Command</a>,<br> arg: <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.Arg.html" title="struct clap::builder::Arg">Arg</a>>,<br> value: &<a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>, <a class="type" href="../type.Error.html" title="type clap::Error">Error</a>></h4></section></summary><div class='docblock'><p>Parse the argument value <a href="trait.TypedValueParser.html#tymethod.parse_ref">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#872-885">source</a></span><a href="#method.parse" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.parse" class="fnname">parse</a>(<br> &self,<br> cmd: &<a class="struct" href="struct.Command.html" title="struct clap::builder::Command">Command</a>,<br> _arg: <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.Arg.html" title="struct clap::builder::Arg">Arg</a>>,<br> value: <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>, <a class="type" href="../type.Error.html" title="type clap::Error">Error</a>></h4></section></summary><div class='docblock'><p>Parse the argument value <a href="trait.TypedValueParser.html#method.parse">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.possible_values" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#715-719">source</a></span><a href="#method.possible_values" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#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 <a href="trait.TypedValueParser.html#method.possible_values">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#757-763">source</a></span><a href="#method.map" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.map" class="fnname">map</a><T, F>(self, func: F) -> <a class="struct" href="struct.MapValueParser.html" title="struct clap::builder::MapValueParser">MapValueParser</a><Self, F> <span class="where fmt-newline">where<br> T: <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> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</a>) -> 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></h4></section></summary><div class='docblock'><p>Adapt a <code>TypedValueParser</code> from one value to another <a href="trait.TypedValueParser.html#method.map">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_map" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#806-813">source</a></span><a href="#method.try_map" class="anchor"></a><h4 class="code-header">fn <a href="trait.TypedValueParser.html#method.try_map" class="fnname">try_map</a><T, E, F>(self, func: F) -> TryMapValueParser<Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Self::<a class="associatedtype" href="trait.TypedValueParser.html#associatedtype.Value" title="type clap::builder::TypedValueParser::Value">Value</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><T, E> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</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,<br> T: <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> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> E: <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="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/std/error/trait.Error.html" title="trait std::error::Error">Error</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></h4></section></summary><div class='docblock'><p>Adapt a <code>TypedValueParser</code> from one value to another <a href="trait.TypedValueParser.html#method.try_map">Read more</a></p>
|
||||
</div></details></div></details><section id="impl-Copy-for-StringValueParser" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/builder/value_parser.rs.html#849">source</a></span><a href="#impl-Copy-for-StringValueParser" 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.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="struct.StringValueParser.html" title="struct clap::builder::StringValueParser">StringValueParser</a></h3></section></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-StringValueParser" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-StringValueParser" 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.StringValueParser.html" title="struct clap::builder::StringValueParser">StringValueParser</a></h3></section><section id="impl-Send-for-StringValueParser" class="impl has-srclink"><a href="#impl-Send-for-StringValueParser" 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.StringValueParser.html" title="struct clap::builder::StringValueParser">StringValueParser</a></h3></section><section id="impl-Sync-for-StringValueParser" class="impl has-srclink"><a href="#impl-Sync-for-StringValueParser" 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.StringValueParser.html" title="struct clap::builder::StringValueParser">StringValueParser</a></h3></section><section id="impl-Unpin-for-StringValueParser" class="impl has-srclink"><a href="#impl-Unpin-for-StringValueParser" 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.StringValueParser.html" title="struct clap::builder::StringValueParser">StringValueParser</a></h3></section><section id="impl-UnwindSafe-for-StringValueParser" class="impl has-srclink"><a href="#impl-UnwindSafe-for-StringValueParser" 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.StringValueParser.html" title="struct clap::builder::StringValueParser">StringValueParser</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-StringValueParser" 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-StringValueParser" 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" 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" 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-StringValueParser" 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-StringValueParser" 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-StringValueParser" 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-StringValueParser" 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-StringValueParser" 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-StringValueParser" 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" 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" 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-StringValueParser" 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-StringValueParser" 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-StringValueParser" 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-StringValueParser" 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-StringValueParser" 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-StringValueParser" 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-StringValueParser" 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-StringValueParser" 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>
|
||||
50
doc/clap/builder/struct.StyledStr.html
Normal file
50
doc/clap/builder/struct.StyledStr.html
Normal file
File diff suppressed because one or more lines are too long
343
doc/clap/builder/struct.ValueParser.html
Normal file
343
doc/clap/builder/struct.ValueParser.html
Normal file
@ -0,0 +1,343 @@
|
||||
<!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>
|
||||
64
doc/clap/builder/struct.ValueRange.html
Normal file
64
doc/clap/builder/struct.ValueRange.html
Normal file
File diff suppressed because one or more lines are too long
11
doc/clap/builder/styled_str/struct.StyledStr.html
Normal file
11
doc/clap/builder/styled_str/struct.StyledStr.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.StyledStr.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.StyledStr.html">../../../clap/builder/struct.StyledStr.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.StyledStr.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
7
doc/clap/builder/trait.IntoResettable.html
Normal file
7
doc/clap/builder/trait.IntoResettable.html
Normal file
File diff suppressed because one or more lines are too long
120
doc/clap/builder/trait.TypedValueParser.html
Normal file
120
doc/clap/builder/trait.TypedValueParser.html
Normal file
File diff suppressed because one or more lines are too long
41
doc/clap/builder/trait.ValueParserFactory.html
Normal file
41
doc/clap/builder/trait.ValueParserFactory.html
Normal file
File diff suppressed because one or more lines are too long
11
doc/clap/builder/value_hint/enum.ValueHint.html
Normal file
11
doc/clap/builder/value_hint/enum.ValueHint.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/enum.ValueHint.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/enum.ValueHint.html">../../../clap/builder/enum.ValueHint.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/enum.ValueHint.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/value_parser/struct.BoolValueParser.html
Normal file
11
doc/clap/builder/value_parser/struct.BoolValueParser.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.BoolValueParser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.BoolValueParser.html">../../../clap/builder/struct.BoolValueParser.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.BoolValueParser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/value_parser/struct.BoolishValueParser.html
Normal file
11
doc/clap/builder/value_parser/struct.BoolishValueParser.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.BoolishValueParser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.BoolishValueParser.html">../../../clap/builder/struct.BoolishValueParser.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.BoolishValueParser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/value_parser/struct.EnumValueParser.html
Normal file
11
doc/clap/builder/value_parser/struct.EnumValueParser.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.EnumValueParser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.EnumValueParser.html">../../../clap/builder/struct.EnumValueParser.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.EnumValueParser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/value_parser/struct.FalseyValueParser.html
Normal file
11
doc/clap/builder/value_parser/struct.FalseyValueParser.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.FalseyValueParser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.FalseyValueParser.html">../../../clap/builder/struct.FalseyValueParser.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.FalseyValueParser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/value_parser/struct.MapValueParser.html
Normal file
11
doc/clap/builder/value_parser/struct.MapValueParser.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.MapValueParser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.MapValueParser.html">../../../clap/builder/struct.MapValueParser.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.MapValueParser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.NonEmptyStringValueParser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.NonEmptyStringValueParser.html">../../../clap/builder/struct.NonEmptyStringValueParser.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.NonEmptyStringValueParser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.OsStringValueParser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.OsStringValueParser.html">../../../clap/builder/struct.OsStringValueParser.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.OsStringValueParser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/value_parser/struct.PathBufValueParser.html
Normal file
11
doc/clap/builder/value_parser/struct.PathBufValueParser.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.PathBufValueParser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.PathBufValueParser.html">../../../clap/builder/struct.PathBufValueParser.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.PathBufValueParser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.PossibleValuesParser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.PossibleValuesParser.html">../../../clap/builder/struct.PossibleValuesParser.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.PossibleValuesParser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.RangedI64ValueParser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.RangedI64ValueParser.html">../../../clap/builder/struct.RangedI64ValueParser.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.RangedI64ValueParser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.RangedU64ValueParser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.RangedU64ValueParser.html">../../../clap/builder/struct.RangedU64ValueParser.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.RangedU64ValueParser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/value_parser/struct.StringValueParser.html
Normal file
11
doc/clap/builder/value_parser/struct.StringValueParser.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.StringValueParser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.StringValueParser.html">../../../clap/builder/struct.StringValueParser.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.StringValueParser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/value_parser/struct.ValueParser.html
Normal file
11
doc/clap/builder/value_parser/struct.ValueParser.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/struct.ValueParser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/struct.ValueParser.html">../../../clap/builder/struct.ValueParser.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/struct.ValueParser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/value_parser/trait.TypedValueParser.html
Normal file
11
doc/clap/builder/value_parser/trait.TypedValueParser.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/trait.TypedValueParser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/trait.TypedValueParser.html">../../../clap/builder/trait.TypedValueParser.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/trait.TypedValueParser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/builder/value_parser/trait.ValueParserFactory.html
Normal file
11
doc/clap/builder/value_parser/trait.ValueParserFactory.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/builder/trait.ValueParserFactory.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/builder/trait.ValueParserFactory.html">../../../clap/builder/trait.ValueParserFactory.html</a>...</p>
|
||||
<script>location.replace("../../../clap/builder/trait.ValueParserFactory.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/derive/trait.Args.html
Normal file
11
doc/clap/derive/trait.Args.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../clap/trait.Args.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../clap/trait.Args.html">../../clap/trait.Args.html</a>...</p>
|
||||
<script>location.replace("../../clap/trait.Args.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/derive/trait.CommandFactory.html
Normal file
11
doc/clap/derive/trait.CommandFactory.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../clap/trait.CommandFactory.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../clap/trait.CommandFactory.html">../../clap/trait.CommandFactory.html</a>...</p>
|
||||
<script>location.replace("../../clap/trait.CommandFactory.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/derive/trait.FromArgMatches.html
Normal file
11
doc/clap/derive/trait.FromArgMatches.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../clap/trait.FromArgMatches.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../clap/trait.FromArgMatches.html">../../clap/trait.FromArgMatches.html</a>...</p>
|
||||
<script>location.replace("../../clap/trait.FromArgMatches.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/derive/trait.Parser.html
Normal file
11
doc/clap/derive/trait.Parser.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../clap/trait.Parser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../clap/trait.Parser.html">../../clap/trait.Parser.html</a>...</p>
|
||||
<script>location.replace("../../clap/trait.Parser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/derive/trait.Subcommand.html
Normal file
11
doc/clap/derive/trait.Subcommand.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../clap/trait.Subcommand.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../clap/trait.Subcommand.html">../../clap/trait.Subcommand.html</a>...</p>
|
||||
<script>location.replace("../../clap/trait.Subcommand.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/derive/trait.ValueEnum.html
Normal file
11
doc/clap/derive/trait.ValueEnum.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../clap/trait.ValueEnum.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../clap/trait.ValueEnum.html">../../clap/trait.ValueEnum.html</a>...</p>
|
||||
<script>location.replace("../../clap/trait.ValueEnum.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
228
doc/clap/enum.ArgAction.html
Normal file
228
doc/clap/enum.ArgAction.html
Normal file
@ -0,0 +1,228 @@
|
||||
<!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="Behavior of arguments when they are encountered while parsing"><meta name="keywords" content="rust, rustlang, rust-lang, ArgAction"><title>ArgAction 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" 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 enum"><!--[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="#">ArgAction</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#variants">Variants</a></h3><ul><li><a href="#variant.Append">Append</a></li><li><a href="#variant.Count">Count</a></li><li><a href="#variant.Help">Help</a></li><li><a href="#variant.Set">Set</a></li><li><a href="#variant.SetFalse">SetFalse</a></li><li><a href="#variant.SetTrue">SetTrue</a></li><li><a href="#variant.Version">Version</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul><li><a href="#method.takes_values">takes_values</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-ArgAction">Clone</a></li><li><a href="#impl-Debug-for-ArgAction">Debug</a></li><li><a href="#impl-IntoResettable%3CArgAction%3E-for-ArgAction">IntoResettable<ArgAction></a></li><li><a href="#impl-IntoResettable%3CArgAction%3E-for-Option%3CArgAction%3E">IntoResettable<ArgAction></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-ArgAction">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ArgAction">Send</a></li><li><a href="#impl-Sync-for-ArgAction">Sync</a></li><li><a href="#impl-Unpin-for-ArgAction">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ArgAction">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-ArgAction">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ArgAction">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ArgAction">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-ArgAction">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-ArgAction">Into<U></a></li><li><a href="#impl-ToOwned-for-ArgAction">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-ArgAction">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-ArgAction">TryInto<U></a></li></ul></div></section><h2 class="location"><a href="index.html">In clap</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">Enum <a href="index.html">clap</a>::<wbr><a class="enum" href="#">ArgAction</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/action.rs.html#27-273">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 enum"><code>#[non_exhaustive]
|
||||
pub enum ArgAction {
|
||||
Set,
|
||||
Append,
|
||||
SetTrue,
|
||||
SetFalse,
|
||||
Count,
|
||||
Help,
|
||||
Version,
|
||||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Behavior of arguments when they are encountered while parsing</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> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"special-help"</span>)
|
||||
.<span class="ident">short</span>(<span class="string">'?'</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Help</span>)
|
||||
);
|
||||
|
||||
<span class="comment">// Existing help still exists</span>
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"-h"</span>]).<span class="ident">unwrap_err</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayHelp</span>);
|
||||
|
||||
<span class="comment">// New help available</span>
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"-?"</span>]).<span class="ident">unwrap_err</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayHelp</span>);</code></pre></div>
|
||||
</div></details><h2 id="variants" class="variants small-section-header">Variants (Non-exhaustive)<a href="#variants" class="anchor"></a></h2><details class="rustdoc-toggle non-exhaustive"><summary class="hideme"><span>This enum is marked as non-exhaustive</span></summary><div class="docblock">Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.</div></details><h3 id="variant.Set" class="variant small-section-header"><a href="#variant.Set" class="anchor field"></a><code>Set</code></h3><div class="docblock"><p>When encountered, store the associated value(s) in <a href="parser/struct.ArgMatches.html" title="crate::ArgMatches"><code>ArgMatches</code></a></p>
|
||||
<p><strong>NOTE:</strong> If the argument has previously been seen, it will result in a
|
||||
<a href="error/enum.ErrorKind.html#variant.ArgumentConflict" title="crate::error::ErrorKind::ArgumentConflict"><code>ArgumentConflict</code></a> unless
|
||||
<a href="builder/struct.Command.html#method.args_override_self" title="crate::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</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="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Set</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>, <span class="string">"value"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_many</span>::<span class="op"><</span><span class="ident">String</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">unwrap_or_default</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">as_str</span>()).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span><span class="op">></span>(),
|
||||
<span class="macro">vec!</span>[<span class="string">"value"</span>]
|
||||
);</code></pre></div>
|
||||
</div><h3 id="variant.Append" class="variant small-section-header"><a href="#variant.Append" class="anchor field"></a><code>Append</code></h3><div class="docblock"><p>When encountered, store the associated value(s) in <a href="parser/struct.ArgMatches.html" title="crate::ArgMatches"><code>ArgMatches</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="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Append</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>, <span class="string">"value1"</span>, <span class="string">"--flag"</span>, <span class="string">"value2"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_many</span>::<span class="op"><</span><span class="ident">String</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">unwrap_or_default</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">as_str</span>()).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span><span class="op">></span>(),
|
||||
<span class="macro">vec!</span>[<span class="string">"value1"</span>, <span class="string">"value2"</span>]
|
||||
);</code></pre></div>
|
||||
</div><h3 id="variant.SetTrue" class="variant small-section-header"><a href="#variant.SetTrue" class="anchor field"></a><code>SetTrue</code></h3><div class="docblock"><p>When encountered, act as if <code>"true"</code> was encountered on the command-line</p>
|
||||
<p>If no <a href="builder/struct.Arg.html#method.default_value" title="super::Arg::default_value"><code>default_value</code></a> is set, it will be <code>false</code>.</p>
|
||||
<p>No value is allowed. To optionally accept a value, see
|
||||
<a href="builder/struct.Arg.html#method.default_missing_value" title="super::Arg::default_missing_value"><code>Arg::default_missing_value</code></a></p>
|
||||
<p><strong>NOTE:</strong> If the argument has previously been seen, it will result in a
|
||||
<a href="error/enum.ErrorKind.html#variant.ArgumentConflict" title="crate::error::ErrorKind::ArgumentConflict"><code>ArgumentConflict</code></a> unless
|
||||
<a href="builder/struct.Command.html#method.args_override_self" title="crate::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</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="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::SetTrue</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||||
<span class="prelude-val">Some</span>(<span class="bool-val">true</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||||
<span class="prelude-val">Some</span>(<span class="bool-val">false</span>)
|
||||
);</code></pre></div>
|
||||
<p>You can use <a href="builder/trait.TypedValueParser.html#method.map" title="crate::builder::TypedValueParser::map"><code>TypedValueParser::map</code></a> to have the
|
||||
flag control an application-specific type:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::SetTrue</span>)
|
||||
.<span class="ident">value_parser</span>(
|
||||
<span class="ident">BoolishValueParser::new</span>()
|
||||
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">b</span><span class="op">|</span> -> <span class="ident">usize</span> {
|
||||
<span class="kw">if</span> <span class="ident">b</span> { <span class="number">10</span> } <span class="kw">else</span> { <span class="number">5</span> }
|
||||
})
|
||||
)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">usize</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||||
<span class="prelude-val">Some</span>(<span class="number">10</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">usize</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||||
<span class="prelude-val">Some</span>(<span class="number">5</span>)
|
||||
);</code></pre></div>
|
||||
</div><h3 id="variant.SetFalse" class="variant small-section-header"><a href="#variant.SetFalse" class="anchor field"></a><code>SetFalse</code></h3><div class="docblock"><p>When encountered, act as if <code>"false"</code> was encountered on the command-line</p>
|
||||
<p>If no <a href="builder/struct.Arg.html#method.default_value" title="super::Arg::default_value"><code>default_value</code></a> is set, it will be <code>true</code>.</p>
|
||||
<p>No value is allowed. To optionally accept a value, see
|
||||
<a href="builder/struct.Arg.html#method.default_missing_value" title="super::Arg::default_missing_value"><code>Arg::default_missing_value</code></a></p>
|
||||
<p><strong>NOTE:</strong> If the argument has previously been seen, it will result in a
|
||||
<a href="error/enum.ErrorKind.html#variant.ArgumentConflict" title="crate::error::ErrorKind::ArgumentConflict"><code>ArgumentConflict</code></a> unless
|
||||
<a href="builder/struct.Command.html#method.args_override_self" title="crate::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</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="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::SetFalse</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||||
<span class="prelude-val">Some</span>(<span class="bool-val">false</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||||
<span class="prelude-val">Some</span>(<span class="bool-val">true</span>)
|
||||
);</code></pre></div>
|
||||
</div><h3 id="variant.Count" class="variant small-section-header"><a href="#variant.Count" class="anchor field"></a><code>Count</code></h3><div class="docblock"><p>When encountered, increment a <code>u8</code> counter</p>
|
||||
<p>If no <a href="builder/struct.Arg.html#method.default_value" title="super::Arg::default_value"><code>default_value</code></a> is set, it will be <code>0</code>.</p>
|
||||
<p>No value is allowed. To optionally accept a value, see
|
||||
<a href="builder/struct.Arg.html#method.default_missing_value" title="super::Arg::default_missing_value"><code>Arg::default_missing_value</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="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Count</span>)
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>, <span class="string">"--flag"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_count</span>(<span class="string">"flag"</span>),
|
||||
<span class="number">2</span>
|
||||
);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">matches</span>.<span class="ident">get_count</span>(<span class="string">"flag"</span>),
|
||||
<span class="number">0</span>
|
||||
);</code></pre></div>
|
||||
</div><h3 id="variant.Help" class="variant small-section-header"><a href="#variant.Help" class="anchor field"></a><code>Help</code></h3><div class="docblock"><p>When encountered, display <a href="builder/struct.Command.html#method.print_help" title="super::Command::print_help"><code>Command::print_help</code></a></p>
|
||||
<p>Depending on the flag, <a href="builder/struct.Command.html#method.print_long_help" title="super::Command::print_long_help"><code>Command::print_long_help</code></a> may be shown</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="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"special-help"</span>)
|
||||
.<span class="ident">short</span>(<span class="string">'?'</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Help</span>)
|
||||
);
|
||||
|
||||
<span class="comment">// Existing help still exists</span>
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"-h"</span>]).<span class="ident">unwrap_err</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayHelp</span>);
|
||||
|
||||
<span class="comment">// New help available</span>
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"-?"</span>]).<span class="ident">unwrap_err</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayHelp</span>);</code></pre></div>
|
||||
</div><h3 id="variant.Version" class="variant small-section-header"><a href="#variant.Version" class="anchor field"></a><code>Version</code></h3><div class="docblock"><p>When encountered, display <a href="builder/struct.Command.html#method.version" title="super::Command::version"><code>Command::version</code></a></p>
|
||||
<p>Depending on the flag, <a href="builder/struct.Command.html#method.long_version" title="super::Command::long_version"><code>Command::long_version</code></a> may be shown</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">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||||
.<span class="ident">version</span>(<span class="string">"1.0.0"</span>)
|
||||
.<span class="ident">arg</span>(
|
||||
<span class="ident">Arg::new</span>(<span class="string">"special-version"</span>)
|
||||
.<span class="ident">long</span>(<span class="string">"special-version"</span>)
|
||||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Version</span>)
|
||||
);
|
||||
|
||||
<span class="comment">// Existing help still exists</span>
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--version"</span>]).<span class="ident">unwrap_err</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayVersion</span>);
|
||||
|
||||
<span class="comment">// New help available</span>
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--special-version"</span>]).<span class="ident">unwrap_err</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayVersion</span>);</code></pre></div>
|
||||
</div><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-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/action.rs.html#275-342">source</a></span><a href="#impl-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl <a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.takes_values" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/action.rs.html#280-290">source</a></span><h4 class="code-header">pub fn <a href="#method.takes_values" class="fnname">takes_values</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether this action accepts values on the command-line</p>
|
||||
<p><a href="builder/struct.Arg.html#method.default_values" title="super::Arg::default_values"><code>default_values</code></a> and [<code>env</code>][super::Arg::env] may still be
|
||||
processed.</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-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/action.rs.html#24">source</a></span><a href="#impl-Clone-for-ArgAction" 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="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</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/action.rs.html#24">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) -> <a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></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-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/action.rs.html#24">source</a></span><a href="#impl-Debug-for-ArgAction" 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="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</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/action.rs.html#24">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="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</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-IntoResettable%3CArgAction%3E-for-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/resettable.rs.html#159-163">source</a></span><a href="#impl-IntoResettable%3CArgAction%3E-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="builder/trait.IntoResettable.html" title="trait clap::builder::IntoResettable">IntoResettable</a><<a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a>> for <a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></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#160-162">source</a></span><a href="#method.into_resettable-1" class="anchor"></a><h4 class="code-header">fn <a href="builder/trait.IntoResettable.html#tymethod.into_resettable" class="fnname">into_resettable</a>(self) -> <a class="enum" href="builder/enum.Resettable.html" title="enum clap::builder::Resettable">Resettable</a><<a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</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%3CArgAction%3E-for-Option%3CArgAction%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/resettable.rs.html#87-94">source</a></span><a href="#impl-IntoResettable%3CArgAction%3E-for-Option%3CArgAction%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="builder/trait.IntoResettable.html" title="trait clap::builder::IntoResettable">IntoResettable</a><<a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</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="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</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#88-93">source</a></span><a href="#method.into_resettable" class="anchor"></a><h4 class="code-header">fn <a href="builder/trait.IntoResettable.html#tymethod.into_resettable" class="fnname">into_resettable</a>(self) -> <a class="enum" href="builder/enum.Resettable.html" title="enum clap::builder::Resettable">Resettable</a><<a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</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-ArgAction" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-ArgAction" 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="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section><section id="impl-Send-for-ArgAction" class="impl has-srclink"><a href="#impl-Send-for-ArgAction" 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="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section><section id="impl-Sync-for-ArgAction" class="impl has-srclink"><a href="#impl-Sync-for-ArgAction" 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="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section><section id="impl-Unpin-for-ArgAction" class="impl has-srclink"><a href="#impl-Unpin-for-ArgAction" 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="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section><section id="impl-UnwindSafe-for-ArgAction" class="impl has-srclink"><a href="#impl-UnwindSafe-for-ArgAction" 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="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</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-ArgAction" 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-ArgAction" 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" 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" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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" 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" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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-ArgAction" 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>
|
||||
58
doc/clap/enum.ColorChoice.html
Normal file
58
doc/clap/enum.ColorChoice.html
Normal file
File diff suppressed because one or more lines are too long
83
doc/clap/enum.ValueHint.html
Normal file
83
doc/clap/enum.ValueHint.html
Normal file
File diff suppressed because one or more lines are too long
11
doc/clap/error/context/enum.ContextKind.html
Normal file
11
doc/clap/error/context/enum.ContextKind.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/error/enum.ContextKind.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/error/enum.ContextKind.html">../../../clap/error/enum.ContextKind.html</a>...</p>
|
||||
<script>location.replace("../../../clap/error/enum.ContextKind.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/error/context/enum.ContextValue.html
Normal file
11
doc/clap/error/context/enum.ContextValue.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/error/enum.ContextValue.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/error/enum.ContextValue.html">../../../clap/error/enum.ContextValue.html</a>...</p>
|
||||
<script>location.replace("../../../clap/error/enum.ContextValue.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
65
doc/clap/error/enum.ContextKind.html
Normal file
65
doc/clap/error/enum.ContextKind.html
Normal file
File diff suppressed because one or more lines are too long
42
doc/clap/error/enum.ContextValue.html
Normal file
42
doc/clap/error/enum.ContextValue.html
Normal file
File diff suppressed because one or more lines are too long
221
doc/clap/error/enum.ErrorKind.html
Normal file
221
doc/clap/error/enum.ErrorKind.html
Normal file
File diff suppressed because one or more lines are too long
11
doc/clap/error/format/struct.KindFormatter.html
Normal file
11
doc/clap/error/format/struct.KindFormatter.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/error/struct.KindFormatter.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/error/struct.KindFormatter.html">../../../clap/error/struct.KindFormatter.html</a>...</p>
|
||||
<script>location.replace("../../../clap/error/struct.KindFormatter.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/error/format/struct.RichFormatter.html
Normal file
11
doc/clap/error/format/struct.RichFormatter.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/error/struct.RichFormatter.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/error/struct.RichFormatter.html">../../../clap/error/struct.RichFormatter.html</a>...</p>
|
||||
<script>location.replace("../../../clap/error/struct.RichFormatter.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/error/format/trait.ErrorFormatter.html
Normal file
11
doc/clap/error/format/trait.ErrorFormatter.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/error/trait.ErrorFormatter.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/error/trait.ErrorFormatter.html">../../../clap/error/trait.ErrorFormatter.html</a>...</p>
|
||||
<script>location.replace("../../../clap/error/trait.ErrorFormatter.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
13
doc/clap/error/index.html
Normal file
13
doc/clap/error/index.html
Normal file
@ -0,0 +1,13 @@
|
||||
<!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="Error reporting"><meta name="keywords" content="rust, rustlang, rust-lang, error"><title>clap::error - 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="../../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 mod"><!--[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="#">Module error</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div></section></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">Module <a href="../index.html">clap</a>::<wbr><a class="mod" href="#">error</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/error/mod.rs.html#1-872">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Error reporting</p>
|
||||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DefaultFormatter.html" title="clap::error::DefaultFormatter struct">DefaultFormatter</a></div><div class="item-right docblock-short"><p>Richly formatted error context</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Error.html" title="clap::error::Error struct">Error</a></div><div class="item-right docblock-short"><p>Command Line Argument Parser Error</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.KindFormatter.html" title="clap::error::KindFormatter struct">KindFormatter</a></div><div class="item-right docblock-short"><p>Report <a href="enum.ErrorKind.html" title="ErrorKind"><code>ErrorKind</code></a></p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RichFormatter.html" title="clap::error::RichFormatter struct">RichFormatter</a></div><div class="item-right docblock-short"><p>Richly formatted error context</p>
|
||||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ContextKind.html" title="clap::error::ContextKind enum">ContextKind</a></div><div class="item-right docblock-short"><p>Semantics for a piece of error information</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ContextValue.html" title="clap::error::ContextValue enum">ContextValue</a></div><div class="item-right docblock-short"><p>A piece of error information</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ErrorKind.html" title="clap::error::ErrorKind enum">ErrorKind</a></div><div class="item-right docblock-short"><p>Command line argument parser kind of error</p>
|
||||
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ErrorFormatter.html" title="clap::error::ErrorFormatter trait">ErrorFormatter</a></div><div class="item-right docblock-short"><p>Defines how to format an error for displaying to the user</p>
|
||||
</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Result.html" title="clap::error::Result type">Result</a></div><div class="item-right docblock-short"><p>Short hand for <a href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html"><code>Result</code></a> type</p>
|
||||
</div></div></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>
|
||||
11
doc/clap/error/kind/enum.ErrorKind.html
Normal file
11
doc/clap/error/kind/enum.ErrorKind.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/error/enum.ErrorKind.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/error/enum.ErrorKind.html">../../../clap/error/enum.ErrorKind.html</a>...</p>
|
||||
<script>location.replace("../../../clap/error/enum.ErrorKind.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
1
doc/clap/error/sidebar-items.js
Normal file
1
doc/clap/error/sidebar-items.js
Normal file
@ -0,0 +1 @@
|
||||
window.SIDEBAR_ITEMS = {"enum":[["ContextKind","Semantics for a piece of error information"],["ContextValue","A piece of error information"],["ErrorKind","Command line argument parser kind of error"]],"struct":[["DefaultFormatter","Richly formatted error context"],["Error","Command Line Argument Parser Error"],["KindFormatter","Report [`ErrorKind`]"],["RichFormatter","Richly formatted error context"]],"trait":[["ErrorFormatter","Defines how to format an error for displaying to the user"]],"type":[["Result","Short hand for `Result` type"]]};
|
||||
16
doc/clap/error/struct.DefaultFormatter.html
Normal file
16
doc/clap/error/struct.DefaultFormatter.html
Normal file
@ -0,0 +1,16 @@
|
||||
<!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="Richly formatted error context"><meta name="keywords" content="rust, rustlang, rust-lang, DefaultFormatter"><title>DefaultFormatter in clap::error - 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="#">DefaultFormatter</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><ul><li><a href="#impl-ErrorFormatter-for-RichFormatter">ErrorFormatter</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-RichFormatter">RefUnwindSafe</a></li><li><a href="#impl-Send-for-RichFormatter">Send</a></li><li><a href="#impl-Sync-for-RichFormatter">Sync</a></li><li><a href="#impl-Unpin-for-RichFormatter">Unpin</a></li><li><a href="#impl-UnwindSafe-for-RichFormatter">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-RichFormatter">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-RichFormatter">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-RichFormatter">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-RichFormatter">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-RichFormatter">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-RichFormatter">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-RichFormatter">TryInto<U></a></li></ul></div></section><h2 class="location"><a href="index.html">In clap::error</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">error</a>::<wbr><a class="struct" href="#">DefaultFormatter</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/error/format.rs.html#49">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><div class="code-attribute">#[non_exhaustive]</div>pub struct DefaultFormatter;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Richly formatted error context</p>
|
||||
</div></details><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-ErrorFormatter-for-RichFormatter" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/format.rs.html#52-97">source</a></span><a href="#impl-ErrorFormatter-for-RichFormatter" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.ErrorFormatter.html" title="trait clap::error::ErrorFormatter">ErrorFormatter</a> for <a class="struct" href="struct.RichFormatter.html" title="struct clap::error::RichFormatter">RichFormatter</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.format_error" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/format.rs.html#53-96">source</a></span><a href="#method.format_error" class="anchor"></a><h4 class="code-header">fn <a href="trait.ErrorFormatter.html#tymethod.format_error" class="fnname">format_error</a>(error: &<a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><Self>) -> <a class="struct" href="../builder/struct.StyledStr.html" title="struct clap::builder::StyledStr">StyledStr</a></h4></section></summary><div class='docblock'><p>Stylize the error for the terminal</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-RichFormatter" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-RichFormatter" 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.RichFormatter.html" title="struct clap::error::RichFormatter">RichFormatter</a></h3></section><section id="impl-Send-for-RichFormatter" class="impl has-srclink"><a href="#impl-Send-for-RichFormatter" 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.RichFormatter.html" title="struct clap::error::RichFormatter">RichFormatter</a></h3></section><section id="impl-Sync-for-RichFormatter" class="impl has-srclink"><a href="#impl-Sync-for-RichFormatter" 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.RichFormatter.html" title="struct clap::error::RichFormatter">RichFormatter</a></h3></section><section id="impl-Unpin-for-RichFormatter" class="impl has-srclink"><a href="#impl-Unpin-for-RichFormatter" 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.RichFormatter.html" title="struct clap::error::RichFormatter">RichFormatter</a></h3></section><section id="impl-UnwindSafe-for-RichFormatter" class="impl has-srclink"><a href="#impl-UnwindSafe-for-RichFormatter" 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.RichFormatter.html" title="struct clap::error::RichFormatter">RichFormatter</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-RichFormatter" 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-RichFormatter" 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" 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" 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-RichFormatter" 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-RichFormatter" 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-RichFormatter" 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-RichFormatter" 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-RichFormatter" 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-RichFormatter" 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" 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" 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-RichFormatter" 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-RichFormatter" 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-TryFrom%3CU%3E-for-RichFormatter" 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-RichFormatter" 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-RichFormatter" 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-RichFormatter" 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>
|
||||
91
doc/clap/error/struct.Error.html
Normal file
91
doc/clap/error/struct.Error.html
Normal file
File diff suppressed because one or more lines are too long
19
doc/clap/error/struct.KindFormatter.html
Normal file
19
doc/clap/error/struct.KindFormatter.html
Normal file
@ -0,0 +1,19 @@
|
||||
<!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="Report [`ErrorKind`]"><meta name="keywords" content="rust, rustlang, rust-lang, KindFormatter"><title>KindFormatter in clap::error - 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="#">KindFormatter</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><ul><li><a href="#impl-ErrorFormatter-for-KindFormatter">ErrorFormatter</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-KindFormatter">RefUnwindSafe</a></li><li><a href="#impl-Send-for-KindFormatter">Send</a></li><li><a href="#impl-Sync-for-KindFormatter">Sync</a></li><li><a href="#impl-Unpin-for-KindFormatter">Unpin</a></li><li><a href="#impl-UnwindSafe-for-KindFormatter">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-KindFormatter">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-KindFormatter">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-KindFormatter">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-KindFormatter">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-KindFormatter">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-KindFormatter">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-KindFormatter">TryInto<U></a></li></ul></div></section><h2 class="location"><a href="index.html">In clap::error</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">error</a>::<wbr><a class="struct" href="#">KindFormatter</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/error/format.rs.html#28">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><div class="code-attribute">#[non_exhaustive]</div>pub struct KindFormatter;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Report <a href="enum.ErrorKind.html" title="ErrorKind"><code>ErrorKind</code></a></p>
|
||||
<p>No context is included.</p>
|
||||
<p><strong>NOTE:</strong> Consider removing the [<code>error-context</code>][crate::_features] default feature if using this to remove all
|
||||
overhead for <a href="struct.RichFormatter.html" title="RichFormatter"><code>RichFormatter</code></a>.</p>
|
||||
</div></details><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-ErrorFormatter-for-KindFormatter" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/format.rs.html#30-44">source</a></span><a href="#impl-ErrorFormatter-for-KindFormatter" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.ErrorFormatter.html" title="trait clap::error::ErrorFormatter">ErrorFormatter</a> for <a class="struct" href="struct.KindFormatter.html" title="struct clap::error::KindFormatter">KindFormatter</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.format_error" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/format.rs.html#31-43">source</a></span><a href="#method.format_error" class="anchor"></a><h4 class="code-header">fn <a href="trait.ErrorFormatter.html#tymethod.format_error" class="fnname">format_error</a>(error: &<a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><Self>) -> <a class="struct" href="../builder/struct.StyledStr.html" title="struct clap::builder::StyledStr">StyledStr</a></h4></section></summary><div class='docblock'><p>Stylize the error for the terminal</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-KindFormatter" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-KindFormatter" 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.KindFormatter.html" title="struct clap::error::KindFormatter">KindFormatter</a></h3></section><section id="impl-Send-for-KindFormatter" class="impl has-srclink"><a href="#impl-Send-for-KindFormatter" 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.KindFormatter.html" title="struct clap::error::KindFormatter">KindFormatter</a></h3></section><section id="impl-Sync-for-KindFormatter" class="impl has-srclink"><a href="#impl-Sync-for-KindFormatter" 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.KindFormatter.html" title="struct clap::error::KindFormatter">KindFormatter</a></h3></section><section id="impl-Unpin-for-KindFormatter" class="impl has-srclink"><a href="#impl-Unpin-for-KindFormatter" 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.KindFormatter.html" title="struct clap::error::KindFormatter">KindFormatter</a></h3></section><section id="impl-UnwindSafe-for-KindFormatter" class="impl has-srclink"><a href="#impl-UnwindSafe-for-KindFormatter" 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.KindFormatter.html" title="struct clap::error::KindFormatter">KindFormatter</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-KindFormatter" 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-KindFormatter" 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" 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" 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-KindFormatter" 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-KindFormatter" 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-KindFormatter" 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-KindFormatter" 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-KindFormatter" 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-KindFormatter" 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" 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" 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-KindFormatter" 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-KindFormatter" 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-TryFrom%3CU%3E-for-KindFormatter" 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-KindFormatter" 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-KindFormatter" 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-KindFormatter" 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>
|
||||
16
doc/clap/error/struct.RichFormatter.html
Normal file
16
doc/clap/error/struct.RichFormatter.html
Normal file
@ -0,0 +1,16 @@
|
||||
<!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="Richly formatted error context"><meta name="keywords" content="rust, rustlang, rust-lang, RichFormatter"><title>RichFormatter in clap::error - 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="#">RichFormatter</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><ul><li><a href="#impl-ErrorFormatter-for-RichFormatter">ErrorFormatter</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-RichFormatter">RefUnwindSafe</a></li><li><a href="#impl-Send-for-RichFormatter">Send</a></li><li><a href="#impl-Sync-for-RichFormatter">Sync</a></li><li><a href="#impl-Unpin-for-RichFormatter">Unpin</a></li><li><a href="#impl-UnwindSafe-for-RichFormatter">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-RichFormatter">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-RichFormatter">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-RichFormatter">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-RichFormatter">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-RichFormatter">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-RichFormatter">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-RichFormatter">TryInto<U></a></li></ul></div></section><h2 class="location"><a href="index.html">In clap::error</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">error</a>::<wbr><a class="struct" href="#">RichFormatter</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/error/format.rs.html#49">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><div class="code-attribute">#[non_exhaustive]</div>pub struct RichFormatter;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Richly formatted error context</p>
|
||||
</div></details><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-ErrorFormatter-for-RichFormatter" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/format.rs.html#52-97">source</a></span><a href="#impl-ErrorFormatter-for-RichFormatter" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.ErrorFormatter.html" title="trait clap::error::ErrorFormatter">ErrorFormatter</a> for <a class="struct" href="struct.RichFormatter.html" title="struct clap::error::RichFormatter">RichFormatter</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.format_error" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/format.rs.html#53-96">source</a></span><a href="#method.format_error" class="anchor"></a><h4 class="code-header">fn <a href="trait.ErrorFormatter.html#tymethod.format_error" class="fnname">format_error</a>(error: &<a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><Self>) -> <a class="struct" href="../builder/struct.StyledStr.html" title="struct clap::builder::StyledStr">StyledStr</a></h4></section></summary><div class='docblock'><p>Stylize the error for the terminal</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-RichFormatter" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-RichFormatter" 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.RichFormatter.html" title="struct clap::error::RichFormatter">RichFormatter</a></h3></section><section id="impl-Send-for-RichFormatter" class="impl has-srclink"><a href="#impl-Send-for-RichFormatter" 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.RichFormatter.html" title="struct clap::error::RichFormatter">RichFormatter</a></h3></section><section id="impl-Sync-for-RichFormatter" class="impl has-srclink"><a href="#impl-Sync-for-RichFormatter" 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.RichFormatter.html" title="struct clap::error::RichFormatter">RichFormatter</a></h3></section><section id="impl-Unpin-for-RichFormatter" class="impl has-srclink"><a href="#impl-Unpin-for-RichFormatter" 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.RichFormatter.html" title="struct clap::error::RichFormatter">RichFormatter</a></h3></section><section id="impl-UnwindSafe-for-RichFormatter" class="impl has-srclink"><a href="#impl-UnwindSafe-for-RichFormatter" 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.RichFormatter.html" title="struct clap::error::RichFormatter">RichFormatter</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-RichFormatter" 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-RichFormatter" 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" 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" 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-RichFormatter" 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-RichFormatter" 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-RichFormatter" 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-RichFormatter" 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-RichFormatter" 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-RichFormatter" 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" 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" 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-RichFormatter" 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-RichFormatter" 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-TryFrom%3CU%3E-for-RichFormatter" 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-RichFormatter" 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-RichFormatter" 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-RichFormatter" 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>
|
||||
7
doc/clap/error/trait.ErrorFormatter.html
Normal file
7
doc/clap/error/trait.ErrorFormatter.html
Normal file
@ -0,0 +1,7 @@
|
||||
<!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="Defines how to format an error for displaying to the user"><meta name="keywords" content="rust, rustlang, rust-lang, ErrorFormatter"><title>ErrorFormatter in clap::error - 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 trait"><!--[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="#">ErrorFormatter</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.format_error">format_error</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In clap::error</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">Trait <a href="../index.html">clap</a>::<wbr><a href="index.html">error</a>::<wbr><a class="trait" href="#">ErrorFormatter</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/error/format.rs.html#16-19">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 trait"><code>pub trait ErrorFormatter: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||||
fn <a href="#tymethod.format_error" class="fnname">format_error</a>(error: &<a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><Self>) -> <a class="struct" href="../builder/struct.StyledStr.html" title="struct clap::builder::StyledStr">StyledStr</a>;
|
||||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Defines how to format an error for displaying to the user</p>
|
||||
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.format_error" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/clap/error/format.rs.html#18">source</a></div><h4 class="code-header">fn <a href="#tymethod.format_error" class="fnname">format_error</a>(error: &<a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><Self>) -> <a class="struct" href="../builder/struct.StyledStr.html" title="struct clap::builder::StyledStr">StyledStr</a></h4></div></summary><div class="docblock"><p>Stylize the error for the terminal</p>
|
||||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><section id="impl-ErrorFormatter-for-KindFormatter" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/format.rs.html#30-44">source</a></span><a href="#impl-ErrorFormatter-for-KindFormatter" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.ErrorFormatter.html" title="trait clap::error::ErrorFormatter">ErrorFormatter</a> for <a class="struct" href="struct.KindFormatter.html" title="struct clap::error::KindFormatter">KindFormatter</a></h3></section><section id="impl-ErrorFormatter-for-RichFormatter" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/format.rs.html#52-97">source</a></span><a href="#impl-ErrorFormatter-for-RichFormatter" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.ErrorFormatter.html" title="trait clap::error::ErrorFormatter">ErrorFormatter</a> for <a class="struct" href="struct.RichFormatter.html" title="struct clap::error::RichFormatter">RichFormatter</a></h3></section></div><script type="text/javascript" src="../../implementors/clap/error/format/trait.ErrorFormatter.js" data-ignore-extern-crates="" async></script></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>
|
||||
4
doc/clap/error/type.Result.html
Normal file
4
doc/clap/error/type.Result.html
Normal file
@ -0,0 +1,4 @@
|
||||
<!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="Short hand for `Result` type"><meta name="keywords" content="rust, rustlang, rust-lang, Result"><title>Result in clap::error - 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 type"><!--[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="#">Result</a></h2><div class="sidebar-elems"><h2 class="location"><a href="index.html">In clap::error</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">Type Definition <a href="../index.html">clap</a>::<wbr><a href="index.html">error</a>::<wbr><a class="type" href="#">Result</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/error/mod.rs.html#52">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 typedef"><code>pub type Result<T, E = <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a>> = <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">StdResult</a><T, E>;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Short hand for <a href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html"><code>Result</code></a> type</p>
|
||||
</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.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
134
doc/clap/index.html
Normal file
134
doc/clap/index.html
Normal file
@ -0,0 +1,134 @@
|
||||
<!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="Command Line Argument Parser for Rust"><meta name="keywords" content="rust, rustlang, rust-lang, clap"><title>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" 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="../crates.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 mod crate"><!--[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="#">Crate clap</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 4.0.32</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div></section></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">Crate <a class="mod" href="#">clap</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/lib.rs.html#6-154">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><blockquote>
|
||||
<p><strong>Command Line Argument Parser for Rust</strong></p>
|
||||
</blockquote>
|
||||
<p>Quick Links:</p>
|
||||
<ul>
|
||||
<li>Derive [tutorial][_derive::_tutorial] and [reference][_derive]</li>
|
||||
<li>Builder [tutorial][_tutorial] and <a href="index.html">reference</a></li>
|
||||
<li>[Cookbook][_cookbook]</li>
|
||||
<li>[FAQ][_faq]</li>
|
||||
<li><a href="https://github.com/clap-rs/clap/discussions">Discussions</a></li>
|
||||
</ul>
|
||||
<h3 id="aspirations"><a href="#aspirations">Aspirations</a></h3>
|
||||
<ul>
|
||||
<li>Out of the box, users get a polished CLI experience
|
||||
<ul>
|
||||
<li>Including common argument behavior, help generation, suggested fixes for users, colored output, <a href="https://github.com/clap-rs/clap/tree/master/clap_complete">shell completions</a>, etc</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Flexible enough to port your existing CLI interface
|
||||
<ul>
|
||||
<li>However, we won’t necessarily streamline support for each use case</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Reasonable parse performance</li>
|
||||
<li>Resilient maintainership, including
|
||||
<ul>
|
||||
<li>Willing to break compatibility rather than batching up breaking changes in large releases</li>
|
||||
<li>Leverage feature flags to keep to one active branch</li>
|
||||
<li>Being under <a href="https://github.com/rust-cli/team/">WG-CLI</a> to increase the bus factor</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>We follow semver and will wait about 6-9 months between major breaking changes</li>
|
||||
<li>We will support the last two minor Rust releases (MSRV, currently 1.60.0)</li>
|
||||
</ul>
|
||||
<p>While these aspirations can be at odds with fast build times and low binary
|
||||
size, we will still strive to keep these reasonable for the flexibility you
|
||||
get. Check out the
|
||||
<a href="https://github.com/rust-cli/argparse-benchmarks-rs">argparse-benchmarks</a> for
|
||||
CLI parsers optimized for other use cases.</p>
|
||||
<h3 id="example"><a href="#example">Example</a></h3>
|
||||
<p>Run</p>
|
||||
<div class="example-wrap"><pre class="language-console"><code>$ cargo add clap --features derive</code></pre></div>
|
||||
<p><em>(See also [feature flag reference][_features])</em></p>
|
||||
<p>Then define your CLI in <code>main.rs</code>:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">clap::Parser</span>;
|
||||
|
||||
<span class="doccomment">/// Simple program to greet a person</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Parser</span>, <span class="ident">Debug</span>)]</span>
|
||||
<span class="attribute">#[<span class="ident">command</span>(<span class="ident">author</span>, <span class="ident">version</span>, <span class="ident">about</span>, <span class="ident">long_about</span> <span class="op">=</span> <span class="prelude-val">None</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">Args</span> {
|
||||
<span class="doccomment">/// Name of the person to greet</span>
|
||||
<span class="attribute">#[<span class="ident">arg</span>(<span class="ident">short</span>, <span class="ident">long</span>)]</span>
|
||||
<span class="ident">name</span>: <span class="ident">String</span>,
|
||||
|
||||
<span class="doccomment">/// Number of times to greet</span>
|
||||
<span class="attribute">#[<span class="ident">arg</span>(<span class="ident">short</span>, <span class="ident">long</span>, <span class="ident">default_value_t</span> <span class="op">=</span> <span class="number">1</span>)]</span>
|
||||
<span class="ident">count</span>: <span class="ident">u8</span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="kw">let</span> <span class="ident">args</span> <span class="op">=</span> <span class="ident">Args::parse</span>();
|
||||
|
||||
<span class="kw">for</span> <span class="kw">_</span> <span class="kw">in</span> <span class="number">0</span>..<span class="ident">args</span>.<span class="ident">count</span> {
|
||||
<span class="macro">println!</span>(<span class="string">"Hello {}!"</span>, <span class="ident">args</span>.<span class="ident">name</span>)
|
||||
}
|
||||
}</code></pre></div>
|
||||
<p>And try it out:</p>
|
||||
<div class="example-wrap"><pre class="language-console"><code>$ demo --help
|
||||
A simple to use, efficient, and full-featured Command Line Argument Parser
|
||||
|
||||
Usage: demo[EXE] [OPTIONS] --name <NAME>
|
||||
|
||||
Options:
|
||||
-n, --name <NAME> Name of the person to greet
|
||||
-c, --count <COUNT> Number of times to greet [default: 1]
|
||||
-h, --help Print help information
|
||||
-V, --version Print version information
|
||||
|
||||
$ demo --name Me
|
||||
Hello Me!
|
||||
</code></pre></div>
|
||||
<p><em>(version number and <code>.exe</code> extension on windows replaced by placeholders)</em></p>
|
||||
<p>See also the derive [tutorial][_derive::_tutorial] and [reference][_derive]</p>
|
||||
<h4 id="related-projects"><a href="#related-projects">Related Projects</a></h4>
|
||||
<p>Augment clap:</p>
|
||||
<ul>
|
||||
<li><a href="https://crates.io/crates/wild">wild</a> for supporting wildcards (<code>*</code>) on Windows like you do Linux</li>
|
||||
<li><a href="https://crates.io/crates/argfile">argfile</a> for loading additional arguments from a file (aka response files)</li>
|
||||
<li><a href="https://crates.io/crates/shadow-rs">shadow-rs</a> for generating <code>Command::long_version</code></li>
|
||||
<li><a href="https://crates.io/crates/clap_mangen">clap_mangen</a> for generating man page source (roff)</li>
|
||||
<li><a href="https://crates.io/crates/clap_complete">clap_complete</a> for shell completion support</li>
|
||||
</ul>
|
||||
<p>CLI Helpers</p>
|
||||
<ul>
|
||||
<li><a href="https://crates.io/crates/clap-verbosity-flag">clap-verbosity-flag</a></li>
|
||||
<li><a href="https://crates.io/crates/clap-cargo">clap-cargo</a></li>
|
||||
<li><a href="https://crates.io/crates/concolor-clap">concolor-clap</a></li>
|
||||
</ul>
|
||||
<p>Testing</p>
|
||||
<ul>
|
||||
<li><a href="https://crates.io/crates/trycmd"><code>trycmd</code></a>: Bulk snapshot testing</li>
|
||||
<li><a href="https://crates.io/crates/snapbox"><code>snapbox</code></a>: Specialized snapshot testing</li>
|
||||
<li><a href="https://crates.io/crates/assert_cmd"><code>assert_cmd</code></a> and <a href="https://crates.io/crates/assert_fs"><code>assert_fs</code></a>: Customized testing</li>
|
||||
</ul>
|
||||
<p>Documentation:</p>
|
||||
<ul>
|
||||
<li><a href="https://rust-cli.github.io/book/index.html">Command-line Apps for Rust</a> book</li>
|
||||
</ul>
|
||||
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="builder/index.html" title="clap::builder mod">builder</a></div><div class="item-right docblock-short"><p>Define <a href="builder/struct.Command.html" title="Command"><code>Command</code></a> line <a href="builder/struct.Arg.html" title="Arg">arguments</a></p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="error/index.html" title="clap::error mod">error</a></div><div class="item-right docblock-short"><p>Error reporting</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="parser/index.html" title="clap::parser mod">parser</a></div><div class="item-right docblock-short"><p><a href="builder/struct.Command.html" title="crate::Command"><code>Command</code></a> line argument parser</p>
|
||||
</div></div></div><h2 id="macros" class="small-section-header"><a href="#macros">Macros</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.arg.html" title="clap::arg macro">arg</a></div><div class="item-right docblock-short"><p>Create an <a href="builder/struct.Arg.html"><code>Arg</code></a> from a usage string.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.command.html" title="clap::command macro">command</a></div><div class="item-right docblock-short"><p>Requires <code>cargo</code> feature flag to be enabled.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.value_parser.html" title="clap::value_parser macro">value_parser</a></div><div class="item-right docblock-short"><p>Select a <a href="builder/struct.ValueParser.html" title="ValueParser"><code>ValueParser</code></a> implementation from the intended type</p>
|
||||
</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Arg.html" title="clap::Arg struct">Arg</a></div><div class="item-right docblock-short"><p>The abstract representation of a command line argument. Used to set all the options and
|
||||
relationships that define a valid argument for the program.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ArgGroup.html" title="clap::ArgGroup struct">ArgGroup</a></div><div class="item-right docblock-short"><p>Family of related <a href="builder/struct.Arg.html">arguments</a>.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ArgMatches.html" title="clap::ArgMatches struct">ArgMatches</a></div><div class="item-right docblock-short"><p>Container for parse results.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Command.html" title="clap::Command struct">Command</a></div><div class="item-right docblock-short"><p>Build a command-line interface.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Id.html" title="clap::Id struct">Id</a></div><div class="item-right docblock-short"><p><a href="builder/struct.Arg.html" title="crate::Arg"><code>Arg</code></a> or <a href="builder/struct.ArgGroup.html" title="crate::ArgGroup"><code>ArgGroup</code></a> identifier</p>
|
||||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ArgAction.html" title="clap::ArgAction enum">ArgAction</a></div><div class="item-right docblock-short"><p>Behavior of arguments when they are encountered while parsing</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ColorChoice.html" title="clap::ColorChoice enum">ColorChoice</a></div><div class="item-right docblock-short"><p>Represents the color preferences for program output</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ValueHint.html" title="clap::ValueHint enum">ValueHint</a></div><div class="item-right docblock-short"><p>Provide shell with hint on how to complete an argument.</p>
|
||||
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Args.html" title="clap::Args trait">Args</a></div><div class="item-right docblock-short"><p>Parse a set of arguments into a user-defined container.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.CommandFactory.html" title="clap::CommandFactory trait">CommandFactory</a></div><div class="item-right docblock-short"><p>Create a <a href="builder/struct.Command.html" title="Command"><code>Command</code></a> relevant for a user-defined container.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FromArgMatches.html" title="clap::FromArgMatches trait">FromArgMatches</a></div><div class="item-right docblock-short"><p>Converts an instance of <a href="parser/struct.ArgMatches.html" title="ArgMatches"><code>ArgMatches</code></a> to a user-defined container.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Parser.html" title="clap::Parser trait">Parser</a></div><div class="item-right docblock-short"><p>Parse command-line arguments into <code>Self</code>.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Subcommand.html" title="clap::Subcommand trait">Subcommand</a></div><div class="item-right docblock-short"><p>Parse a sub-command into a user-defined enum.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ValueEnum.html" title="clap::ValueEnum trait">ValueEnum</a></div><div class="item-right docblock-short"><p>Parse arguments into enums.</p>
|
||||
</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Error.html" title="clap::Error type">Error</a></div><div class="item-right docblock-short"><p>Command Line Argument Parser Error</p>
|
||||
</div></div></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>
|
||||
11
doc/clap/macro.arg!.html
Normal file
11
doc/clap/macro.arg!.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=macro.arg.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="macro.arg.html">macro.arg.html</a>...</p>
|
||||
<script>location.replace("macro.arg.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
65
doc/clap/macro.arg.html
Normal file
65
doc/clap/macro.arg.html
Normal file
@ -0,0 +1,65 @@
|
||||
<!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="Create an `Arg` from a usage string."><meta name="keywords" content="rust, rustlang, rust-lang, arg"><title>arg 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" 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 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">☰</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><div class="sidebar-elems"><h2 class="location"><a href="index.html">In clap</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">Macro <a href="index.html">clap</a>::<wbr><a class="macro" href="#">arg</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/macros.rs.html#538-551">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"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules!</span> <span class="ident">arg</span> {
|
||||
( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>: $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="op">+</span> ) => { ... };
|
||||
( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="op">+</span> ) => { ... };
|
||||
}</code></pre></div>
|
||||
</div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Create an <a href="builder/struct.Arg.html"><code>Arg</code></a> from a usage string.</p>
|
||||
<p>Allows creation of basic settings for the <a href="builder/struct.Arg.html"><code>Arg</code></a>.</p>
|
||||
<p><strong>NOTE</strong>: Not all settings may be set using the usage string method. Some properties are
|
||||
only available via the builder pattern.</p>
|
||||
<h2 id="syntax"><a href="#syntax">Syntax</a></h2>
|
||||
<p>Usage strings typically following the form:</p>
|
||||
<div class="example-wrap"><pre class="language-notrust"><code>[explicit name] [short] [long] [value names] [...] [help string]</code></pre></div><h4 id="explicit-name"><a href="#explicit-name">Explicit Name</a></h4>
|
||||
<p>The name may be either a bare-word or a string, followed by a <code>:</code>, like <code>name:</code> or
|
||||
<code>"name":</code>.</p>
|
||||
<p><em>Note:</em> This is an optional field, if it’s omitted the argument will use one of the additional
|
||||
fields as the name using the following priority order:</p>
|
||||
<ol>
|
||||
<li>Explicit Name</li>
|
||||
<li>Long</li>
|
||||
<li>Value Name</li>
|
||||
</ol>
|
||||
<p>See <a href="builder/struct.Arg.html#method.id" title="crate::Arg::id"><code>Arg::id</code></a>.</p>
|
||||
<h4 id="short"><a href="#short">Short</a></h4>
|
||||
<p>A short flag is a <code>-</code> followed by either a bare-character or quoted character, like <code>-f</code> or
|
||||
<code>-'f'</code>.</p>
|
||||
<p>See <a href="builder/struct.Arg.html#method.short" title="crate::Arg::short"><code>Arg::short</code></a>.</p>
|
||||
<h4 id="long"><a href="#long">Long</a></h4>
|
||||
<p>A long flag is a <code>--</code> followed by either a bare-word or a string, like <code>--foo</code> or
|
||||
<code>--"foo"</code>.</p>
|
||||
<p><strong>NOTE:</strong> Dashes in the long name (e.g. <code>--foo-bar</code>) is not supported and quoting is required
|
||||
(e.g. <code>--"foo-bar"</code>).</p>
|
||||
<p>See <a href="builder/struct.Arg.html#method.long" title="crate::Arg::long"><code>Arg::long</code></a>.</p>
|
||||
<h4 id="values-value-notation"><a href="#values-value-notation">Values (Value Notation)</a></h4>
|
||||
<p>This is set by placing bare-word between:</p>
|
||||
<ul>
|
||||
<li><code>[]</code> like <code>[FOO]</code>
|
||||
<ul>
|
||||
<li>Positional argument: optional</li>
|
||||
<li>Named argument: optional value</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code><></code> like <code><FOO></code>: required</li>
|
||||
</ul>
|
||||
<p>See <a href="builder/struct.Arg.html#method.value_name" title="crate::Arg::value_name"><code>Arg::value_name</code></a>.</p>
|
||||
<h4 id=""><a href="#"><code>...</code></a></h4>
|
||||
<p><code>...</code> (three consecutive dots/periods) specifies that this argument may occur multiple
|
||||
times (not to be confused with multiple values per occurrence).</p>
|
||||
<p>See <a href="builder/enum.ArgAction.html#variant.Count" title="crate::ArgAction::Count"><code>ArgAction::Count</code></a> and <a href="builder/enum.ArgAction.html#variant.Append" title="crate::ArgAction::Append"><code>ArgAction::Append</code></a>.</p>
|
||||
<h4 id="help-string"><a href="#help-string">Help String</a></h4>
|
||||
<p>The help string is denoted between a pair of double quotes <code>""</code> and may contain any
|
||||
characters.</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> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"prog"</span>)
|
||||
.<span class="ident">args</span>(<span class="kw-2">&</span>[
|
||||
<span class="macro">arg!</span>(<span class="op">-</span><span class="op">-</span><span class="ident">config</span> <span class="op"><</span><span class="ident">FILE</span><span class="op">></span> <span class="string">"a required file for the configuration and no short"</span>),
|
||||
<span class="macro">arg!</span>(<span class="op">-</span><span class="ident">d</span> <span class="op">-</span><span class="op">-</span><span class="ident">debug</span> ... <span class="string">"turns on debugging information and allows multiples"</span>),
|
||||
<span class="macro">arg!</span>([<span class="ident">input</span>] <span class="string">"an optional input file to use"</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</span>([<span class="string">"prog"</span>, <span class="string">"--config"</span>, <span class="string">"file.toml"</span>]).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">m</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">String</span><span class="op">></span>(<span class="string">"config"</span>).<span class="ident">unwrap</span>(), <span class="string">"file.toml"</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span><span class="ident">m</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">u8</span><span class="op">></span>(<span class="string">"debug"</span>).<span class="ident">unwrap</span>(), <span class="number">0</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">m</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">String</span><span class="op">></span>(<span class="string">"input"</span>), <span class="prelude-val">None</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.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
11
doc/clap/macro.command!.html
Normal file
11
doc/clap/macro.command!.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=macro.command.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="macro.command.html">macro.command.html</a>...</p>
|
||||
<script>location.replace("macro.command.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
8
doc/clap/macro.command.html
Normal file
8
doc/clap/macro.command.html
Normal file
@ -0,0 +1,8 @@
|
||||
<!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="Requires `cargo` feature flag to be enabled."><meta name="keywords" content="rust, rustlang, rust-lang, command"><title>command 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" 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 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">☰</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><div class="sidebar-elems"><h2 class="location"><a href="index.html">In clap</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">Macro <a href="index.html">clap</a>::<wbr><a class="macro" href="#">command</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/macros.rs.html#151-158">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"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules!</span> <span class="ident">command</span> {
|
||||
() => { ... };
|
||||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">expr</span>) => { ... };
|
||||
}</code></pre></div>
|
||||
</div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Requires <code>cargo</code> feature flag to be enabled.</p>
|
||||
</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.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
11
doc/clap/macro.value_parser!.html
Normal file
11
doc/clap/macro.value_parser!.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=macro.value_parser.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="macro.value_parser.html">macro.value_parser.html</a>...</p>
|
||||
<script>location.replace("macro.value_parser.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
52
doc/clap/macro.value_parser.html
Normal file
52
doc/clap/macro.value_parser.html
Normal file
@ -0,0 +1,52 @@
|
||||
<!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="Select a [`ValueParser`] implementation from the intended type"><meta name="keywords" content="rust, rustlang, rust-lang, value_parser"><title>value_parser 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" 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 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">☰</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><div class="sidebar-elems"><h2 class="location"><a href="index.html">In clap</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">Macro <a href="index.html">clap</a>::<wbr><a class="macro" href="#">value_parser</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#2365-2371">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"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules!</span> <span class="ident">value_parser</span> {
|
||||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ty</span>) => { ... };
|
||||
}</code></pre></div>
|
||||
</div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Select a <a href="builder/struct.ValueParser.html" title="ValueParser"><code>ValueParser</code></a> implementation from the intended type</p>
|
||||
<p>Supported types</p>
|
||||
<ul>
|
||||
<li><a href="builder/trait.ValueParserFactory.html" title="ValueParserFactory"><code>ValueParserFactory</code> types</a>, including
|
||||
<ul>
|
||||
<li><a href="builder/struct.ValueParser.html" title="ValueParser">Native types</a>: <code>bool</code>, <code>String</code>, <code>OsString</code>, <code>PathBuf</code></li>
|
||||
<li><a href="builder/struct.RangedI64ValueParser.html" title="RangedI64ValueParser">Ranged numeric types</a>: <code>u8</code>, <code>i8</code>, <code>u16</code>, <code>i16</code>, <code>u32</code>, <code>i32</code>, <code>u64</code>, <code>i64</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="trait.ValueEnum.html" title="crate::ValueEnum"><code>ValueEnum</code> types</a></li>
|
||||
<li><a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="std::convert::From"><code>From<OsString></code> types</a> and <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="std::convert::From"><code>From<&OsStr></code> types</a></li>
|
||||
<li><a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="std::convert::From"><code>From<String></code> types</a> and <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="std::convert::From"><code>From<&str></code> types</a></li>
|
||||
<li><a href="https://doc.rust-lang.org/1.64.0/core/str/traits/trait.FromStr.html" title="std::str::FromStr"><code>FromStr</code> types</a>, including usize, isize</li>
|
||||
</ul>
|
||||
<h2 id="example"><a href="#example">Example</a></h2>
|
||||
<p>Usage:</p>
|
||||
|
||||
<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">"file.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">"file.txt"</span>));</code></pre></div>
|
||||
<p>Example mappings:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// Built-in types</span>
|
||||
<span class="kw">let</span> <span class="ident">parser</span> <span class="op">=</span> <span class="macro">clap::value_parser!</span>(<span class="ident">String</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="macro">format!</span>(<span class="string">"{:?}"</span>, <span class="ident">parser</span>), <span class="string">"ValueParser::string"</span>);
|
||||
<span class="kw">let</span> <span class="ident">parser</span> <span class="op">=</span> <span class="macro">clap::value_parser!</span>(<span class="ident">std::ffi::OsString</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="macro">format!</span>(<span class="string">"{:?}"</span>, <span class="ident">parser</span>), <span class="string">"ValueParser::os_string"</span>);
|
||||
<span class="kw">let</span> <span class="ident">parser</span> <span class="op">=</span> <span class="macro">clap::value_parser!</span>(<span class="ident">std::path::PathBuf</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="macro">format!</span>(<span class="string">"{:?}"</span>, <span class="ident">parser</span>), <span class="string">"ValueParser::path_buf"</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="macro">clap::value_parser!</span>(<span class="ident">u64</span>).<span class="ident">range</span>(<span class="number">3000</span>..);
|
||||
|
||||
<span class="comment">// FromStr types</span>
|
||||
<span class="kw">let</span> <span class="ident">parser</span> <span class="op">=</span> <span class="macro">clap::value_parser!</span>(<span class="ident">usize</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="macro">format!</span>(<span class="string">"{:?}"</span>, <span class="ident">parser</span>), <span class="string">"_AnonymousValueParser(ValueParser::other(usize))"</span>);
|
||||
|
||||
<span class="comment">// ValueEnum types</span>
|
||||
<span class="macro">clap::value_parser!</span>(<span class="ident">ColorChoice</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.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
38
doc/clap/parser/enum.MatchesError.html
Normal file
38
doc/clap/parser/enum.MatchesError.html
Normal file
@ -0,0 +1,38 @@
|
||||
<!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="Violation of [`ArgMatches`][crate::ArgMatches] assumptions"><meta name="keywords" content="rust, rustlang, rust-lang, MatchesError"><title>MatchesError in clap::parser - 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 enum"><!--[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="#">MatchesError</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#variants">Variants</a></h3><ul><li><a href="#variant.Downcast">Downcast</a></li><li><a href="#variant.UnknownArgument">UnknownArgument</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-MatchesError">Clone</a></li><li><a href="#impl-Debug-for-MatchesError">Debug</a></li><li><a href="#impl-Display-for-MatchesError">Display</a></li><li><a href="#impl-Error-for-MatchesError">Error</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-MatchesError">RefUnwindSafe</a></li><li><a href="#impl-Send-for-MatchesError">Send</a></li><li><a href="#impl-Sync-for-MatchesError">Sync</a></li><li><a href="#impl-Unpin-for-MatchesError">Unpin</a></li><li><a href="#impl-UnwindSafe-for-MatchesError">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-MatchesError">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-MatchesError">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-MatchesError">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-MatchesError">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-MatchesError">Into<U></a></li><li><a href="#impl-ToOwned-for-MatchesError">ToOwned</a></li><li><a href="#impl-ToString-for-MatchesError">ToString</a></li><li><a href="#impl-TryFrom%3CU%3E-for-MatchesError">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-MatchesError">TryInto<U></a></li></ul></div></section><h2 class="location"><a href="index.html">In clap::parser</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">Enum <a href="../index.html">clap</a>::<wbr><a href="index.html">parser</a>::<wbr><a class="enum" href="#">MatchesError</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/parser/error.rs.html#5-19">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 enum"><code>#[non_exhaustive]
|
||||
pub enum MatchesError {
|
||||
Downcast {
|
||||
actual: AnyValueId,
|
||||
expected: AnyValueId,
|
||||
},
|
||||
UnknownArgument {},
|
||||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Violation of <a href="struct.ArgMatches.html" title="crate::ArgMatches"><code>ArgMatches</code></a> assumptions</p>
|
||||
</div></details><h2 id="variants" class="variants small-section-header">Variants (Non-exhaustive)<a href="#variants" class="anchor"></a></h2><details class="rustdoc-toggle non-exhaustive"><summary class="hideme"><span>This enum is marked as non-exhaustive</span></summary><div class="docblock">Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.</div></details><h3 id="variant.Downcast" class="variant small-section-header"><a href="#variant.Downcast" class="anchor field"></a><code>Downcast</code></h3><div class="sub-variant" id="variant.Downcast.fields"><h4>Fields</h4><details class="rustdoc-toggle non-exhaustive"><summary class="hideme"><span>This variant is marked as non-exhaustive</span></summary><div class="docblock">Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.</div></details><div class="sub-variant-field"><span id="variant.Downcast.field.actual" class="variant small-section-header"><a href="#variant.Downcast.field.actual" class="anchor field"></a><code>actual: AnyValueId</code></span><div class="docblock"><p>Type for value stored in <a href="struct.ArgMatches.html" title="crate::ArgMatches"><code>ArgMatches</code></a></p>
|
||||
</div></div><div class="sub-variant-field"><span id="variant.Downcast.field.expected" class="variant small-section-header"><a href="#variant.Downcast.field.expected" class="anchor field"></a><code>expected: AnyValueId</code></span><div class="docblock"><p>The target type to downcast to</p>
|
||||
</div></div></div><div class="docblock"><p>Failed to downcast <code>AnyValue</code> to the specified type</p>
|
||||
</div><h3 id="variant.UnknownArgument" class="variant small-section-header"><a href="#variant.UnknownArgument" class="anchor field"></a><code>UnknownArgument</code></h3><div class="sub-variant" id="variant.UnknownArgument.fields"><h4>Fields</h4><details class="rustdoc-toggle non-exhaustive"><summary class="hideme"><span>This variant is marked as non-exhaustive</span></summary><div class="docblock">Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.</div></details></div><div class="docblock"><p>Argument not defined in <a href="../builder/struct.Command.html" title="crate::Command"><code>Command</code></a></p>
|
||||
</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-MatchesError" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/parser/error.rs.html#2">source</a></span><a href="#impl-Clone-for-MatchesError" 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="enum" href="enum.MatchesError.html" title="enum clap::parser::MatchesError">MatchesError</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/parser/error.rs.html#2">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) -> <a class="enum" href="enum.MatchesError.html" title="enum clap::parser::MatchesError">MatchesError</a></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-MatchesError" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/parser/error.rs.html#2">source</a></span><a href="#impl-Debug-for-MatchesError" 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="enum" href="enum.MatchesError.html" title="enum clap::parser::MatchesError">MatchesError</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/parser/error.rs.html#2">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="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</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-Display-for-MatchesError" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/parser/error.rs.html#39-54">source</a></span><a href="#impl-Display-for-MatchesError" 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.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="enum.MatchesError.html" title="enum clap::parser::MatchesError">MatchesError</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt-1" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/parser/error.rs.html#40-53">source</a></span><a href="#method.fmt-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Display.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="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</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.Display.html#tymethod.fmt">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Error-for-MatchesError" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/parser/error.rs.html#37">source</a></span><a href="#impl-Error-for-MatchesError" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/std/error/trait.Error.html" title="trait std::error::Error">Error</a> for <a class="enum" href="enum.MatchesError.html" title="enum clap::parser::MatchesError">MatchesError</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.source" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.30.0">1.30.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/error.rs.html#245">source</a></span><a href="#method.source" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/std/error/trait.Error.html#method.source" class="fnname">source</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&(dyn <a class="trait" href="https://doc.rust-lang.org/1.64.0/std/error/trait.Error.html" title="trait std::error::Error">Error</a> + 'static)></h4></section></summary><div class='docblock'><p>The lower-level source of this error, if any. <a href="https://doc.rust-lang.org/1.64.0/std/error/trait.Error.html#method.source">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.description" 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/std/error.rs.html#271">source</a></span><a href="#method.description" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/std/error/trait.Error.html#method.description" class="fnname">description</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a></h4></section></summary><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span> Deprecated since 1.42.0: <p>use the Display impl or to_string()</p>
|
||||
</div></span><div class='docblock'> <a href="https://doc.rust-lang.org/1.64.0/std/error/trait.Error.html#method.description">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.cause" 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/std/error.rs.html#281">source</a></span><a href="#method.cause" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/std/error/trait.Error.html#method.cause" class="fnname">cause</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&dyn <a class="trait" href="https://doc.rust-lang.org/1.64.0/std/error/trait.Error.html" title="trait std::error::Error">Error</a>></h4></section></summary><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span> Deprecated since 1.33.0: <p>replaced by Error::source, which can support downcasting</p>
|
||||
</div></span></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.provide" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/std/error.rs.html#355">source</a></span><a href="#method.provide" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/std/error/trait.Error.html#method.provide" class="fnname">provide</a>(&'a self, req: &mut <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/any/struct.Demand.html" title="struct core::any::Demand">Demand</a><'a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>error_generic_member_access</code>)</div></span><div class='docblock'><p>Provides type based access to context intended for error reports. <a href="https://doc.rust-lang.org/1.64.0/std/error/trait.Error.html#method.provide">Read more</a></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-MatchesError" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-MatchesError" 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="enum" href="enum.MatchesError.html" title="enum clap::parser::MatchesError">MatchesError</a></h3></section><section id="impl-Send-for-MatchesError" class="impl has-srclink"><a href="#impl-Send-for-MatchesError" 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="enum" href="enum.MatchesError.html" title="enum clap::parser::MatchesError">MatchesError</a></h3></section><section id="impl-Sync-for-MatchesError" class="impl has-srclink"><a href="#impl-Sync-for-MatchesError" 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="enum" href="enum.MatchesError.html" title="enum clap::parser::MatchesError">MatchesError</a></h3></section><section id="impl-Unpin-for-MatchesError" class="impl has-srclink"><a href="#impl-Unpin-for-MatchesError" 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="enum" href="enum.MatchesError.html" title="enum clap::parser::MatchesError">MatchesError</a></h3></section><section id="impl-UnwindSafe-for-MatchesError" class="impl has-srclink"><a href="#impl-UnwindSafe-for-MatchesError" 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="enum" href="enum.MatchesError.html" title="enum clap::parser::MatchesError">MatchesError</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-MatchesError" 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-MatchesError" 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" 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" 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-MatchesError" 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-MatchesError" 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-MatchesError" 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-MatchesError" 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-MatchesError" 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-MatchesError" 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" 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" 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-MatchesError" 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-MatchesError" 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-MatchesError" 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-MatchesError" 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-ToString-for-MatchesError" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/string.rs.html#2479">source</a></span><a href="#impl-ToString-for-MatchesError" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/alloc/string/trait.ToString.html" title="trait alloc::string::ToString">ToString</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + ?<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.to_string" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/string.rs.html#2485">source</a></span><a href="#method.to_string" class="anchor"></a><h4 class="code-header">default fn <a href="https://doc.rust-lang.org/1.64.0/alloc/string/trait.ToString.html#tymethod.to_string" class="fnname">to_string</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class='docblock'><p>Converts the given value to a <code>String</code>. <a href="https://doc.rust-lang.org/1.64.0/alloc/string/trait.ToString.html#tymethod.to_string">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-MatchesError" 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-MatchesError" 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-MatchesError" 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-MatchesError" 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>
|
||||
43
doc/clap/parser/enum.ValueSource.html
Normal file
43
doc/clap/parser/enum.ValueSource.html
Normal file
File diff suppressed because one or more lines are too long
11
doc/clap/parser/error/enum.MatchesError.html
Normal file
11
doc/clap/parser/error/enum.MatchesError.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../clap/parser/enum.MatchesError.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../clap/parser/enum.MatchesError.html">../../../clap/parser/enum.MatchesError.html</a>...</p>
|
||||
<script>location.replace("../../../clap/parser/enum.MatchesError.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
12
doc/clap/parser/index.html
Normal file
12
doc/clap/parser/index.html
Normal file
@ -0,0 +1,12 @@
|
||||
<!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="[`Command`][crate::Command] line argument parser"><meta name="keywords" content="rust, rustlang, rust-lang, parser"><title>clap::parser - 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="../../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 mod"><!--[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="#">Module parser</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div></section></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">Module <a href="../index.html">clap</a>::<wbr><a class="mod" href="#">parser</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/parser/mod.rs.html#1-27">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><a href="../builder/struct.Command.html" title="crate::Command"><code>Command</code></a> line argument parser</p>
|
||||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ArgMatches.html" title="clap::parser::ArgMatches struct">ArgMatches</a></div><div class="item-right docblock-short"><p>Container for parse results.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IdsRef.html" title="clap::parser::IdsRef struct">IdsRef</a></div><div class="item-right docblock-short"><p>Iterate over <a href="../builder/struct.Arg.html" title="crate::Arg"><code>Arg</code></a> and <a href="../builder/struct.ArgGroup.html" title="crate::ArgGroup"><code>ArgGroup</code></a> <a href="../struct.Id.html" title="crate::Id"><code>Id</code></a>s via <a href="struct.ArgMatches.html#method.ids" title="ArgMatches::ids"><code>ArgMatches::ids</code></a>.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Indices.html" title="clap::parser::Indices struct">Indices</a></div><div class="item-right docblock-short"><p>Iterate over indices for where an argument appeared when parsing, via <a href="struct.ArgMatches.html#method.indices_of"><code>ArgMatches::indices_of</code></a></p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RawValues.html" title="clap::parser::RawValues struct">RawValues</a></div><div class="item-right docblock-short"><p>Iterate over raw argument values via <a href="struct.ArgMatches.html#method.get_raw" title="ArgMatches::get_raw"><code>ArgMatches::get_raw</code></a>.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Values.html" title="clap::parser::Values struct">Values</a></div><div class="item-right docblock-short"><p>Iterate over multiple values for an argument via <a href="struct.ArgMatches.html#method.remove_many" title="ArgMatches::remove_many"><code>ArgMatches::remove_many</code></a>.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ValuesRef.html" title="clap::parser::ValuesRef struct">ValuesRef</a></div><div class="item-right docblock-short"><p>Iterate over multiple values for an argument via <a href="struct.ArgMatches.html#method.get_many" title="ArgMatches::get_many"><code>ArgMatches::get_many</code></a>.</p>
|
||||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.MatchesError.html" title="clap::parser::MatchesError enum">MatchesError</a></div><div class="item-right docblock-short"><p>Violation of <a href="struct.ArgMatches.html" title="crate::ArgMatches"><code>ArgMatches</code></a> assumptions</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ValueSource.html" title="clap::parser::ValueSource enum">ValueSource</a></div><div class="item-right docblock-short"><p>Origin of the argument’s value</p>
|
||||
</div></div></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>
|
||||
11
doc/clap/parser/matches/arg_matches/struct.ArgMatches.html
Normal file
11
doc/clap/parser/matches/arg_matches/struct.ArgMatches.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../../clap/parser/struct.ArgMatches.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../../clap/parser/struct.ArgMatches.html">../../../../clap/parser/struct.ArgMatches.html</a>...</p>
|
||||
<script>location.replace("../../../../clap/parser/struct.ArgMatches.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/parser/matches/arg_matches/struct.IdsRef.html
Normal file
11
doc/clap/parser/matches/arg_matches/struct.IdsRef.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../../clap/parser/struct.IdsRef.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../../clap/parser/struct.IdsRef.html">../../../../clap/parser/struct.IdsRef.html</a>...</p>
|
||||
<script>location.replace("../../../../clap/parser/struct.IdsRef.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/parser/matches/arg_matches/struct.Indices.html
Normal file
11
doc/clap/parser/matches/arg_matches/struct.Indices.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../../clap/parser/struct.Indices.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../../clap/parser/struct.Indices.html">../../../../clap/parser/struct.Indices.html</a>...</p>
|
||||
<script>location.replace("../../../../clap/parser/struct.Indices.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/clap/parser/matches/arg_matches/struct.RawValues.html
Normal file
11
doc/clap/parser/matches/arg_matches/struct.RawValues.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../../clap/parser/struct.RawValues.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../../clap/parser/struct.RawValues.html">../../../../clap/parser/struct.RawValues.html</a>...</p>
|
||||
<script>location.replace("../../../../clap/parser/struct.RawValues.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user