mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 08:28:24 +00:00
211 lines
57 KiB
HTML
211 lines
57 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="Command line argument parser kind of error"><title>ErrorKind in clap_builder::error - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-5bc39a1768837dd0.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="clap_builder" data-themes="" data-resource-suffix="" data-rustdoc-version="1.77.1 (7cf61ebde 2024-03-27)" data-channel="1.77.1" data-search-js="search-dd67cee4cfa65049.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-48f368f3872407c8.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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" title="show sidebar"></button><a class="logo-container" href="../../clap_builder/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../clap_builder/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><h2><a href="../../clap_builder/index.html">clap_builder</a><span class="version">4.5.2</span></h2></div><h2 class="location"><a href="#">ErrorKind</a></h2><div class="sidebar-elems"><section><h3><a href="#variants">Variants</a></h3><ul class="block variant"><li><a href="#variant.ArgumentConflict">ArgumentConflict</a></li><li><a href="#variant.DisplayHelp">DisplayHelp</a></li><li><a href="#variant.DisplayHelpOnMissingArgumentOrSubcommand">DisplayHelpOnMissingArgumentOrSubcommand</a></li><li><a href="#variant.DisplayVersion">DisplayVersion</a></li><li><a href="#variant.Format">Format</a></li><li><a href="#variant.InvalidSubcommand">InvalidSubcommand</a></li><li><a href="#variant.InvalidUtf8">InvalidUtf8</a></li><li><a href="#variant.InvalidValue">InvalidValue</a></li><li><a href="#variant.Io">Io</a></li><li><a href="#variant.MissingRequiredArgument">MissingRequiredArgument</a></li><li><a href="#variant.MissingSubcommand">MissingSubcommand</a></li><li><a href="#variant.NoEquals">NoEquals</a></li><li><a href="#variant.TooFewValues">TooFewValues</a></li><li><a href="#variant.TooManyValues">TooManyValues</a></li><li><a href="#variant.UnknownArgument">UnknownArgument</a></li><li><a href="#variant.ValueValidation">ValueValidation</a></li><li><a href="#variant.WrongNumberOfValues">WrongNumberOfValues</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.as_str">as_str</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-ErrorKind">Clone</a></li><li><a href="#impl-Copy-for-ErrorKind">Copy</a></li><li><a href="#impl-Debug-for-ErrorKind">Debug</a></li><li><a href="#impl-Display-for-ErrorKind">Display</a></li><li><a href="#impl-Eq-for-ErrorKind">Eq</a></li><li><a href="#impl-Hash-for-ErrorKind">Hash</a></li><li><a href="#impl-PartialEq-for-ErrorKind">PartialEq</a></li><li><a href="#impl-StructuralPartialEq-for-ErrorKind">StructuralPartialEq</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-ErrorKind">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ErrorKind">Send</a></li><li><a href="#impl-Sync-for-ErrorKind">Sync</a></li><li><a href="#impl-Unpin-for-ErrorKind">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ErrorKind">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T">Into<U></a></li><li><a href="#impl-ToOwned-for-T">ToOwned</a></li><li><a href="#impl-ToString-for-T">ToString</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto<U></a></li></ul></section><h2><a href="index.html">In clap_builder::error</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../clap_builder/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Enum <a href="../index.html">clap_builder</a>::<wbr><a href="index.html">error</a>::<wbr><a class="enum" href="#">ErrorKind</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/clap_builder/error/kind.rs.html#4-331">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code><div class="code-attribute">#[non_exhaustive]</div>pub enum ErrorKind {
|
||
<details class="toggle type-contents-toggle"><summary class="hideme"><span>Show 17 variants</span></summary> InvalidValue,
|
||
UnknownArgument,
|
||
InvalidSubcommand,
|
||
NoEquals,
|
||
ValueValidation,
|
||
TooManyValues,
|
||
TooFewValues,
|
||
WrongNumberOfValues,
|
||
ArgumentConflict,
|
||
MissingRequiredArgument,
|
||
MissingSubcommand,
|
||
InvalidUtf8,
|
||
DisplayHelp,
|
||
DisplayHelpOnMissingArgumentOrSubcommand,
|
||
DisplayVersion,
|
||
Io,
|
||
Format,
|
||
</details>}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Command line argument parser kind of error</p>
|
||
</div></details><h2 id="variants" class="variants section-header">Variants (Non-exhaustive)<a href="#variants" class="anchor">§</a></h2><details class="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><div class="variants"><section id="variant.InvalidValue" class="variant"><a href="#variant.InvalidValue" class="anchor">§</a><h3 class="code-header">InvalidValue</h3></section><div class="docblock"><p>Occurs when an <a href="../builder/struct.Arg.html" title="struct clap_builder::builder::Arg"><code>Arg</code></a> has a set of possible values,
|
||
and the user provides a value which isn’t in that set.</p>
|
||
<h4 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = Command::new(<span class="string">"prog"</span>)
|
||
.arg(Arg::new(<span class="string">"speed"</span>)
|
||
.value_parser([<span class="string">"fast"</span>, <span class="string">"slow"</span>]))
|
||
.try_get_matches_from(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"other"</span>]);
|
||
<span class="macro">assert!</span>(result.is_err());
|
||
<span class="macro">assert_eq!</span>(result.unwrap_err().kind(), ErrorKind::InvalidValue);</code></pre></div>
|
||
</div><section id="variant.UnknownArgument" class="variant"><a href="#variant.UnknownArgument" class="anchor">§</a><h3 class="code-header">UnknownArgument</h3></section><div class="docblock"><p>Occurs when a user provides a flag, option, argument or subcommand which isn’t defined.</p>
|
||
<h4 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = Command::new(<span class="string">"prog"</span>)
|
||
.arg(<span class="macro">arg!</span>(--flag <span class="string">"some flag"</span>))
|
||
.try_get_matches_from(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--other"</span>]);
|
||
<span class="macro">assert!</span>(result.is_err());
|
||
<span class="macro">assert_eq!</span>(result.unwrap_err().kind(), ErrorKind::UnknownArgument);</code></pre></div>
|
||
</div><section id="variant.InvalidSubcommand" class="variant"><a href="#variant.InvalidSubcommand" class="anchor">§</a><h3 class="code-header">InvalidSubcommand</h3></section><div class="docblock"><p>Occurs when the user provides an unrecognized <a href="../trait.Subcommand.html" title="trait clap_builder::Subcommand"><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" title="variant clap_builder::error::ErrorKind::UnknownArgument"><code>UnknownArgument</code></a> error is returned.</p>
|
||
<h4 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = Command::new(<span class="string">"prog"</span>)
|
||
.subcommand(Command::new(<span class="string">"config"</span>)
|
||
.about(<span class="string">"Used for configuration"</span>)
|
||
.arg(Arg::new(<span class="string">"config_file"</span>)
|
||
.help(<span class="string">"The configuration file to use"</span>)))
|
||
.try_get_matches_from(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"confi"</span>]);
|
||
<span class="macro">assert!</span>(result.is_err());
|
||
<span class="macro">assert_eq!</span>(result.unwrap_err().kind(), ErrorKind::InvalidSubcommand);</code></pre></div>
|
||
</div><section id="variant.NoEquals" class="variant"><a href="#variant.NoEquals" class="anchor">§</a><h3 class="code-header">NoEquals</h3></section><div class="docblock"><p>Occurs when the user doesn’t use equals for an option that requires equal
|
||
sign to provide values.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>res = Command::new(<span class="string">"prog"</span>)
|
||
.arg(Arg::new(<span class="string">"color"</span>)
|
||
.action(ArgAction::Set)
|
||
.require_equals(<span class="bool-val">true</span>)
|
||
.long(<span class="string">"color"</span>))
|
||
.try_get_matches_from(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--color"</span>, <span class="string">"red"</span>]);
|
||
<span class="macro">assert!</span>(res.is_err());
|
||
<span class="macro">assert_eq!</span>(res.unwrap_err().kind(), ErrorKind::NoEquals);</code></pre></div>
|
||
</div><section id="variant.ValueValidation" class="variant"><a href="#variant.ValueValidation" class="anchor">§</a><h3 class="code-header">ValueValidation</h3></section><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>
|
||
<h4 id="examples-3"><a class="doc-anchor" href="#examples-3">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">fn </span>is_numeric(val: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><(), String> {
|
||
<span class="kw">match </span>val.parse::<i64>() {
|
||
<span class="prelude-val">Ok</span>(..) => <span class="prelude-val">Ok</span>(()),
|
||
<span class="prelude-val">Err</span>(..) => <span class="prelude-val">Err</span>(String::from(<span class="string">"value wasn't a number!"</span>)),
|
||
}
|
||
}
|
||
|
||
<span class="kw">let </span>result = Command::new(<span class="string">"prog"</span>)
|
||
.arg(Arg::new(<span class="string">"num"</span>)
|
||
.value_parser(<span class="macro">value_parser!</span>(u8)))
|
||
.try_get_matches_from(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"NotANumber"</span>]);
|
||
<span class="macro">assert!</span>(result.is_err());
|
||
<span class="macro">assert_eq!</span>(result.unwrap_err().kind(), ErrorKind::ValueValidation);</code></pre></div>
|
||
</div><section id="variant.TooManyValues" class="variant"><a href="#variant.TooManyValues" class="anchor">§</a><h3 class="code-header">TooManyValues</h3></section><div class="docblock"><p>Occurs when a user provides more values for an argument than were defined by setting
|
||
<a href="../builder/struct.Arg.html#method.num_args" title="method clap_builder::builder::Arg::num_args"><code>Arg::num_args</code></a>.</p>
|
||
<h4 id="examples-4"><a class="doc-anchor" href="#examples-4">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = Command::new(<span class="string">"prog"</span>)
|
||
.arg(Arg::new(<span class="string">"arg"</span>)
|
||
.num_args(<span class="number">1</span>..=<span class="number">2</span>))
|
||
.try_get_matches_from(<span class="macro">vec!</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>(result.is_err());
|
||
<span class="macro">assert_eq!</span>(result.unwrap_err().kind(), ErrorKind::TooManyValues);</code></pre></div>
|
||
</div><section id="variant.TooFewValues" class="variant"><a href="#variant.TooFewValues" class="anchor">§</a><h3 class="code-header">TooFewValues</h3></section><div class="docblock"><p>Occurs when the user provides fewer values for an argument than were defined by setting
|
||
<a href="../builder/struct.Arg.html#method.num_args" title="method clap_builder::builder::Arg::num_args"><code>Arg::num_args</code></a>.</p>
|
||
<h4 id="examples-5"><a class="doc-anchor" href="#examples-5">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = Command::new(<span class="string">"prog"</span>)
|
||
.arg(Arg::new(<span class="string">"some_opt"</span>)
|
||
.long(<span class="string">"opt"</span>)
|
||
.num_args(<span class="number">3</span>..))
|
||
.try_get_matches_from(<span class="macro">vec!</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>(result.is_err());
|
||
<span class="macro">assert_eq!</span>(result.unwrap_err().kind(), ErrorKind::TooFewValues);</code></pre></div>
|
||
</div><section id="variant.WrongNumberOfValues" class="variant"><a href="#variant.WrongNumberOfValues" class="anchor">§</a><h3 class="code-header">WrongNumberOfValues</h3></section><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="../builder/struct.Arg.html#method.num_args" title="method clap_builder::builder::Arg::num_args"><code>Arg::num_args</code></a> or than was implicitly set by
|
||
<a href="../builder/struct.Arg.html#method.value_names" title="method clap_builder::builder::Arg::value_names"><code>Arg::value_names</code></a>.</p>
|
||
<h4 id="examples-6"><a class="doc-anchor" href="#examples-6">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = Command::new(<span class="string">"prog"</span>)
|
||
.arg(Arg::new(<span class="string">"some_opt"</span>)
|
||
.long(<span class="string">"opt"</span>)
|
||
.action(ArgAction::Set)
|
||
.num_args(<span class="number">2</span>))
|
||
.try_get_matches_from(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--opt"</span>, <span class="string">"wrong"</span>]);
|
||
<span class="macro">assert!</span>(result.is_err());
|
||
<span class="macro">assert_eq!</span>(result.unwrap_err().kind(), ErrorKind::WrongNumberOfValues);</code></pre></div>
|
||
</div><section id="variant.ArgumentConflict" class="variant"><a href="#variant.ArgumentConflict" class="anchor">§</a><h3 class="code-header">ArgumentConflict</h3></section><div class="docblock"><p>Occurs when the user provides two values which conflict with each other and can’t be used
|
||
together.</p>
|
||
<h4 id="examples-7"><a class="doc-anchor" href="#examples-7">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = Command::new(<span class="string">"prog"</span>)
|
||
.arg(Arg::new(<span class="string">"debug"</span>)
|
||
.long(<span class="string">"debug"</span>)
|
||
.action(ArgAction::SetTrue)
|
||
.conflicts_with(<span class="string">"color"</span>))
|
||
.arg(Arg::new(<span class="string">"color"</span>)
|
||
.long(<span class="string">"color"</span>)
|
||
.action(ArgAction::SetTrue))
|
||
.try_get_matches_from(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--debug"</span>, <span class="string">"--color"</span>]);
|
||
<span class="macro">assert!</span>(result.is_err());
|
||
<span class="macro">assert_eq!</span>(result.unwrap_err().kind(), ErrorKind::ArgumentConflict);</code></pre></div>
|
||
</div><section id="variant.MissingRequiredArgument" class="variant"><a href="#variant.MissingRequiredArgument" class="anchor">§</a><h3 class="code-header">MissingRequiredArgument</h3></section><div class="docblock"><p>Occurs when the user does not provide one or more required arguments.</p>
|
||
<h4 id="examples-8"><a class="doc-anchor" href="#examples-8">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = Command::new(<span class="string">"prog"</span>)
|
||
.arg(Arg::new(<span class="string">"debug"</span>)
|
||
.required(<span class="bool-val">true</span>))
|
||
.try_get_matches_from(<span class="macro">vec!</span>[<span class="string">"prog"</span>]);
|
||
<span class="macro">assert!</span>(result.is_err());
|
||
<span class="macro">assert_eq!</span>(result.unwrap_err().kind(), ErrorKind::MissingRequiredArgument);</code></pre></div>
|
||
</div><section id="variant.MissingSubcommand" class="variant"><a href="#variant.MissingSubcommand" class="anchor">§</a><h3 class="code-header">MissingSubcommand</h3></section><div class="docblock"><p>Occurs when a subcommand is required (as defined by <a href="../builder/struct.Command.html#method.subcommand_required" title="method clap_builder::builder::Command::subcommand_required"><code>Command::subcommand_required</code></a>),
|
||
but the user does not provide one.</p>
|
||
<h4 id="examples-9"><a class="doc-anchor" href="#examples-9">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>err = Command::new(<span class="string">"prog"</span>)
|
||
.subcommand_required(<span class="bool-val">true</span>)
|
||
.subcommand(Command::new(<span class="string">"test"</span>))
|
||
.try_get_matches_from(<span class="macro">vec!</span>[
|
||
<span class="string">"myprog"</span>,
|
||
]);
|
||
<span class="macro">assert!</span>(err.is_err());
|
||
<span class="macro">assert_eq!</span>(err.unwrap_err().kind(), ErrorKind::MissingSubcommand);</code></pre></div>
|
||
</div><section id="variant.InvalidUtf8" class="variant"><a href="#variant.InvalidUtf8" class="anchor">§</a><h3 class="code-header">InvalidUtf8</h3></section><div class="docblock"><p>Occurs when the user provides a value containing invalid UTF-8.</p>
|
||
<p>To allow arbitrary data</p>
|
||
<ul>
|
||
<li>Set [<code>Arg::value_parser(value_parser!(OsString))</code>] for argument values</li>
|
||
<li>Set <a href="../builder/struct.Command.html#method.external_subcommand_value_parser" title="method clap_builder::builder::Command::external_subcommand_value_parser"><code>Command::external_subcommand_value_parser</code></a> for external-subcommand
|
||
values</li>
|
||
</ul>
|
||
<h4 id="platform-specific"><a class="doc-anchor" href="#platform-specific">§</a>Platform Specific</h4>
|
||
<p>Non-Windows platforms only (such as Linux, Unix, OSX, etc.)</p>
|
||
<h4 id="examples-10"><a class="doc-anchor" href="#examples-10">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = Command::new(<span class="string">"prog"</span>)
|
||
.arg(Arg::new(<span class="string">"utf8"</span>)
|
||
.short(<span class="string">'u'</span>)
|
||
.action(ArgAction::Set))
|
||
.try_get_matches_from(<span class="macro">vec!</span>[OsString::from(<span class="string">"myprog"</span>),
|
||
OsString::from(<span class="string">"-u"</span>),
|
||
OsString::from_vec(<span class="macro">vec!</span>[<span class="number">0xE9</span>])]);
|
||
<span class="macro">assert!</span>(result.is_err());
|
||
<span class="macro">assert_eq!</span>(result.unwrap_err().kind(), ErrorKind::InvalidUtf8);</code></pre></div>
|
||
</div><section id="variant.DisplayHelp" class="variant"><a href="#variant.DisplayHelp" class="anchor">§</a><h3 class="code-header">DisplayHelp</h3></section><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>
|
||
<h4 id="examples-11"><a class="doc-anchor" href="#examples-11">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = Command::new(<span class="string">"prog"</span>)
|
||
.try_get_matches_from(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--help"</span>]);
|
||
<span class="macro">assert!</span>(result.is_err());
|
||
<span class="macro">assert_eq!</span>(result.unwrap_err().kind(), ErrorKind::DisplayHelp);</code></pre></div>
|
||
</div><section id="variant.DisplayHelpOnMissingArgumentOrSubcommand" class="variant"><a href="#variant.DisplayHelpOnMissingArgumentOrSubcommand" class="anchor">§</a><h3 class="code-header">DisplayHelpOnMissingArgumentOrSubcommand</h3></section><div class="docblock"><p>Occurs when either an argument or a <a href="../trait.Subcommand.html" title="trait clap_builder::Subcommand"><code>Subcommand</code></a> is required, as defined by
|
||
<a href="../builder/struct.Command.html#method.arg_required_else_help" title="method clap_builder::builder::Command::arg_required_else_help"><code>Command::arg_required_else_help</code></a> , but the user did not provide
|
||
one.</p>
|
||
<h4 id="examples-12"><a class="doc-anchor" href="#examples-12">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = Command::new(<span class="string">"prog"</span>)
|
||
.arg_required_else_help(<span class="bool-val">true</span>)
|
||
.subcommand(Command::new(<span class="string">"config"</span>)
|
||
.about(<span class="string">"Used for configuration"</span>)
|
||
.arg(Arg::new(<span class="string">"config_file"</span>)
|
||
.help(<span class="string">"The configuration file to use"</span>)))
|
||
.try_get_matches_from(<span class="macro">vec!</span>[<span class="string">"prog"</span>]);
|
||
<span class="macro">assert!</span>(result.is_err());
|
||
<span class="macro">assert_eq!</span>(result.unwrap_err().kind(), ErrorKind::DisplayHelpOnMissingArgumentOrSubcommand);</code></pre></div>
|
||
</div><section id="variant.DisplayVersion" class="variant"><a href="#variant.DisplayVersion" class="anchor">§</a><h3 class="code-header">DisplayVersion</h3></section><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>
|
||
<h4 id="examples-13"><a class="doc-anchor" href="#examples-13">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = Command::new(<span class="string">"prog"</span>)
|
||
.version(<span class="string">"3.0"</span>)
|
||
.try_get_matches_from(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--version"</span>]);
|
||
<span class="macro">assert!</span>(result.is_err());
|
||
<span class="macro">assert_eq!</span>(result.unwrap_err().kind(), ErrorKind::DisplayVersion);</code></pre></div>
|
||
</div><section id="variant.Io" class="variant"><a href="#variant.Io" class="anchor">§</a><h3 class="code-header">Io</h3></section><div class="docblock"><p>Represents an <a href="https://doc.rust-lang.org/1.77.1/std/io/error/struct.Error.html" title="struct std::io::error::Error">I/O error</a>.
|
||
Can occur when writing to <code>stderr</code> or <code>stdout</code> or reading a configuration file.</p>
|
||
</div><section id="variant.Format" class="variant"><a href="#variant.Format" class="anchor">§</a><h3 class="code-header">Format</h3></section><div class="docblock"><p>Represents a <a href="https://doc.rust-lang.org/1.77.1/core/fmt/struct.Error.html" title="struct core::fmt::Error">Format error</a> (which is a part of <a href="https://doc.rust-lang.org/1.77.1/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>Display</code></a>).
|
||
Typically caused by writing to <code>stderr</code> or <code>stdout</code>.</p>
|
||
</div></div><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-ErrorKind" class="impl"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#333-360">source</a><a href="#impl-ErrorKind" class="anchor">§</a><h3 class="code-header">impl <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.as_str" class="method"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#335-359">source</a><h4 class="code-header">pub fn <a href="#method.as_str" class="fn">as_str</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'static <a class="primitive" href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>></h4></section></summary><div class="docblock"><p>End-user description of the error case, where relevant</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-ErrorKind" class="impl"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#2">source</a><a href="#impl-Clone-for-ErrorKind" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#2">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.77.1/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.77.1/src/core/clone.rs.html#169">source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.77.1/std/primitive.reference.html">&Self</a>)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.77.1/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-ErrorKind" class="impl"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#2">source</a><a href="#impl-Debug-for-ErrorKind" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt-1" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#2">source</a><a href="#method.fmt-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.77.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.77.1/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.77.1/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Display-for-ErrorKind" class="impl"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#362-366">source</a><a href="#impl-Display-for-ErrorKind" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#363-365">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/fmt/trait.Display.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.77.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.77.1/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.77.1/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Hash-for-ErrorKind" class="impl"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#2">source</a><a href="#impl-Hash-for-ErrorKind" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.hash" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#2">source</a><a href="#method.hash" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/hash/trait.Hash.html#tymethod.hash" class="fn">hash</a><__H: <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>>(&self, state: <a class="primitive" href="https://doc.rust-lang.org/1.77.1/std/primitive.reference.html">&mut __H</a>)</h4></section></summary><div class='docblock'>Feeds this value into the given <a href="https://doc.rust-lang.org/1.77.1/core/hash/trait.Hasher.html" title="trait core::hash::Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.77.1/core/hash/trait.Hash.html#tymethod.hash">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.hash_slice" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.3.0">1.3.0</span> · <a class="src" href="https://doc.rust-lang.org/1.77.1/src/core/hash/mod.rs.html#238-240">source</a></span><a href="#method.hash_slice" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/hash/trait.Hash.html#method.hash_slice" class="fn">hash_slice</a><H>(data: &<a class="primitive" href="https://doc.rust-lang.org/1.77.1/std/primitive.slice.html">[Self]</a>, state: <a class="primitive" href="https://doc.rust-lang.org/1.77.1/std/primitive.reference.html">&mut H</a>)<div class="where">where
|
||
H: <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>,
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Feeds a slice of this type into the given <a href="https://doc.rust-lang.org/1.77.1/core/hash/trait.Hasher.html" title="trait core::hash::Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.77.1/core/hash/trait.Hash.html#method.hash_slice">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq-for-ErrorKind" class="impl"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#2">source</a><a href="#impl-PartialEq-for-ErrorKind" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#2">source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&self, other: &<a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
|
||
by <code>==</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.77.1/src/core/cmp.rs.html#242">source</a></span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/cmp/trait.PartialEq.html#method.ne" class="fn">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.77.1/std/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
|
||
sufficient, and should not be overridden without very good reason.</div></details></div></details><section id="impl-Copy-for-ErrorKind" class="impl"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#2">source</a><a href="#impl-Copy-for-ErrorKind" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h3></section><section id="impl-Eq-for-ErrorKind" class="impl"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#2">source</a><a href="#impl-Eq-for-ErrorKind" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h3></section><section id="impl-StructuralPartialEq-for-ErrorKind" class="impl"><a class="src rightside" href="../../src/clap_builder/error/kind.rs.html#2">source</a><a href="#impl-StructuralPartialEq-for-ErrorKind" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-ErrorKind" class="impl"><a href="#impl-RefUnwindSafe-for-ErrorKind" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h3></section><section id="impl-Send-for-ErrorKind" class="impl"><a href="#impl-Send-for-ErrorKind" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h3></section><section id="impl-Sync-for-ErrorKind" class="impl"><a href="#impl-Sync-for-ErrorKind" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h3></section><section id="impl-Unpin-for-ErrorKind" class="impl"><a href="#impl-Unpin-for-ErrorKind" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h3></section><section id="impl-UnwindSafe-for-ErrorKind" class="impl"><a href="#impl-UnwindSafe-for-ErrorKind" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.77.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.77.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.77.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.77.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.77.1/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.77.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.77.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.77.1/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.77.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#764">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#767">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#747-749">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#757">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/convert/trait.Into.html#tymethod.into" class="fn">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.77.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/alloc/borrow.rs.html#83-85">source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/alloc/borrow.rs.html#88">source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/alloc/borrow.rs.html#92">source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.77.1/std/primitive.reference.html">&mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToString-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/alloc/string.rs.html#2600">source</a><a href="#impl-ToString-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.77.1/alloc/string/trait.ToString.html" title="trait alloc::string::ToString">ToString</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.77.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.to_string" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/alloc/string.rs.html#2606">source</a><a href="#method.to_string" class="anchor">§</a><h4 class="code-header">default fn <a href="https://doc.rust-lang.org/1.77.1/alloc/string/trait.ToString.html#tymethod.to_string" class="fn">to_string</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.77.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class='docblock'>Converts the given value to a <code>String</code>. <a href="https://doc.rust-lang.org/1.77.1/alloc/string/trait.ToString.html#tymethod.to_string">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#804-806">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.77.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#811">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.77.1/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.77.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#789-791">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#796">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.77.1/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.77.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |