mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-25 10:22:19 +00:00
259 lines
59 KiB
HTML
259 lines
59 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `ErrorKind` enum in crate `structopt`."><meta name="keywords" content="rust, rustlang, rust-lang, ErrorKind"><title>structopt::clap::ErrorKind - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc enum"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../structopt/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Enum ErrorKind</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.InvalidValue">InvalidValue</a><a href="#variant.UnknownArgument">UnknownArgument</a><a href="#variant.InvalidSubcommand">InvalidSubcommand</a><a href="#variant.UnrecognizedSubcommand">UnrecognizedSubcommand</a><a href="#variant.EmptyValue">EmptyValue</a><a href="#variant.ValueValidation">ValueValidation</a><a href="#variant.TooManyValues">TooManyValues</a><a href="#variant.TooFewValues">TooFewValues</a><a href="#variant.WrongNumberOfValues">WrongNumberOfValues</a><a href="#variant.ArgumentConflict">ArgumentConflict</a><a href="#variant.MissingRequiredArgument">MissingRequiredArgument</a><a href="#variant.MissingSubcommand">MissingSubcommand</a><a href="#variant.MissingArgumentOrSubcommand">MissingArgumentOrSubcommand</a><a href="#variant.UnexpectedMultipleUsage">UnexpectedMultipleUsage</a><a href="#variant.InvalidUtf8">InvalidUtf8</a><a href="#variant.HelpDisplayed">HelpDisplayed</a><a href="#variant.VersionDisplayed">VersionDisplayed</a><a href="#variant.ArgumentNotFound">ArgumentNotFound</a><a href="#variant.Io">Io</a><a href="#variant.Format">Format</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Copy">Copy</a><a href="#impl-Debug">Debug</a><a href="#impl-PartialEq%3CErrorKind%3E">PartialEq<ErrorKind></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class='location'><a href='../index.html'>structopt</a>::<wbr><a href='index.html'>clap</a></p><script>window.sidebarCurrent = {name: 'ErrorKind', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/clap/errors.rs.html#22-372' title='goto source code'>[src]</a></span><span class='in-band'>Enum <a href='../index.html'>structopt</a>::<wbr><a href='index.html'>clap</a>::<wbr><a class="enum" href=''>ErrorKind</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust enum'>pub enum ErrorKind {
|
||
InvalidValue,
|
||
UnknownArgument,
|
||
InvalidSubcommand,
|
||
UnrecognizedSubcommand,
|
||
EmptyValue,
|
||
ValueValidation,
|
||
TooManyValues,
|
||
TooFewValues,
|
||
WrongNumberOfValues,
|
||
ArgumentConflict,
|
||
MissingRequiredArgument,
|
||
MissingSubcommand,
|
||
MissingArgumentOrSubcommand,
|
||
UnexpectedMultipleUsage,
|
||
InvalidUtf8,
|
||
HelpDisplayed,
|
||
VersionDisplayed,
|
||
ArgumentNotFound,
|
||
Io,
|
||
Format,
|
||
}</pre></div><div class='docblock'><p>Command line argument parser kind of error</p>
|
||
</div><h2 id='variants' class='variants small-section-header'>
|
||
Variants<a href='#variants' class='anchor'></a></h2>
|
||
<span id="variant.InvalidValue" class="variant small-section-header"><a href="#variant.InvalidValue" class="anchor field"></a><code id='InvalidValue.v'>InvalidValue</code></span><div class='docblock'><p>Occurs when an <a href="./struct.Arg.html"><code>Arg</code></a> has a set of possible values,
|
||
and the user provides a value which isn't in that set.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">with_name</span>(<span class="string">"speed"</span>)
|
||
.<span class="ident">possible_value</span>(<span class="string">"fast"</span>)
|
||
.<span class="ident">possible_value</span>(<span class="string">"slow"</span>))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>, <span class="string">"other"</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">InvalidValue</span>);</pre></div>
|
||
</div><span id="variant.UnknownArgument" class="variant small-section-header"><a href="#variant.UnknownArgument" class="anchor field"></a><code id='UnknownArgument.v'>UnknownArgument</code></span><div class='docblock'><p>Occurs when a user provides a flag, option, argument or subcommand which isn't defined.</p>
|
||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">from_usage</span>(<span class="string">"--flag 'some flag'"</span>))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>, <span class="string">"--other"</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">UnknownArgument</span>);</pre></div>
|
||
</div><span id="variant.InvalidSubcommand" class="variant small-section-header"><a href="#variant.InvalidSubcommand" class="anchor field"></a><code id='InvalidSubcommand.v'>InvalidSubcommand</code></span><div class='docblock'><p>Occurs when the user provides an unrecognized <a href="./struct.SubCommand.html"><code>SubCommand</code></a> which meets the threshold for
|
||
being similar enough to an existing subcommand.
|
||
If it doesn't meet the threshold, or the 'suggestions' feature is disabled,
|
||
the more general <a href="./enum.ErrorKind.html#variant.UnknownArgument"><code>UnknownArgument</code></a> error is returned.</p>
|
||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">subcommand</span>(<span class="ident">SubCommand</span>::<span class="ident">with_name</span>(<span class="string">"config"</span>)
|
||
.<span class="ident">about</span>(<span class="string">"Used for configuration"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">with_name</span>(<span class="string">"config_file"</span>)
|
||
.<span class="ident">help</span>(<span class="string">"The configuration file to use"</span>)
|
||
.<span class="ident">index</span>(<span class="number">1</span>)))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>, <span class="string">"confi"</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">InvalidSubcommand</span>);</pre></div>
|
||
</div><span id="variant.UnrecognizedSubcommand" class="variant small-section-header"><a href="#variant.UnrecognizedSubcommand" class="anchor field"></a><code id='UnrecognizedSubcommand.v'>UnrecognizedSubcommand</code></span><div class='docblock'><p>Occurs when the user provides an unrecognized <a href="./struct.SubCommand.html"><code>SubCommand</code></a> which either
|
||
doesn't meet the threshold for being similar enough to an existing subcommand,
|
||
or the 'suggestions' feature is disabled.
|
||
Otherwise the more detailed <a href="./enum.ErrorKind.html#variant.InvalidSubcommand"><code>InvalidSubcommand</code></a> error is returned.</p>
|
||
<p>This error typically happens when passing additional subcommand names to the <code>help</code>
|
||
subcommand. Otherwise, the more general <a href="./enum.ErrorKind.html#variant.UnknownArgument"><code>UnknownArgument</code></a> error is used.</p>
|
||
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">subcommand</span>(<span class="ident">SubCommand</span>::<span class="ident">with_name</span>(<span class="string">"config"</span>)
|
||
.<span class="ident">about</span>(<span class="string">"Used for configuration"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">with_name</span>(<span class="string">"config_file"</span>)
|
||
.<span class="ident">help</span>(<span class="string">"The configuration file to use"</span>)
|
||
.<span class="ident">index</span>(<span class="number">1</span>)))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>, <span class="string">"help"</span>, <span class="string">"nothing"</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">UnrecognizedSubcommand</span>);</pre></div>
|
||
</div><span id="variant.EmptyValue" class="variant small-section-header"><a href="#variant.EmptyValue" class="anchor field"></a><code id='EmptyValue.v'>EmptyValue</code></span><div class='docblock'><p>Occurs when the user provides an empty value for an option that does not allow empty
|
||
values.</p>
|
||
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">with_name</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">empty_values</span>(<span class="bool-val">false</span>))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>, <span class="string">"--color="</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">res</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">res</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">EmptyValue</span>);</pre></div>
|
||
</div><span id="variant.ValueValidation" class="variant small-section-header"><a href="#variant.ValueValidation" class="anchor field"></a><code id='ValueValidation.v'>ValueValidation</code></span><div class='docblock'><p>Occurs when the user provides a value for an argument with a custom validation and the
|
||
value fails that validation.</p>
|
||
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">fn</span> <span class="ident">is_numeric</span>(<span class="ident">val</span>: <span class="ident">String</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">String</span><span class="op">></span> {
|
||
<span class="kw">match</span> <span class="ident">val</span>.<span class="ident">parse</span>::<span class="op"><</span><span class="ident">i64</span><span class="op">></span>() {
|
||
<span class="prelude-val">Ok</span>(..) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(()),
|
||
<span class="prelude-val">Err</span>(..) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">String</span>::<span class="ident">from</span>(<span class="string">"Value wasn't a number!"</span>)),
|
||
}
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">with_name</span>(<span class="string">"num"</span>)
|
||
.<span class="ident">validator</span>(<span class="ident">is_numeric</span>))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>, <span class="string">"NotANumber"</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">ValueValidation</span>);</pre></div>
|
||
</div><span id="variant.TooManyValues" class="variant small-section-header"><a href="#variant.TooManyValues" class="anchor field"></a><code id='TooManyValues.v'>TooManyValues</code></span><div class='docblock'><p>Occurs when a user provides more values for an argument than were defined by setting
|
||
<a href="./struct.Arg.html#method.max_values"><code>Arg::max_values</code></a>.</p>
|
||
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">with_name</span>(<span class="string">"arg"</span>)
|
||
.<span class="ident">multiple</span>(<span class="bool-val">true</span>)
|
||
.<span class="ident">max_values</span>(<span class="number">2</span>))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>, <span class="string">"too"</span>, <span class="string">"many"</span>, <span class="string">"values"</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">TooManyValues</span>);</pre></div>
|
||
</div><span id="variant.TooFewValues" class="variant small-section-header"><a href="#variant.TooFewValues" class="anchor field"></a><code id='TooFewValues.v'>TooFewValues</code></span><div class='docblock'><p>Occurs when the user provides fewer values for an argument than were defined by setting
|
||
<a href="./struct.Arg.html#method.min_values"><code>Arg::min_values</code></a>.</p>
|
||
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">with_name</span>(<span class="string">"some_opt"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"opt"</span>)
|
||
.<span class="ident">min_values</span>(<span class="number">3</span>))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>, <span class="string">"--opt"</span>, <span class="string">"too"</span>, <span class="string">"few"</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">TooFewValues</span>);</pre></div>
|
||
</div><span id="variant.WrongNumberOfValues" class="variant small-section-header"><a href="#variant.WrongNumberOfValues" class="anchor field"></a><code id='WrongNumberOfValues.v'>WrongNumberOfValues</code></span><div class='docblock'><p>Occurs when the user provides a different number of values for an argument than what's
|
||
been defined by setting <a href="./struct.Arg.html#method.number_of_values"><code>Arg::number_of_values</code></a> or than was implicitly set by
|
||
<a href="./struct.Arg.html#method.value_names"><code>Arg::value_names</code></a>.</p>
|
||
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">with_name</span>(<span class="string">"some_opt"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"opt"</span>)
|
||
.<span class="ident">takes_value</span>(<span class="bool-val">true</span>)
|
||
.<span class="ident">number_of_values</span>(<span class="number">2</span>))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>, <span class="string">"--opt"</span>, <span class="string">"wrong"</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">WrongNumberOfValues</span>);</pre></div>
|
||
</div><span id="variant.ArgumentConflict" class="variant small-section-header"><a href="#variant.ArgumentConflict" class="anchor field"></a><code id='ArgumentConflict.v'>ArgumentConflict</code></span><div class='docblock'><p>Occurs when the user provides two values which conflict with each other and can't be used
|
||
together.</p>
|
||
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">with_name</span>(<span class="string">"debug"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"debug"</span>)
|
||
.<span class="ident">conflicts_with</span>(<span class="string">"color"</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">with_name</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"color"</span>))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>, <span class="string">"--debug"</span>, <span class="string">"--color"</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">ArgumentConflict</span>);</pre></div>
|
||
</div><span id="variant.MissingRequiredArgument" class="variant small-section-header"><a href="#variant.MissingRequiredArgument" class="anchor field"></a><code id='MissingRequiredArgument.v'>MissingRequiredArgument</code></span><div class='docblock'><p>Occurs when the user does not provide one or more required arguments.</p>
|
||
<h1 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">with_name</span>(<span class="string">"debug"</span>)
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">MissingRequiredArgument</span>);</pre></div>
|
||
</div><span id="variant.MissingSubcommand" class="variant small-section-header"><a href="#variant.MissingSubcommand" class="anchor field"></a><code id='MissingSubcommand.v'>MissingSubcommand</code></span><div class='docblock'><p>Occurs when a subcommand is required (as defined by <a href="./enum.AppSettings.html#variant.SubcommandRequired"><code>AppSettings::SubcommandRequired</code></a>),
|
||
but the user does not provide one.</p>
|
||
<h1 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">setting</span>(<span class="ident">AppSettings</span>::<span class="ident">SubcommandRequired</span>)
|
||
.<span class="ident">subcommand</span>(<span class="ident">SubCommand</span>::<span class="ident">with_name</span>(<span class="string">"test"</span>))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[
|
||
<span class="string">"myprog"</span>,
|
||
]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">err</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">err</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">MissingSubcommand</span>);</pre></div>
|
||
</div><span id="variant.MissingArgumentOrSubcommand" class="variant small-section-header"><a href="#variant.MissingArgumentOrSubcommand" class="anchor field"></a><code id='MissingArgumentOrSubcommand.v'>MissingArgumentOrSubcommand</code></span><div class='docblock'><p>Occurs when either an argument or <a href="./struct.SubCommand.html"><code>SubCommand</code></a> is required, as defined by
|
||
<a href="./enum.AppSettings.html#variant.ArgRequiredElseHelp"><code>AppSettings::ArgRequiredElseHelp</code></a>, but the user did not provide one.</p>
|
||
<h1 id="examples-12" class="section-header"><a href="#examples-12">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">setting</span>(<span class="ident">AppSettings</span>::<span class="ident">ArgRequiredElseHelp</span>)
|
||
.<span class="ident">subcommand</span>(<span class="ident">SubCommand</span>::<span class="ident">with_name</span>(<span class="string">"config"</span>)
|
||
.<span class="ident">about</span>(<span class="string">"Used for configuration"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">with_name</span>(<span class="string">"config_file"</span>)
|
||
.<span class="ident">help</span>(<span class="string">"The configuration file to use"</span>)))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">MissingArgumentOrSubcommand</span>);</pre></div>
|
||
</div><span id="variant.UnexpectedMultipleUsage" class="variant small-section-header"><a href="#variant.UnexpectedMultipleUsage" class="anchor field"></a><code id='UnexpectedMultipleUsage.v'>UnexpectedMultipleUsage</code></span><div class='docblock'><p>Occurs when the user provides multiple values to an argument which doesn't allow that.</p>
|
||
<h1 id="examples-13" class="section-header"><a href="#examples-13">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">with_name</span>(<span class="string">"debug"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"debug"</span>)
|
||
.<span class="ident">multiple</span>(<span class="bool-val">false</span>))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>, <span class="string">"--debug"</span>, <span class="string">"--debug"</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">UnexpectedMultipleUsage</span>);</pre></div>
|
||
</div><span id="variant.InvalidUtf8" class="variant small-section-header"><a href="#variant.InvalidUtf8" class="anchor field"></a><code id='InvalidUtf8.v'>InvalidUtf8</code></span><div class='docblock'><p>Occurs when the user provides a value containing invalid UTF-8 for an argument and
|
||
<a href="./enum.AppSettings.html#variant.StrictUtf8"><code>AppSettings::StrictUtf8</code></a> is set.</p>
|
||
<h1 id="platform-specific" class="section-header"><a href="#platform-specific">Platform Specific</a></h1>
|
||
<p>Non-Windows platforms only (such as Linux, Unix, macOS, etc.)</p>
|
||
<h1 id="examples-14" class="section-header"><a href="#examples-14">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">setting</span>(<span class="ident">AppSettings</span>::<span class="ident">StrictUtf8</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg</span>::<span class="ident">with_name</span>(<span class="string">"utf8"</span>)
|
||
.<span class="ident">short</span>(<span class="string">"u"</span>)
|
||
.<span class="ident">takes_value</span>(<span class="bool-val">true</span>))
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="ident">OsString</span>::<span class="ident">from</span>(<span class="string">"myprog"</span>),
|
||
<span class="ident">OsString</span>::<span class="ident">from</span>(<span class="string">"-u"</span>),
|
||
<span class="ident">OsString</span>::<span class="ident">from_vec</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="number">0xE9</span>])]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">InvalidUtf8</span>);</pre></div>
|
||
</div><span id="variant.HelpDisplayed" class="variant small-section-header"><a href="#variant.HelpDisplayed" class="anchor field"></a><code id='HelpDisplayed.v'>HelpDisplayed</code></span><div class='docblock'><p>Not a true "error" as it means <code>--help</code> or similar was used.
|
||
The help message will be sent to <code>stdout</code>.</p>
|
||
<p><strong>Note</strong>: If the help is displayed due to an error (such as missing subcommands) it will
|
||
be sent to <code>stderr</code> instead of <code>stdout</code>.</p>
|
||
<h1 id="examples-15" class="section-header"><a href="#examples-15">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>, <span class="string">"--help"</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">HelpDisplayed</span>);</pre></div>
|
||
</div><span id="variant.VersionDisplayed" class="variant small-section-header"><a href="#variant.VersionDisplayed" class="anchor field"></a><code id='VersionDisplayed.v'>VersionDisplayed</code></span><div class='docblock'><p>Not a true "error" as it means <code>--version</code> or similar was used.
|
||
The message will be sent to <code>stdout</code>.</p>
|
||
<h1 id="examples-16" class="section-header"><a href="#examples-16">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">get_matches_from_safe</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"prog"</span>, <span class="string">"--version"</span>]);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>, <span class="ident">ErrorKind</span>::<span class="ident">VersionDisplayed</span>);</pre></div>
|
||
</div><span id="variant.ArgumentNotFound" class="variant small-section-header"><a href="#variant.ArgumentNotFound" class="anchor field"></a><code id='ArgumentNotFound.v'>ArgumentNotFound</code></span><div class='docblock'><p>Occurs when using the [<code>value_t!</code>] and [<code>values_t!</code>] macros to convert an argument value
|
||
into type <code>T</code>, but the argument you requested wasn't used. I.e. you asked for an argument
|
||
with name <code>config</code> to be converted, but <code>config</code> wasn't used by the user.
|
||
[<code>value_t!</code>]: ./macro.value_t!.html
|
||
[<code>values_t!</code>]: ./macro.values_t!.html</p>
|
||
</div><span id="variant.Io" class="variant small-section-header"><a href="#variant.Io" class="anchor field"></a><code id='Io.v'>Io</code></span><div class='docblock'><p>Represents an [I/O error].
|
||
Can occur when writing to <code>stderr</code> or <code>stdout</code> or reading a configuration file.
|
||
[I/O error]: https://doc.rust-lang.org/std/io/struct.Error.html</p>
|
||
</div><span id="variant.Format" class="variant small-section-header"><a href="#variant.Format" class="anchor field"></a><code id='Format.v'>Format</code></span><div class='docblock'><p>Represents a <a href="https://doc.rust-lang.org/std/fmt/struct.Error.html">Format error</a> (which is a part of <a href="https://doc.rust-lang.org/std/fmt/trait.Display.html"><code>Display</code></a>).
|
||
Typically caused by writing to <code>stderr</code> or <code>stdout</code>.</p>
|
||
</div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-PartialEq%3CErrorKind%3E' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="enum" href="../../structopt/clap/enum.ErrorKind.html" title="enum structopt::clap::ErrorKind">ErrorKind</a>> for <a class="enum" href="../../structopt/clap/enum.ErrorKind.html" title="enum structopt::clap::ErrorKind">ErrorKind</a></code><a href='#impl-PartialEq%3CErrorKind%3E' class='anchor'></a><a class='srclink' href='../../src/clap/errors.rs.html#21' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.eq' class="method hidden"><code id='eq.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, other: &<a class="enum" href="../../structopt/clap/enum.ErrorKind.html" title="enum structopt::clap::ErrorKind">ErrorKind</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/clap/errors.rs.html#21' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||
</div><h4 id='method.ne' class="method hidden"><code id='ne.v'><span class="docblock attributes">#[must_use]
|
||
</span>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#200' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>!=</code>.</p>
|
||
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../structopt/clap/enum.ErrorKind.html" title="enum structopt::clap::ErrorKind">ErrorKind</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../src/clap/errors.rs.html#21' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code><a class='srclink' href='../../src/clap/errors.rs.html#21' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id='impl-Clone' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../../structopt/clap/enum.ErrorKind.html" title="enum structopt::clap::ErrorKind">ErrorKind</a></code><a href='#impl-Clone' class='anchor'></a><a class='srclink' href='../../src/clap/errors.rs.html#21' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.clone' class="method hidden"><code id='clone.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="enum" href="../../structopt/clap/enum.ErrorKind.html" title="enum structopt::clap::ErrorKind">ErrorKind</a></code><a class='srclink' href='../../src/clap/errors.rs.html#21' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class="method hidden"><code id='clone_from.v'>fn <a href='https://doc.rust-lang.org/nightly/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/nightly/std/primitive.reference.html">&</a>Self)</code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#131-133' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></div><h3 id='impl-Copy' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="../../structopt/clap/enum.ErrorKind.html" title="enum structopt::clap::ErrorKind">ErrorKind</a></code><a href='#impl-Copy' class='anchor'></a><a class='srclink' href='../../src/clap/errors.rs.html#21' title='goto source code'>[src]</a></h3><div class='impl-items'></div></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'><h3 id='impl-Sync' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../../structopt/clap/enum.ErrorKind.html" title="enum structopt::clap::ErrorKind">ErrorKind</a></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Send' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../../structopt/clap/enum.ErrorKind.html" title="enum structopt::clap::ErrorKind">ErrorKind</a></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="../../structopt/clap/enum.ErrorKind.html" title="enum structopt::clap::ErrorKind">ErrorKind</a></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="../../structopt/clap/enum.ErrorKind.html" title="enum structopt::clap::ErrorKind">ErrorKind</a></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="enum" href="../../structopt/clap/enum.ErrorKind.html" title="enum structopt::clap::ErrorKind">ErrorKind</a></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#543-548' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#545-547' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#552-554' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-ToOwned' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href='#impl-ToOwned' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-92' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Owned' class="type"><code id='Owned.t'>type <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned' class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||
</div><h4 id='method.to_owned' class="method hidden"><code id='to_owned.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned' class='fnname'>to_owned</a>(&self) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
</div><h4 id='method.clone_into' class="method hidden"><code id='clone_into.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into' class='fnname'>clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89-91' title='goto source code'>[src]</a></h4><div class='stability hidden'><div class='stab unstable'><details><summary><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
||
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#571-577' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#574-576' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#559-566' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#563-565' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "structopt";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |