mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-19 17:14:24 +00:00
68 lines
45 KiB
HTML
68 lines
45 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="Provide shell with hint on how to complete an argument."><title>ValueHint in clap_builder::builder - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.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.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><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.11</span></h2></div><h2 class="location"><a href="#">ValueHint</a></h2><div class="sidebar-elems"><section><h3><a href="#variants">Variants</a></h3><ul class="block variant"><li><a href="#variant.AnyPath">AnyPath</a></li><li><a href="#variant.CommandName">CommandName</a></li><li><a href="#variant.CommandString">CommandString</a></li><li><a href="#variant.CommandWithArguments">CommandWithArguments</a></li><li><a href="#variant.DirPath">DirPath</a></li><li><a href="#variant.EmailAddress">EmailAddress</a></li><li><a href="#variant.ExecutablePath">ExecutablePath</a></li><li><a href="#variant.FilePath">FilePath</a></li><li><a href="#variant.Hostname">Hostname</a></li><li><a href="#variant.Other">Other</a></li><li><a href="#variant.Unknown">Unknown</a></li><li><a href="#variant.Url">Url</a></li><li><a href="#variant.Username">Username</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-ValueHint">Clone</a></li><li><a href="#impl-Copy-for-ValueHint">Copy</a></li><li><a href="#impl-Debug-for-ValueHint">Debug</a></li><li><a href="#impl-Default-for-ValueHint">Default</a></li><li><a href="#impl-Eq-for-ValueHint">Eq</a></li><li><a href="#impl-FromStr-for-ValueHint">FromStr</a></li><li><a href="#impl-Hash-for-ValueHint">Hash</a></li><li><a href="#impl-IntoResettable%3CValueHint%3E-for-Option%3CValueHint%3E">IntoResettable<ValueHint></a></li><li><a href="#impl-IntoResettable%3CValueHint%3E-for-ValueHint">IntoResettable<ValueHint></a></li><li><a href="#impl-PartialEq-for-ValueHint">PartialEq</a></li><li><a href="#impl-StructuralPartialEq-for-ValueHint">StructuralPartialEq</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-ValueHint">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-ValueHint">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ValueHint">Send</a></li><li><a href="#impl-Sync-for-ValueHint">Sync</a></li><li><a href="#impl-Unpin-for-ValueHint">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ValueHint">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-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::builder</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Enum <a href="../index.html">clap_builder</a>::<wbr><a href="index.html">builder</a>::<wbr><a class="enum" href="#">ValueHint</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/clap_builder/builder/value_hint.rs.html#29-68">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 ValueHint {
|
||
<details class="toggle type-contents-toggle"><summary class="hideme"><span>Show 13 variants</span></summary> Unknown,
|
||
Other,
|
||
AnyPath,
|
||
FilePath,
|
||
DirPath,
|
||
ExecutablePath,
|
||
CommandName,
|
||
CommandString,
|
||
CommandWithArguments,
|
||
Username,
|
||
Hostname,
|
||
Url,
|
||
EmailAddress,
|
||
</details>}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Provide shell with hint on how to complete an argument.</p>
|
||
<p>See <a href="struct.Arg.html#method.value_hint" title="method clap_builder::builder::Arg::value_hint"><code>Arg::value_hint</code></a> to set this on an argument.</p>
|
||
<p>See the <code>clap_complete</code> crate for completion script generation.</p>
|
||
<p>Overview of which hints are supported by which shell:</p>
|
||
<div><table><thead><tr><th>Hint</th><th>zsh</th><th>fish<sup id="fnref1"><a href="#fn1">1</a></sup></th></tr></thead><tbody>
|
||
<tr><td><code>AnyPath</code></td><td>Yes</td><td>Yes</td></tr>
|
||
<tr><td><code>FilePath</code></td><td>Yes</td><td>Yes</td></tr>
|
||
<tr><td><code>DirPath</code></td><td>Yes</td><td>Yes</td></tr>
|
||
<tr><td><code>ExecutablePath</code></td><td>Yes</td><td>Partial</td></tr>
|
||
<tr><td><code>CommandName</code></td><td>Yes</td><td>Yes</td></tr>
|
||
<tr><td><code>CommandString</code></td><td>Yes</td><td>Partial</td></tr>
|
||
<tr><td><code>CommandWithArguments</code></td><td>Yes</td><td></td></tr>
|
||
<tr><td><code>Username</code></td><td>Yes</td><td>Yes</td></tr>
|
||
<tr><td><code>Hostname</code></td><td>Yes</td><td>Yes</td></tr>
|
||
<tr><td><code>Url</code></td><td>Yes</td><td></td></tr>
|
||
<tr><td><code>EmailAddress</code></td><td>Yes</td><td></td></tr>
|
||
</tbody></table>
|
||
</div><div class="footnotes"><hr><ol><li id="fn1"><p>fish completions currently only support named arguments (e.g. -o or –opt), not
|
||
positional arguments. <a href="#fnref1">↩</a></p></li></ol></div></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.Unknown" class="variant"><a href="#variant.Unknown" class="anchor">§</a><h3 class="code-header">Unknown</h3></section><div class="docblock"><p>Default value if hint is not specified. Follows shell default behavior, which is usually
|
||
auto-completing filenames.</p>
|
||
</div><section id="variant.Other" class="variant"><a href="#variant.Other" class="anchor">§</a><h3 class="code-header">Other</h3></section><div class="docblock"><p>None of the hints below apply. Disables shell completion for this argument.</p>
|
||
</div><section id="variant.AnyPath" class="variant"><a href="#variant.AnyPath" class="anchor">§</a><h3 class="code-header">AnyPath</h3></section><div class="docblock"><p>Any existing path.</p>
|
||
</div><section id="variant.FilePath" class="variant"><a href="#variant.FilePath" class="anchor">§</a><h3 class="code-header">FilePath</h3></section><div class="docblock"><p>Path to a file.</p>
|
||
</div><section id="variant.DirPath" class="variant"><a href="#variant.DirPath" class="anchor">§</a><h3 class="code-header">DirPath</h3></section><div class="docblock"><p>Path to a directory.</p>
|
||
</div><section id="variant.ExecutablePath" class="variant"><a href="#variant.ExecutablePath" class="anchor">§</a><h3 class="code-header">ExecutablePath</h3></section><div class="docblock"><p>Path to an executable file.</p>
|
||
</div><section id="variant.CommandName" class="variant"><a href="#variant.CommandName" class="anchor">§</a><h3 class="code-header">CommandName</h3></section><div class="docblock"><p>Name of a command, without arguments. May be relative to PATH, or full path to executable.</p>
|
||
</div><section id="variant.CommandString" class="variant"><a href="#variant.CommandString" class="anchor">§</a><h3 class="code-header">CommandString</h3></section><div class="docblock"><p>A single string containing a command and its arguments.</p>
|
||
</div><section id="variant.CommandWithArguments" class="variant"><a href="#variant.CommandWithArguments" class="anchor">§</a><h3 class="code-header">CommandWithArguments</h3></section><div class="docblock"><p>Capture the remaining arguments as a command name and arguments for that command. This is
|
||
common when writing shell wrappers that execute anther command, for example <code>sudo</code> or <code>env</code>.</p>
|
||
<p>This hint is special, the argument must be a positional argument and have
|
||
<a href="struct.Arg.html#method.num_args" title="method clap_builder::builder::Arg::num_args"><code>.num_args(1..)</code></a> and Command must use <a href="struct.Command.html#method.trailing_var_arg" title="method clap_builder::builder::Command::trailing_var_arg"><code>Command::trailing_var_arg(true)</code></a>. The result is that the
|
||
command line <code>my_app ls -la /</code> will be parsed as <code>["ls", "-la", "/"]</code> and clap won’t try to
|
||
parse the <code>-la</code> argument itself.</p>
|
||
</div><section id="variant.Username" class="variant"><a href="#variant.Username" class="anchor">§</a><h3 class="code-header">Username</h3></section><div class="docblock"><p>Name of a local operating system user.</p>
|
||
</div><section id="variant.Hostname" class="variant"><a href="#variant.Hostname" class="anchor">§</a><h3 class="code-header">Hostname</h3></section><div class="docblock"><p>Host name of a computer.
|
||
Shells usually parse <code>/etc/hosts</code> and <code>.ssh/known_hosts</code> to complete hostnames.</p>
|
||
</div><section id="variant.Url" class="variant"><a href="#variant.Url" class="anchor">§</a><h3 class="code-header">Url</h3></section><div class="docblock"><p>Complete web address.</p>
|
||
</div><section id="variant.EmailAddress" class="variant"><a href="#variant.EmailAddress" class="anchor">§</a><h3 class="code-header">EmailAddress</h3></section><div class="docblock"><p>Email address.</p>
|
||
</div></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-ValueHint" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/value_hint.rs.html#27">source</a><a href="#impl-Clone-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</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/builder/value_hint.rs.html#27">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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-ValueHint" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/value_hint.rs.html#27">source</a><a href="#impl-Debug-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</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/builder/value_hint.rs.html#27">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.80.0/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.80.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-ValueHint" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/value_hint.rs.html#27">source</a><a href="#impl-Default-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/builder/value_hint.rs.html#27">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a></h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.80.0/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-FromStr-for-ValueHint" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/value_hint.rs.html#70-90">source</a><a href="#impl-FromStr-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/str/traits/trait.FromStr.html" title="trait core::str::traits::FromStr">FromStr</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Err" class="associatedtype trait-impl"><a href="#associatedtype.Err" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/core/str/traits/trait.FromStr.html#associatedtype.Err" class="associatedtype">Err</a> = <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class='docblock'>The associated error which can be returned from parsing.</div></details><details class="toggle method-toggle" open><summary><section id="method.from_str" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/builder/value_hint.rs.html#72-89">source</a><a href="#method.from_str" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/str/traits/trait.FromStr.html#tymethod.from_str" class="fn">from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <Self as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/str/traits/trait.FromStr.html" title="trait core::str::traits::FromStr">FromStr</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/str/traits/trait.FromStr.html#associatedtype.Err" title="type core::str::traits::FromStr::Err">Err</a>></h4></section></summary><div class='docblock'>Parses a string <code>s</code> to return a value of this type. <a href="https://doc.rust-lang.org/1.80.0/core/str/traits/trait.FromStr.html#tymethod.from_str">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Hash-for-ValueHint" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/value_hint.rs.html#27">source</a><a href="#impl-Hash-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</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/builder/value_hint.rs.html#27">source</a><a href="#method.hash" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/hash/trait.Hash.html#tymethod.hash" class="fn">hash</a><__H: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>>(&self, state: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/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.80.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.80.0/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.80.0/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.80.0/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.80.0/std/primitive.slice.html">[Self]</a>, state: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&mut H</a>)<div class="where">where
|
||
H: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>,
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.80.0/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.80.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.80.0/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-IntoResettable%3CValueHint%3E-for-Option%3CValueHint%3E" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/resettable.rs.html#97-104">source</a><a href="#impl-IntoResettable%3CValueHint%3E-for-Option%3CValueHint%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoResettable.html" title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a>> for <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into_resettable-1" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/builder/resettable.rs.html#98-103">source</a><a href="#method.into_resettable-1" class="anchor">§</a><h4 class="code-header">fn <a href="trait.IntoResettable.html#tymethod.into_resettable" class="fn">into_resettable</a>(self) -> <a class="enum" href="enum.Resettable.html" title="enum clap_builder::builder::Resettable">Resettable</a><<a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a>></h4></section></summary><div class='docblock'>Convert to the intended resettable type</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoResettable%3CValueHint%3E-for-ValueHint" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/resettable.rs.html#166-170">source</a><a href="#impl-IntoResettable%3CValueHint%3E-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoResettable.html" title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a>> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into_resettable" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/builder/resettable.rs.html#167-169">source</a><a href="#method.into_resettable" class="anchor">§</a><h4 class="code-header">fn <a href="trait.IntoResettable.html#tymethod.into_resettable" class="fn">into_resettable</a>(self) -> <a class="enum" href="enum.Resettable.html" title="enum clap_builder::builder::Resettable">Resettable</a><<a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a>></h4></section></summary><div class='docblock'>Convert to the intended resettable type</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq-for-ValueHint" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/value_hint.rs.html#27">source</a><a href="#impl-PartialEq-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</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/builder/value_hint.rs.html#27">source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&self, other: &<a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/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.80.0/src/core/cmp.rs.html#263">source</a></span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.PartialEq.html#method.ne" class="fn">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/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-ValueHint" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/value_hint.rs.html#27">source</a><a href="#impl-Copy-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a></h3></section><section id="impl-Eq-for-ValueHint" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/value_hint.rs.html#27">source</a><a href="#impl-Eq-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a></h3></section><section id="impl-StructuralPartialEq-for-ValueHint" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/value_hint.rs.html#27">source</a><a href="#impl-StructuralPartialEq-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</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-Freeze-for-ValueHint" class="impl"><a href="#impl-Freeze-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a></h3></section><section id="impl-RefUnwindSafe-for-ValueHint" class="impl"><a href="#impl-RefUnwindSafe-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a></h3></section><section id="impl-Send-for-ValueHint" class="impl"><a href="#impl-Send-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a></h3></section><section id="impl-Sync-for-ValueHint" class="impl"><a href="#impl-Sync-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a></h3></section><section id="impl-Unpin-for-ValueHint" class="impl"><a href="#impl-Unpin-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a></h3></section><section id="impl-UnwindSafe-for-ValueHint" class="impl"><a href="#impl-UnwindSafe-for-ValueHint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/src/core/convert/mod.rs.html#765">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.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/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.80.0/src/core/convert/mod.rs.html#748-750">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.80.0/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.80.0/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.80.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/alloc/borrow/trait.ToOwned.html#method.clone_into">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.80.0/src/core/convert/mod.rs.html#805-807">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.80.0/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.80.0/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" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.80.0/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.80.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/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.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/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.80.0/src/core/convert/mod.rs.html#790-792">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.80.0/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.80.0/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-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.80.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/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.80.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/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> |