<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="Build a command-line interface."><title>Command in clap_builder::builder - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../../static.files/rustdoc-5bc39a1768837dd0.css"><metaname="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"><scriptsrc="../../static.files/storage-4c98445ec4002617.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../../static.files/main-48f368f3872407c8.js"></script><noscript><linkrel="stylesheet"href="../../static.files/noscript-04d5337699b92874.css"></noscript><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button><aclass="logo-container"href="../../clap_builder/index.html"><imgsrc="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png"alt=""></a></nav><navclass="sidebar"><divclass="sidebar-crate"><aclass="logo-container"href="../../clap_builder/index.html"><imgsrc="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png"alt="logo"></a><h2><ahref="../../clap_builder/index.html">clap_builder</a><spanclass="version">4.5.2</span></h2></div><h2class="location"><ahref="#">Command</a></h2><divclass="sidebar-elems"><section><h3><ahref="#implementations">Methods</a></h3><ulclass="block method"><li><ahref="#method.about">about</a></li><li><ahref="#method.after_help">after_help</a></li><li><ahref="#method.after_long_help">after_long_help</a></li><li><ahref="#method.alias">alias</a></li><li><ahref="#method.aliases">aliases</a></li><li><ahref="#method.allow_external_subcommands">allow_external_subcommands</a></li><li><ahref="#method.allow_missing_positional">allow_missing_positional</a></li><li><ahref="#method.arg">arg</a></li><li><ahref="#method.arg_required_else_help">arg_required_else_help</a></li><li><ahref="#method.args">args</a></li><li><ahref="#method.args_conflicts_with_subcommands">args_conflicts_with_subcommands</a></li><li><ahref="#method.args_override_self">args_override_self</a></li><li><ahref="#method.author">author</a></li><li><ahref="#method.before_help">before_help</a></li><li><ahref="#method.before_long_help">before_long_help</a></li><li><ahref="#method.bin_name">bin_name</a></li><li><ahref="#method.build">build</a></li><li><ahref="#method.color">color</a></li><li><ahref="#method.debug_assert">debug_assert</a></li><li><ahref="#method.defer">defer</a></li><li><ahref="#method.disable_colored_help">disable_color
<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../../clap_builder/all.html"title="show sidebar"></a></div><inputclass="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"><divid="help-button"tabindex="-1"><ahref="../../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Struct <ahref="../index.html">clap_builder</a>::<wbr><ahref="index.html">builder</a>::<wbr><aclass="struct"href="#">Command</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../../src/clap_builder/builder/command.rs.html#73-110">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub struct Command { <spanclass="comment">/* private fields */</span> }</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Build a command-line interface.</p>
<p>This includes defining arguments, subcommands, parser behavior, and help output.
Once all configuration is complete,
the <ahref="struct.Command.html#method.get_matches"title="method clap_builder::builder::Command::get_matches"><code>Command::get_matches</code></a> family of methods starts the runtime-parsing
process. These methods then return information about the user supplied
arguments (or lack thereof).</p>
<p>When deriving a <ahref="../trait.Parser.html"title="trait clap_builder::Parser"><code>Parser</code></a>, you can use
<ahref="../trait.CommandFactory.html#tymethod.command"title="associated function clap_builder::CommandFactory::command"><code>CommandFactory::command</code></a> to access the
<p>It is common, but not required, to use binary name as the <code>name</code>. This
name will only be displayed to the user when they request to print
version or help and usage information.</p>
<p>See also <ahref="../macro.command.html"title="macro clap_builder::command"><code>command!</code></a> and <ahref="crate::crate_name!"><code>crate_name!</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.arg"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#168-172">source</a><h4class="code-header">pub fn <ahref="#method.arg"class="fn">arg</a>(self, a: impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="struct"href="struct.Arg.html"title="struct clap_builder::builder::Arg">Arg</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Adds an <ahref="struct.Arg.html"title="struct clap_builder::builder::Arg">argument</a> to the list of valid possibilities.</p>
F: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/ops/function/trait.FnOnce.html"title="trait core::ops::function::FnOnce">FnOnce</a>(<aclass="struct"href="struct.Arg.html"title="struct clap_builder::builder::Arg">Arg</a>) -><aclass="struct"href="struct.Arg.html"title="struct clap_builder::builder::Arg">Arg</a>,</div></h4></section></summary><divclass="docblock"><p>Allows one to mutate an <ahref="struct.Arg.html"title="struct clap_builder::builder::Arg"><code>Arg</code></a> after it’s been added to a <ahref="struct.Command.html"title="struct clap_builder::builder::Command"><code>Command</code></a>.</p>
F: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/ops/function/trait.FnMut.html"title="trait core::ops::function::FnMut">FnMut</a>(<aclass="struct"href="struct.Arg.html"title="struct clap_builder::builder::Arg">Arg</a>) -><aclass="struct"href="struct.Arg.html"title="struct clap_builder::builder::Arg">Arg</a>,</div></h4></section></summary><divclass="docblock"><p>Allows one to mutate all <ahref="struct.Arg.html"title="struct clap_builder::builder::Arg"><code>Arg</code></a>s after they’ve been added to a <ahref="struct.Command.html"title="struct clap_builder::builder::Command"><code>Command</code></a>.</p>
F: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/ops/function/trait.FnOnce.html"title="trait core::ops::function::FnOnce">FnOnce</a>(<aclass="struct"href="struct.ArgGroup.html"title="struct clap_builder::builder::ArgGroup">ArgGroup</a>) -><aclass="struct"href="struct.ArgGroup.html"title="struct clap_builder::builder::ArgGroup">ArgGroup</a>,</div></h4></section></summary><divclass="docblock"><p>Allows one to mutate an <ahref="struct.ArgGroup.html"title="struct clap_builder::builder::ArgGroup"><code>ArgGroup</code></a> after it’s been added to a <ahref="struct.Command.html"title="struct clap_builder::builder::Command"><code>Command</code></a>.</p>
.arg(<spanclass="macro">arg!</span>(--<spanclass="string">"set-ver" </span><ver><spanclass="string">"set the version manually"</span>).required(<spanclass="bool-val">false</span>))
F: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/ops/function/trait.FnOnce.html"title="trait core::ops::function::FnOnce">FnOnce</a>(Self) -> Self,</div></h4></section></summary><divclass="docblock"><p>Allows one to mutate a <ahref="struct.Command.html"title="struct clap_builder::builder::Command"><code>Command</code></a> after it’s been added as a subcommand.</p>
<p><ahref="struct.ArgGroup.html"title="struct clap_builder::builder::ArgGroup"><code>ArgGroup</code></a>s are a family of related arguments.
By placing them in a logical group, you can build easier requirement and exclusion rules.</p>
<p>Example use cases:</p>
<ul>
<li>Make an entire <ahref="struct.ArgGroup.html"title="struct clap_builder::builder::ArgGroup"><code>ArgGroup</code></a> required, meaning that one (and <em>only</em>
one) argument from that group must be present at runtime.</li>
<li>Name an <ahref="struct.ArgGroup.html"title="struct clap_builder::builder::ArgGroup"><code>ArgGroup</code></a> as a conflict to another argument.
Meaning any of the arguments that belong to that group will cause a failure if present with
the conflicting argument.</li>
<li>Ensure exclusion between arguments.</li>
<li>Extract a value from a group instead of determining exactly which argument was used.</li>
<p>The following example demonstrates using an <ahref="struct.ArgGroup.html"title="struct clap_builder::builder::ArgGroup"><code>ArgGroup</code></a> to ensure that one, and only one,
of the arguments from the specified group is present at runtime.</p>
.arg(<spanclass="macro">arg!</span>(--<spanclass="string">"set-ver" </span><ver><spanclass="string">"set the version manually"</span>).required(<spanclass="bool-val">false</span>))
) -> Self</h4></section></summary><divclass="docblock"><p>Adds multiple <ahref="struct.ArgGroup.html"title="struct clap_builder::builder::ArgGroup"><code>ArgGroup</code></a>s to the <ahref="struct.Command.html"title="struct clap_builder::builder::Command"><code>Command</code></a> at once.</p>
.arg(<spanclass="macro">arg!</span>(--<spanclass="string">"set-ver" </span><ver><spanclass="string">"set the version manually"</span>).required(<spanclass="bool-val">false</span>))
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.subcommand"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#479-482">source</a><h4class="code-header">pub fn <ahref="#method.subcommand"class="fn">subcommand</a>(self, subcmd: impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="struct"href="struct.Command.html"title="struct clap_builder::builder::Command">Command</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Adds a subcommand to the list of valid possibilities.</p>
<p>Subcommands are effectively sub-<ahref="struct.Command.html"title="struct clap_builder::builder::Command"><code>Command</code></a>s, because they can contain their own arguments,
subcommands, version, usage, etc. They also function just like <ahref="struct.Command.html"title="struct clap_builder::builder::Command"><code>Command</code></a>s, in that they get
their own auto generated help, version, and usage.</p>
<p>A subcommand’s <ahref="struct.Command.html#method.name"title="method clap_builder::builder::Command::name"><code>Command::name</code></a> will be used for:</p>
<ul>
<li>The argument the user passes in</li>
<li>Programmatically looking up the subcommand</li>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.defer"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#536-539">source</a><h4class="code-header">pub fn <ahref="#method.defer"class="fn">defer</a>(self, deferred: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.fn.html">fn</a>(_: <aclass="struct"href="struct.Command.html"title="struct clap_builder::builder::Command">Command</a>) -><aclass="struct"href="struct.Command.html"title="struct clap_builder::builder::Command">Command</a>) -> Self</h4></section></summary><divclass="docblock"><p>Delay initialization for parts of the <code>Command</code></p>
cmd.arg(<spanclass="macro">arg!</span>(<config><spanclass="string">"Required configuration file to use"</span>))
})
)</code></pre></div>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.debug_assert"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#573-575">source</a><h4class="code-header">pub fn <ahref="#method.debug_assert"class="fn">debug_assert</a>(self)</h4></section></summary><divclass="docblock"><p>Catch problems earlier in the development cycle.</p>
<p>Most error states are handled as asserts under the assumption they are programming mistake
and not something to handle at runtime. Rather than relying on tests (manual or automated)
that exhaustively test your CLI to ensure the asserts are evaluated, this will run those
asserts in a way convenient for running as a test.</p>
<p><strong>Note::</strong> This will not help with asserts in <ahref="../parser/struct.ArgMatches.html"title="struct clap_builder::parser::ArgMatches"><code>ArgMatches</code></a>, those will need exhaustive
<p>Like <ahref="struct.Command.html#method.get_matches"title="method clap_builder::builder::Command::get_matches"><code>Command::get_matches</code></a> but doesn’t consume the <code>Command</code>.</p>
<p><strong>NOTE:</strong> This method WILL NOT exit when <code>--help</code> or <code>--version</code> (or short versions) are
used. It will return a <ahref="../type.Error.html"title="type clap_builder::Error"><code>clap::Error</code></a>, where the <ahref="../type.Error.html"title="type clap_builder::Error"><code>kind</code></a> is a
<ahref="../error/enum.ErrorKind.html#variant.DisplayHelp"title="variant clap_builder::error::ErrorKind::DisplayHelp"><code>ErrorKind::DisplayHelp</code></a> or <ahref="../error/enum.ErrorKind.html#variant.DisplayVersion"title="variant clap_builder::error::ErrorKind::DisplayVersion"><code>ErrorKind::DisplayVersion</code></a> respectively. You must call
<ahref="../error/struct.Error.html#method.exit"title="method clap_builder::error::Error::exit"><code>Error::exit</code></a> or perform a <ahref="https://doc.rust-lang.org/1.77.1/std/process/fn.exit.html"title="fn std::process::exit"><code>std::process::exit</code></a>.</p>
<p><strong>NOTE:</strong> The first argument will be parsed as the binary name unless
<ahref="struct.Command.html#method.no_binary_name"title="method clap_builder::builder::Command::no_binary_name"><code>Command::no_binary_name</code></a> is used.</p>
<p><strong>NOTE:</strong> This method WILL NOT exit when <code>--help</code> or <code>--version</code> (or short versions) are
used. It will return a <ahref="../type.Error.html"title="type clap_builder::Error"><code>clap::Error</code></a>, where the <ahref="../type.Error.html"title="type clap_builder::Error"><code>kind</code></a> is a <ahref="../error/enum.ErrorKind.html#variant.DisplayHelp"title="variant clap_builder::error::ErrorKind::DisplayHelp"><code>ErrorKind::DisplayHelp</code></a>
or <ahref="../error/enum.ErrorKind.html#variant.DisplayVersion"title="variant clap_builder::error::ErrorKind::DisplayVersion"><code>ErrorKind::DisplayVersion</code></a> respectively. You must call <ahref="../error/struct.Error.html#method.exit"title="method clap_builder::error::Error::exit"><code>Error::exit</code></a> or
perform a <ahref="https://doc.rust-lang.org/1.77.1/std/process/fn.exit.html"title="fn std::process::exit"><code>std::process::exit</code></a> yourself.</p>
<p><strong>NOTE:</strong> The first argument will be parsed as the binary name unless
<ahref="struct.Command.html#method.no_binary_name"title="method clap_builder::builder::Command::no_binary_name"><code>Command::no_binary_name</code></a> is used.</p>
<p>Like <ahref="struct.Command.html#method.try_get_matches_from"title="method clap_builder::builder::Command::try_get_matches_from"><code>Command::try_get_matches_from</code></a> but doesn’t consume the <code>Command</code>.</p>
<p><strong>NOTE:</strong> This method WILL NOT exit when <code>--help</code> or <code>--version</code> (or short versions) are
used. It will return a <ahref="../type.Error.html"title="type clap_builder::Error"><code>clap::Error</code></a>, where the <ahref="../type.Error.html"title="type clap_builder::Error"><code>kind</code></a> is a <ahref="../error/enum.ErrorKind.html#variant.DisplayHelp"title="variant clap_builder::error::ErrorKind::DisplayHelp"><code>ErrorKind::DisplayHelp</code></a>
or <ahref="../error/enum.ErrorKind.html#variant.DisplayVersion"title="variant clap_builder::error::ErrorKind::DisplayVersion"><code>ErrorKind::DisplayVersion</code></a> respectively. You must call <ahref="../error/struct.Error.html#method.exit"title="method clap_builder::error::Error::exit"><code>Error::exit</code></a> or
perform a <ahref="https://doc.rust-lang.org/1.77.1/std/process/fn.exit.html"title="fn std::process::exit"><code>std::process::exit</code></a> yourself.</p>
<p><strong>NOTE:</strong> The first argument will be parsed as the binary name unless
<ahref="struct.Command.html#method.no_binary_name"title="method clap_builder::builder::Command::no_binary_name"><code>Command::no_binary_name</code></a> is used.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.print_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#846-856">source</a><h4class="code-header">pub fn <ahref="#method.print_help"class="fn">print_help</a>(&mut self) -><aclass="type"href="https://doc.rust-lang.org/1.77.1/std/io/error/type.Result.html"title="type std::io::error::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.unit.html">()</a>></h4></section></summary><divclass="docblock"><p>Prints the short help message (<code>-h</code>) to <ahref="https://doc.rust-lang.org/1.77.1/std/io/stdio/fn.stdout.html"title="fn std::io::stdio::stdout"><code>io::stdout()</code></a>.</p>
<p>See also <ahref="struct.Command.html#method.print_long_help"title="method clap_builder::builder::Command::print_long_help"><code>Command::print_long_help</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.print_long_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#874-884">source</a><h4class="code-header">pub fn <ahref="#method.print_long_help"class="fn">print_long_help</a>(&mut self) -><aclass="type"href="https://doc.rust-lang.org/1.77.1/std/io/error/type.Result.html"title="type std::io::error::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.unit.html">()</a>></h4></section></summary><divclass="docblock"><p>Prints the long help message (<code>--help</code>) to <ahref="https://doc.rust-lang.org/1.77.1/std/io/stdio/fn.stdout.html"title="fn std::io::stdio::stdout"><code>io::stdout()</code></a>.</p>
<p>See also <ahref="struct.Command.html#method.print_help"title="method clap_builder::builder::Command::print_help"><code>Command::print_help</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.render_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#904-911">source</a><h4class="code-header">pub fn <ahref="#method.render_help"class="fn">render_help</a>(&mut self) -><aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a></h4></section></summary><divclass="docblock"><p>Render the short help message (<code>-h</code>) to a <ahref="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr"><code>StyledStr</code></a></p>
<p>See also <ahref="struct.Command.html#method.render_long_help"title="method clap_builder::builder::Command::render_long_help"><code>Command::render_long_help</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.render_long_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#931-938">source</a><h4class="code-header">pub fn <ahref="#method.render_long_help"class="fn">render_long_help</a>(&mut self) -><aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a></h4></section></summary><divclass="docblock"><p>Render the long help message (<code>--help</code>) to a <ahref="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr"><code>StyledStr</code></a>.</p>
<p>See also <ahref="struct.Command.html#method.render_help"title="method clap_builder::builder::Command::render_help"><code>Command::render_help</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.render_version"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#991-993">source</a><h4class="code-header">pub fn <ahref="#method.render_version"class="fn">render_version</a>(&self) -><aclass="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><divclass="docblock"><p>Version message rendered as if the user ran <code>-V</code>.</p>
<p>See also <ahref="struct.Command.html#method.render_long_version"title="method clap_builder::builder::Command::render_long_version"><code>Command::render_long_version</code></a>.</p>
<p>This function does not try to color the message nor it inserts any <ahref="https://en.wikipedia.org/wiki/ANSI_escape_code">ANSI escape codes</a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.render_long_version"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1016-1018">source</a><h4class="code-header">pub fn <ahref="#method.render_long_version"class="fn">render_long_version</a>(&self) -><aclass="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><divclass="docblock"><p>Version message rendered as if the user ran <code>--version</code>.</p>
<p>See also <ahref="struct.Command.html#method.render_version"title="method clap_builder::builder::Command::render_version"><code>Command::render_version</code></a>.</p>
<p>This function does not try to color the message nor it inserts any <ahref="https://en.wikipedia.org/wiki/ANSI_escape_code">ANSI escape codes</a>.</p>
</div><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.no_binary_name"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1069-1075">source</a><h4class="code-header">pub fn <ahref="#method.no_binary_name"class="fn">no_binary_name</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Specifies that the parser should not assume the first argument passed is the binary name.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.ignore_errors"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1101-1107">source</a><h4class="code-header">pub fn <ahref="#method.ignore_errors"class="fn">ignore_errors</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Try not to fail on parse errors, like missing option values.</p>
<p>For any argument that would conflict with itself by default (e.g.
<ahref="enum.ArgAction.html#variant.Set"title="variant clap_builder::builder::ArgAction::Set"><code>ArgAction::Set</code></a>, it will now override itself.</p>
<p>This is the equivalent to saying the <code>foo</code> arg using <ahref="struct.Arg.html#method.overrides_with"title="method clap_builder::builder::Arg::overrides_with"><code>Arg::overrides_with("foo")</code></a> for all
defined arguments.</p>
<p><strong>NOTE:</strong> This choice is propagated to all child subcommands.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.dont_delimit_trailing_values"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1150-1156">source</a><h4class="code-header">pub fn <ahref="#method.dont_delimit_trailing_values"class="fn">dont_delimit_trailing_values</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Disables the automatic delimiting of values after <code>--</code> or when <ahref="struct.Arg.html#method.trailing_var_arg"title="method clap_builder::builder::Arg::trailing_var_arg"><code>Arg::trailing_var_arg</code></a>
<p><strong>NOTE:</strong> The same thing can be done manually by setting the final positional argument to
<ahref="struct.Arg.html#method.value_delimiter"title="method clap_builder::builder::Arg::value_delimiter"><code>Arg::value_delimiter(None)</code></a>. Using this setting is safer, because it’s easier to locate
when making changes.</p>
<p><strong>NOTE:</strong> This choice is propagated to all child subcommands.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.color"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1177-1187">source</a><h4class="code-header">pub fn <ahref="#method.color"class="fn">color</a>(self, color: <aclass="enum"href="../enum.ColorChoice.html"title="enum clap_builder::ColorChoice">ColorChoice</a>) -> Self</h4></section></summary><divclass="docblock"><p>Sets when to color output.</p>
<p><strong>NOTE:</strong> This choice is propagated to all child subcommands.</p>
<p><strong>NOTE:</strong> Default behaviour is <ahref="../enum.ColorChoice.html#variant.Auto"title="variant clap_builder::ColorChoice::Auto"><code>ColorChoice::Auto</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.styles"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1212-1215">source</a><h4class="code-header">pub fn <ahref="#method.styles"class="fn">styles</a>(self, styles: <aclass="struct"href="styling/struct.Styles.html"title="struct clap_builder::builder::styling::Styles">Styles</a>) -> Self</h4></section></summary><divclass="docblock"><p>Sets the <ahref="styling/struct.Styles.html"title="struct clap_builder::builder::styling::Styles"><code>Styles</code></a> for terminal output</p>
<p><strong>NOTE:</strong> This choice is propagated to all child subcommands.</p>
<p><strong>NOTE:</strong> Default behaviour is <ahref="styling/struct.Styles.html#method.default"title="associated function clap_builder::builder::styling::Styles::default"><code>Styles::default</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.term_width"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1243-1246">source</a><h4class="code-header">pub fn <ahref="#method.term_width"class="fn">term_width</a>(self, width: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.usize.html">usize</a>) -> Self</h4></section></summary><divclass="docblock"><p>Sets the terminal width at which to wrap help messages.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.max_term_width"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1273-1276">source</a><h4class="code-header">pub fn <ahref="#method.max_term_width"class="fn">max_term_width</a>(self, width: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.usize.html">usize</a>) -> Self</h4></section></summary><divclass="docblock"><p>Limit the line length for wrapping help when using the current terminal’s width.</p>
<p>This only applies when <ahref="struct.Command.html#method.term_width"title="method clap_builder::builder::Command::term_width"><code>term_width</code></a> is unset so that the current
terminal’s width will be used. See <ahref="struct.Command.html#method.term_width"title="method clap_builder::builder::Command::term_width"><code>Command::term_width</code></a> for more details.</p>
<p>Using <code>0</code> will ignore this, always respecting <ahref="struct.Command.html#method.term_width"title="method clap_builder::builder::Command::term_width"><code>Command::term_width</code></a> (default).</p>
<p><strong><code>unstable-v5</code> feature</strong>: Defaults to 100.</p>
<p><strong>NOTE:</strong> This setting applies globally and <em>not</em> on a per-command basis.</p>
<p><strong>NOTE:</strong> This requires the <code>wrap_help</code> feature</p>
<p>You can create a custom version flag with <ahref="enum.ArgAction.html#variant.Version"title="variant clap_builder::builder::ArgAction::Version"><code>ArgAction::Version</code></a></p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.propagate_version"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1353-1359">source</a><h4class="code-header">pub fn <ahref="#method.propagate_version"class="fn">propagate_version</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Specifies to use the version of the current command for all <ahref="struct.Command.html#method.subcommand"title="method clap_builder::builder::Command::subcommand"><code>subcommands</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.next_line_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1375-1381">source</a><h4class="code-header">pub fn <ahref="#method.next_line_help"class="fn">next_line_help</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Places the help string for all arguments and subcommands on the line after them.</p>
<p>You can create a custom help flag with <ahref="enum.ArgAction.html#variant.Help"title="variant clap_builder::builder::ArgAction::Help"><code>ArgAction::Help</code></a>, <ahref="enum.ArgAction.html#variant.HelpShort"title="variant clap_builder::builder::ArgAction::HelpShort"><code>ArgAction::HelpShort</code></a>, or
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.help_expected"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1529-1535">source</a><h4class="code-header">pub fn <ahref="#method.help_expected"class="fn">help_expected</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Panic if help descriptions are omitted.</p>
<p><strong>NOTE:</strong> When deriving <ahref="../trait.Parser.html"title="trait clap_builder::Parser"><code>Parser</code></a>, you could instead check this at
compile-time with <code>#![deny(missing_docs)]</code></p>
<p><strong>NOTE:</strong> This choice is propagated to all child subcommands.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.hide_possible_values"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1555-1561">source</a><h4class="code-header">pub fn <ahref="#method.hide_possible_values"class="fn">hide_possible_values</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Tells <code>clap</code><em>not</em> to print possible values when displaying help information.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.infer_long_args"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1576-1582">source</a><h4class="code-header">pub fn <ahref="#method.infer_long_args"class="fn">infer_long_args</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Allow partial matches of long arguments or their <ahref="struct.Command.html#method.aliases"title="method clap_builder::builder::Command::aliases">aliases</a>.</p>
<p>For example, to match a subcommand named <code>test</code>, one could use <code>t</code>, <code>te</code>, <code>tes</code>, and
<code>test</code>.</p>
<p><strong>NOTE:</strong> The match <em>must not</em> be ambiguous at all in order to succeed. i.e. to match <code>te</code>
to <code>test</code> there could not also be a subcommand or alias <code>temp</code> because both start with <code>te</code></p>
<p><strong>CAUTION:</strong> This setting can interfere with <ahref="struct.Arg.html#method.index"title="method clap_builder::builder::Arg::index">positional/free arguments</a>, take care when
designing CLIs which allow inferred subcommands and have potential positional/free
arguments whose values could start with the same characters as subcommands. If this is the
case, it’s recommended to use settings such as <ahref="struct.Command.html#method.args_conflicts_with_subcommands"title="method clap_builder::builder::Command::args_conflicts_with_subcommands"><code>Command::args_conflicts_with_subcommands</code></a> in
conjunction with this setting.</p>
<p><strong>NOTE:</strong> This choice is propagated to all child subcommands.</p>
<p>See <ahref="struct.Command.html#method.new"title="associated function clap_builder::builder::Command::new"><code>Command::new</code></a> for more details.</p>
<divclass="example-wrap ignore"><ahref="#"class="tooltip"title="This example is not tested">ⓘ</a><preclass="rust rust-example-rendered"><code><spanclass="kw">let </span>cmd = <spanclass="macro">clap::command!</span>()
.name(<spanclass="string">"foo"</span>);
<spanclass="comment">// continued logic goes here, such as `cmd.get_matches()` etc.</span></code></pre></div>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.bin_name"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1671-1674">source</a><h4class="code-header">pub fn <ahref="#method.bin_name"class="fn">bin_name</a>(self, name: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="https://doc.rust-lang.org/1.77.1/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Overrides the runtime-determined name of the binary for help and error messages.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.display_name"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1688-1691">source</a><h4class="code-header">pub fn <ahref="#method.display_name"class="fn">display_name</a>(self, name: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="https://doc.rust-lang.org/1.77.1/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Overrides the runtime-determined display name of the program for help and error messages.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.author"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1712-1715">source</a><h4class="code-header">pub fn <ahref="#method.author"class="fn">author</a>(self, author: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.Str.html"title="struct clap_builder::builder::Str">Str</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Sets the author(s) for the help message.</p>
<p><strong>Pro-tip:</strong> Use <code>clap</code>s convenience macro [<code>crate_authors!</code>] to
automatically set your application’s author(s) to the same thing as your
crate at compile time.</p>
<p><strong>NOTE:</strong> A custom <ahref="struct.Command.html#method.help_template"title="method clap_builder::builder::Command::help_template"><code>help_template</code></a> is needed for author to show
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.about"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1736-1739">source</a><h4class="code-header">pub fn <ahref="#method.about"class="fn">about</a>(self, about: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Sets the program’s description for the short help (<code>-h</code>).</p>
<p>If <ahref="struct.Command.html#method.long_about"title="method clap_builder::builder::Command::long_about"><code>Command::long_about</code></a> is not specified, this message will be displayed for <code>--help</code>.</p>
<p><strong>NOTE:</strong> Only <code>Command::about</code> (short format) is used in completion
script generation in order to be concise.</p>
<p>See also <ahref="crate::crate_description!"><code>crate_description!</code></a>.</p>
.about(<spanclass="string">"Does really amazing things for great people"</span>)</code></pre></div>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.long_about"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1762-1765">source</a><h4class="code-header">pub fn <ahref="#method.long_about"class="fn">long_about</a>(self, long_about: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Sets the program’s description for the long help (<code>--help</code>).</p>
<p>If <ahref="struct.Command.html#method.about"title="method clap_builder::builder::Command::about"><code>Command::about</code></a> is not specified, this message will be displayed for <code>-h</code>.</p>
<p><strong>NOTE:</strong> Only <ahref="struct.Command.html#method.about"title="method clap_builder::builder::Command::about"><code>Command::about</code></a> (short format) is used in completion
<spanclass="string">"Does really amazing things to great people. Now let's talk a little
more in depth about how this subcommand really works. It may take about
a few lines of text, but that's ok!"</span>)</code></pre></div>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.after_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1785-1788">source</a><h4class="code-header">pub fn <ahref="#method.after_help"class="fn">after_help</a>(self, help: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Free-form help text for after auto-generated short help (<code>-h</code>).</p>
<p>This is often used to describe how to use the arguments, caveats to be noted, or license
and contact information.</p>
<p>If <ahref="struct.Command.html#method.after_long_help"title="method clap_builder::builder::Command::after_long_help"><code>Command::after_long_help</code></a> is not specified, this message will be displayed for <code>--help</code>.</p>
.after_help(<spanclass="string">"Does really amazing things for great people... but be careful with -R!"</span>)</code></pre></div>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.after_long_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1808-1811">source</a><h4class="code-header">pub fn <ahref="#method.after_long_help"class="fn">after_long_help</a>(self, help: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Free-form help text for after auto-generated long help (<code>--help</code>).</p>
<p>This is often used to describe how to use the arguments, caveats to be noted, or license
and contact information.</p>
<p>If <ahref="struct.Command.html#method.after_help"title="method clap_builder::builder::Command::after_help"><code>Command::after_help</code></a> is not specified, this message will be displayed for <code>-h</code>.</p>
.after_long_help(<spanclass="string">"Does really amazing things to great people... but be careful with -R, \
like, for real, be careful with this!"</span>)</code></pre></div>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.before_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1829-1832">source</a><h4class="code-header">pub fn <ahref="#method.before_help"class="fn">before_help</a>(self, help: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Free-form help text for before auto-generated short help (<code>-h</code>).</p>
<p>This is often used for header, copyright, or license information.</p>
<p>If <ahref="struct.Command.html#method.before_long_help"title="method clap_builder::builder::Command::before_long_help"><code>Command::before_long_help</code></a> is not specified, this message will be displayed for <code>--help</code>.</p>
.before_help(<spanclass="string">"Some info I'd like to appear before the help info"</span>)</code></pre></div>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.before_long_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1850-1853">source</a><h4class="code-header">pub fn <ahref="#method.before_long_help"class="fn">before_long_help</a>(self, help: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Free-form help text for before auto-generated long help (<code>--help</code>).</p>
<p>This is often used for header, copyright, or license information.</p>
<p>If <ahref="struct.Command.html#method.before_help"title="method clap_builder::builder::Command::before_help"><code>Command::before_help</code></a> is not specified, this message will be displayed for <code>-h</code>.</p>
.before_long_help(<spanclass="string">"Some verbose and long info I'd like to appear before the help info"</span>)</code></pre></div>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.version"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1873-1876">source</a><h4class="code-header">pub fn <ahref="#method.version"class="fn">version</a>(self, ver: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.Str.html"title="struct clap_builder::builder::Str">Str</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Sets the version for the short version (<code>-V</code>) and help messages.</p>
<p>If <ahref="struct.Command.html#method.long_version"title="method clap_builder::builder::Command::long_version"><code>Command::long_version</code></a> is not specified, this message will be displayed for <code>--version</code>.</p>
<p><strong>Pro-tip:</strong> Use <code>clap</code>s convenience macro [<code>crate_version!</code>] to
automatically set your application’s version to the same thing as your
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.long_version"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1901-1904">source</a><h4class="code-header">pub fn <ahref="#method.long_version"class="fn">long_version</a>(self, ver: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.Str.html"title="struct clap_builder::builder::Str">Str</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Sets the version for the long version (<code>--version</code>) and help messages.</p>
<p>If <ahref="struct.Command.html#method.version"title="method clap_builder::builder::Command::version"><code>Command::version</code></a> is not specified, this message will be displayed for <code>-V</code>.</p>
<p><strong>Pro-tip:</strong> Use <code>clap</code>s convenience macro [<code>crate_version!</code>] to
automatically set your application’s version to the same thing as your
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.override_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#1984-1987">source</a><h4class="code-header">pub fn <ahref="#method.override_help"class="fn">override_help</a>(self, help: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Overrides the <code>clap</code> generated help message (both <code>-h</code> and <code>--help</code>).</p>
<p>This should only be used when the auto-generated message does not suffice.</p>
<p><strong>NOTE:</strong> This <strong>only</strong> replaces the help message for the current
command, meaning if you are using subcommands, those help messages will
still be auto-generated unless you specify a <ahref="struct.Command.html#method.override_help"title="method clap_builder::builder::Command::override_help"><code>Command::override_help</code></a> for
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.help_template"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2056-2059">source</a><h4class="code-header">pub fn <ahref="#method.help_template"class="fn">help_template</a>(self, s: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Sets the help template to be used, overriding the default format.</p>
<p><strong>NOTE:</strong> The template system is by design very simple. Therefore, the
tags have to be written in the lowercase and without spacing.</p>
<p>Tags are given inside curly brackets.</p>
<p>Valid tags are:</p>
<ul>
<li><code>{name}</code> - Display name for the (sub-)command.</li>
<li><code>{author-with-newline}</code> - Author followed by <code>\n</code>.</li>
<li><code>{author-section}</code> - Author preceded and followed by <code>\n</code>.</li>
<li><code>{about}</code> - General description (from <ahref="struct.Command.html#method.about"title="method clap_builder::builder::Command::about"><code>Command::about</code></a> or
<li><code>{usage}</code> - Automatically generated or given usage string.</li>
<li><code>{all-args}</code> - Help for all arguments (options, flags, positional
arguments, and subcommands) including titles.</li>
<li><code>{options}</code> - Help for options.</li>
<li><code>{positionals}</code> - Help for positional arguments.</li>
<li><code>{subcommands}</code> - Help for subcommands.</li>
<li><code>{tab}</code> - Standard tab sized used within clap</li>
<li><code>{after-help}</code> - Help from <ahref="struct.Command.html#method.after_help"title="method clap_builder::builder::Command::after_help"><code>Command::after_help</code></a> or <ahref="struct.Command.html#method.after_long_help"title="method clap_builder::builder::Command::after_long_help"><code>Command::after_long_help</code></a>.</li>
<li><code>{before-help}</code> - Help from <ahref="struct.Command.html#method.before_help"title="method clap_builder::builder::Command::before_help"><code>Command::before_help</code></a> or <ahref="struct.Command.html#method.before_long_help"title="method clap_builder::builder::Command::before_long_help"><code>Command::before_long_help</code></a>.</li>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.flatten_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2098-2104">source</a><h4class="code-header">pub fn <ahref="#method.flatten_help"class="fn">flatten_help</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Flatten subcommand help into the current command’s help</p>
<p>This shows a summary of subcommands within the usage and help for the current command, similar to
<code>git stash --help</code> showing information on <code>push</code>, <code>pop</code>, etc.
To see more information, a user can still pass <code>--help</code> to the individual subcommands.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.next_help_heading"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2119-2122">source</a><h4class="code-header">pub fn <ahref="#method.next_help_heading"class="fn">next_help_heading</a>(self, heading: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.Str.html"title="struct clap_builder::builder::Str">Str</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Set the default section heading for future args.</p>
<p>This will be used for any arg that hasn’t had <ahref="struct.Arg.html#method.help_heading"title="method clap_builder::builder::Arg::help_heading"><code>Arg::help_heading</code></a> called.</p>
<p>This is useful if the default <code>Options</code> or <code>Arguments</code> headings are
not specific enough for one’s use case.</p>
<p>For subcommands, see <ahref="struct.Command.html#method.subcommand_help_heading"title="method clap_builder::builder::Command::subcommand_help_heading"><code>Command::subcommand_help_heading</code></a></p>
<p>This will be used for any arg that hasn’t had <ahref="struct.Arg.html#method.display_order"title="method clap_builder::builder::Arg::display_order"><code>Arg::display_order</code></a> called.</p>
<p><strong>NOTE:</strong><ahref="struct.Command.html#method.subcommand"title="method clap_builder::builder::Command::subcommand"><code>subcommands</code></a> count as arguments</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.allow_missing_positional"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2309-2315">source</a><h4class="code-header">pub fn <ahref="#method.allow_missing_positional"class="fn">allow_missing_positional</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Allows one to implement two styles of CLIs where positionals can be used out of order.</p>
<p>This would otherwise not be allowed. This is useful when <code>[optional]</code> has a default value.</p>
<p><strong>Note:</strong> when using this style of “missing positionals” the final positional <em>must</em> be
<ahref="struct.Arg.html#method.required"title="method clap_builder::builder::Arg::required">required</a> if <code>--</code> will not be used to skip to the final positional argument.</p>
<p><strong>Note:</strong> This style also only allows a single positional argument to be “skipped” without
the use of <code>--</code>. To skip more than one, see the second example.</p>
<p>The second example is when one wants to skip multiple optional positional arguments, and use
of the <code>--</code> operator is OK (but not required if all arguments will be specified anyways).</p>
<p>For example, imagine a CLI which has three positional arguments <code>[foo] [bar] [baz]...</code> where
<code>baz</code> accepts multiple values (similar to man <code>ARGS...</code> style training arguments).</p>
<p>With this setting the following invocations are posisble:</p>
<ul>
<li><code>$ prog foo bar baz1 baz2 baz3</code></li>
</div></details></div></details><detailsclass="toggle implementors-toggle"open><summary><sectionid="impl-Command-3"class="impl"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2319-3382">source</a><ahref="#impl-Command-3"class="anchor">§</a><h3class="code-header">impl <aclass="struct"href="struct.Command.html"title="struct clap_builder::builder::Command">Command</a></h3></section></summary><divclass="docblock"><h4id="subcommand-specific-settings"><aclass="doc-anchor"href="#subcommand-specific-settings">§</a>Subcommand-specific Settings</h4></div><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.short_flag"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2347-2350">source</a><h4class="code-header">pub fn <ahref="#method.short_flag"class="fn">short_flag</a>(self, short: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.char.html">char</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Sets the short version of the subcommand flag without the preceding <code>-</code>.</p>
<p>Allows the subcommand to be used as if it were an <ahref="struct.Arg.html#method.short"title="method clap_builder::builder::Arg::short"><code>Arg::short</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.long_flag"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2386-2389">source</a><h4class="code-header">pub fn <ahref="#method.long_flag"class="fn">long_flag</a>(self, long: impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="struct"href="struct.Str.html"title="struct clap_builder::builder::Str">Str</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Sets the long version of the subcommand flag without the preceding <code>--</code>.</p>
<p>Allows the subcommand to be used as if it were an <ahref="struct.Arg.html#method.long"title="method clap_builder::builder::Arg::long"><code>Arg::long</code></a>.</p>
<p><strong>NOTE:</strong> Any leading <code>-</code> characters will be stripped.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.alias"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2418-2425">source</a><h4class="code-header">pub fn <ahref="#method.alias"class="fn">alias</a>(self, name: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.Str.html"title="struct clap_builder::builder::Str">Str</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Sets a hidden alias to this subcommand.</p>
<p>This allows the subcommand to be accessed via <em>either</em> the original name, or this given
alias. This is more efficient and easier than creating multiple hidden subcommands as one
only needs to check for the existence of this command, and not all aliased variants.</p>
<p><strong>NOTE:</strong> Aliases defined with this method are <em>hidden</em> from the help
message. If you’re looking for aliases that will be displayed in the help
message, see <ahref="struct.Command.html#method.visible_alias"title="method clap_builder::builder::Command::visible_alias"><code>Command::visible_alias</code></a>.</p>
<p><strong>NOTE:</strong> When using aliases and checking for the existence of a
particular subcommand within an <ahref="../parser/struct.ArgMatches.html"title="struct clap_builder::parser::ArgMatches"><code>ArgMatches</code></a> struct, one only needs to
search for the original name and not all aliases.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.short_flag_alias"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2445-2453">source</a><h4class="code-header">pub fn <ahref="#method.short_flag_alias"class="fn">short_flag_alias</a>(self, name: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.char.html">char</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Add an alias, which functions as “hidden” short flag subcommand</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.long_flag_alias"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2473-2480">source</a><h4class="code-header">pub fn <ahref="#method.long_flag_alias"class="fn">long_flag_alias</a>(self, name: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.Str.html"title="struct clap_builder::builder::Str">Str</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Add an alias, which functions as a “hidden” long flag subcommand.</p>
<p>This will automatically dispatch as if this subcommand was used. This is more efficient,
and easier than creating multiple hidden subcommands as one only needs to check for the
existence of this command, and not all variants.</p>
<p>This allows the subcommand to be accessed via <em>either</em> the original name or any of the
given aliases. This is more efficient, and easier than creating multiple hidden subcommands
as one only needs to check for the existence of this command and not all aliased variants.</p>
<p><strong>NOTE:</strong> Aliases defined with this method are <em>hidden</em> from the help
message. If looking for aliases that will be displayed in the help
message, see <ahref="struct.Command.html#method.visible_aliases"title="method clap_builder::builder::Command::visible_aliases"><code>Command::visible_aliases</code></a>.</p>
<p><strong>NOTE:</strong> When using aliases and checking for the existence of a
particular subcommand within an <ahref="../parser/struct.ArgMatches.html"title="struct clap_builder::parser::ArgMatches"><code>ArgMatches</code></a> struct, one only needs to
search for the original name and not all aliases.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.short_flag_aliases"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2539-2545">source</a><h4class="code-header">pub fn <ahref="#method.short_flag_aliases"class="fn">short_flag_aliases</a>(self, names: impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/collect/trait.IntoIterator.html"title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.char.html">char</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Add aliases, which function as “hidden” short flag subcommands.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.visible_alias"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2604-2611">source</a><h4class="code-header">pub fn <ahref="#method.visible_alias"class="fn">visible_alias</a>(self, name: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.Str.html"title="struct clap_builder::builder::Str">Str</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Sets a visible alias to this subcommand.</p>
<p>This allows the subcommand to be accessed via <em>either</em> the
original name or the given alias. This is more efficient and easier
than creating hidden subcommands as one only needs to check for
the existence of this command and not all aliased variants.</p>
<p><strong>NOTE:</strong> The alias defined with this method is <em>visible</em> from the help
message and displayed as if it were just another regular subcommand. If
looking for an alias that will not be displayed in the help message, see
<p><strong>NOTE:</strong> When using aliases and checking for the existence of a
particular subcommand within an <ahref="../parser/struct.ArgMatches.html"title="struct clap_builder::parser::ArgMatches"><code>ArgMatches</code></a> struct, one only needs to
search for the original name and not all aliases.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.visible_short_flag_alias"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2634-2642">source</a><h4class="code-header">pub fn <ahref="#method.visible_short_flag_alias"class="fn">visible_short_flag_alias</a>(self, name: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.char.html">char</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Add an alias, which functions as “visible” short flag subcommand</p>
<p>This will automatically dispatch as if this subcommand was used. This is more efficient,
and easier than creating multiple hidden subcommands as one only needs to check for the
existence of this command, and not all variants.</p>
<p>See also <ahref="struct.Command.html#method.short_flag_alias"title="method clap_builder::builder::Command::short_flag_alias"><code>Command::short_flag_alias</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.visible_long_flag_alias"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2665-2672">source</a><h4class="code-header">pub fn <ahref="#method.visible_long_flag_alias"class="fn">visible_long_flag_alias</a>(self, name: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.Str.html"title="struct clap_builder::builder::Str">Str</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Add an alias, which functions as a “visible” long flag subcommand.</p>
<p>This will automatically dispatch as if this subcommand was used. This is more efficient,
and easier than creating multiple hidden subcommands as one only needs to check for the
existence of this command, and not all variants.</p>
<p>See also <ahref="struct.Command.html#method.long_flag_alias"title="method clap_builder::builder::Command::long_flag_alias"><code>Command::long_flag_alias</code></a>.</p>
<p><strong>NOTE:</strong> When using aliases, and checking for the existence of a
particular subcommand within an <ahref="../parser/struct.ArgMatches.html"title="struct clap_builder::parser::ArgMatches"><code>ArgMatches</code></a> struct, one only needs to
search for the original name and not all aliases.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.display_order"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2808-2811">source</a><h4class="code-header">pub fn <ahref="#method.display_order"class="fn">display_order</a>(self, ord: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.usize.html">usize</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Set the placement of this subcommand within the help.</p>
</code></pre></div></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.hide"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2829-2835">source</a><h4class="code-header">pub fn <ahref="#method.hide"class="fn">hide</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Specifies that this <ahref="struct.Command.html#method.subcommand"title="method clap_builder::builder::Command::subcommand"><code>subcommand</code></a> should be hidden from help messages</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.subcommand_required"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#2856-2862">source</a><h4class="code-header">pub fn <ahref="#method.subcommand_required"class="fn">subcommand_required</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>If no <ahref="struct.Command.html#method.subcommand"title="method clap_builder::builder::Command::subcommand"><code>subcommand</code></a> is present at runtime, error and exit gracefully.</p>
<p>Arguments will be stored in the <code>""</code> argument in the <ahref="../parser/struct.ArgMatches.html"title="struct clap_builder::parser::ArgMatches"><code>ArgMatches</code></a></p>
<p><strong>NOTE:</strong> Use this setting with caution,
as a truly unexpected argument (i.e. one that is <em>NOT</em> an external subcommand)
will <strong>not</strong> cause an error and instead be treated as a potential subcommand.
One should check for such cases manually and inform the user appropriately.</p>
<p><strong>NOTE:</strong> A built-in subcommand will be parsed as an external subcommand when escaped with
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.args_conflicts_with_subcommands"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3002-3008">source</a><h4class="code-header">pub fn <ahref="#method.args_conflicts_with_subcommands"class="fn">args_conflicts_with_subcommands</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Specifies that use of an argument prevents the use of <ahref="struct.Command.html#method.subcommand"title="method clap_builder::builder::Command::subcommand"><code>subcommands</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.subcommand_precedence_over_arg"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3062-3068">source</a><h4class="code-header">pub fn <ahref="#method.subcommand_precedence_over_arg"class="fn">subcommand_precedence_over_arg</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Prevent subcommands from being consumed as an arguments value.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.subcommand_negates_reqs"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3117-3123">source</a><h4class="code-header">pub fn <ahref="#method.subcommand_negates_reqs"class="fn">subcommand_negates_reqs</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Allows <ahref="struct.Command.html#method.subcommand"title="method clap_builder::builder::Command::subcommand"><code>subcommands</code></a> to override all requirements of the parent command.</p>
<p>For example, if you had a subcommand or top level application with a required argument
that is only required as long as there is no subcommand present,
using this setting would allow you to set those arguments to <ahref="struct.Arg.html#method.required"title="method clap_builder::builder::Arg::required"><code>Arg::required(true)</code></a>
and yet receive no error so long as the user uses a valid subcommand instead.</p>
<p><strong>NOTE:</strong> This defaults to false (using subcommand does <em>not</em> negate requirements)</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.multicall"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3243-3249">source</a><h4class="code-header">pub fn <ahref="#method.multicall"class="fn">multicall</a>(self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><divclass="docblock"><p>Multiple-personality program dispatched on the binary name (<code>argv[0]</code>)</p>
<p>A “multicall” executable is a single executable
that contains a variety of applets,
and decides which applet to run based on the name of the file.
The executable can be called from different names by creating hard links
or symbolic links to it.</p>
<p>This is desirable for:</p>
<ul>
<li>Easy distribution, a single binary that can install hardlinks to access the different
personalities.</li>
<li>Minimal binary size by sharing common code (e.g. standard library, clap)</li>
<li>Custom shells or REPLs where there isn’t a single top-level command</li>
</ul>
<p>Setting <code>multicall</code> will cause</p>
<ul>
<li><code>argv[0]</code> to be stripped to the base name and parsed as the first argument, as if
<ahref="struct.Command.html#method.no_binary_name"title="method clap_builder::builder::Command::no_binary_name"><code>Command::no_binary_name</code></a> was set.</li>
<li>Help and errors to report subcommands as if they were the top-level command</li>
</ul>
<p>When the subcommand is not present, there are several strategies you may employ, depending
<li>Print the <ahref="struct.Command.html#method.write_help"title="method clap_builder::builder::Command::write_help">help</a> but this might be ambiguous</li>
<li>Disable <code>multicall</code> and re-parse it</li>
<li>Disable <code>multicall</code> and re-parse it with a specific subcommand</li>
</ul>
<p>When detecting the error condition, the <ahref="../error/enum.ErrorKind.html"title="enum clap_builder::error::ErrorKind"><code>ErrorKind</code></a> isn’t sufficient as a sub-subcommand
might report the same error. Enable
<ahref="struct.Command.html#method.allow_external_subcommands"title="method clap_builder::builder::Command::allow_external_subcommands"><code>allow_external_subcommands</code></a> if you want to specifically
get the unrecognized binary name.</p>
<p><strong>NOTE:</strong> Multicall can’t be used with <ahref="struct.Command.html#method.no_binary_name"title="method clap_builder::builder::Command::no_binary_name"><code>no_binary_name</code></a> since they interpret
the command name in incompatible ways.</p>
<p><strong>NOTE:</strong> The multicall command cannot have arguments.</p>
<p><strong>NOTE:</strong> Applets are slightly semantically different from subcommands,
so it’s recommended to use <ahref="struct.Command.html#method.subcommand_help_heading"title="method clap_builder::builder::Command::subcommand_help_heading"><code>Command::subcommand_help_heading</code></a> and
<ahref="struct.Command.html#method.subcommand_value_name"title="method clap_builder::builder::Command::subcommand_value_name"><code>Command::subcommand_value_name</code></a> to change the descriptive text as above.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.subcommand_value_name"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3312-3315">source</a><h4class="code-header">pub fn <ahref="#method.subcommand_value_name"class="fn">subcommand_value_name</a>(self, value_name: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.Str.html"title="struct clap_builder::builder::Str">Str</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Sets the value name used for subcommands when printing usage and help.</p>
<p>By default, this is “COMMAND”.</p>
<p>See also <ahref="struct.Command.html#method.subcommand_help_heading"title="method clap_builder::builder::Command::subcommand_help_heading"><code>Command::subcommand_help_heading</code></a></p>
help Print this message or the help of the given subcommand(s)
sub1
Options:
-h, --help Print help
-V, --version Print version
</code></pre></div></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.subcommand_help_heading"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3378-3381">source</a><h4class="code-header">pub fn <ahref="#method.subcommand_help_heading"class="fn">subcommand_help_heading</a>(self, heading: impl <aclass="trait"href="trait.IntoResettable.html"title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<aclass="struct"href="struct.Str.html"title="struct clap_builder::builder::Str">Str</a>>) -> Self</h4></section></summary><divclass="docblock"><p>Sets the help heading used for subcommands when printing usage and help.</p>
<p>By default, this is “Commands”.</p>
<p>See also <ahref="struct.Command.html#method.subcommand_value_name"title="method clap_builder::builder::Command::subcommand_value_name"><code>Command::subcommand_value_name</code></a></p>
</code></pre></div></div></details></div></details><detailsclass="toggle implementors-toggle"open><summary><sectionid="impl-Command-4"class="impl"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3385-3940">source</a><ahref="#impl-Command-4"class="anchor">§</a><h3class="code-header">impl <aclass="struct"href="struct.Command.html"title="struct clap_builder::builder::Command">Command</a></h3></section></summary><divclass="docblock"><h4id="reflection"><aclass="doc-anchor"href="#reflection">§</a>Reflection</h4></div><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_display_name"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3408-3410">source</a><h4class="code-header">pub fn <ahref="#method.get_display_name"class="fn">get_display_name</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>></h4></section></summary><divclass="docblock"><p>Get the name of the binary.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_bin_name"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3414-3416">source</a><h4class="code-header">pub fn <ahref="#method.get_bin_name"class="fn">get_bin_name</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>></h4></section></summary><divclass="docblock"><p>Get the name of the binary.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_name"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3431-3433">source</a><h4class="code-header">pub fn <ahref="#method.get_name"class="fn">get_name</a>(&self) ->&<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a></h4></section></summary><divclass="docblock"><p>Get the name of the cmd.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_version"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3443-3445">source</a><h4class="code-header">pub fn <ahref="#method.get_version"class="fn">get_version</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>></h4></section></summary><divclass="docblock"><p>Get the version of the cmd.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_long_version"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3449-3451">source</a><h4class="code-header">pub fn <ahref="#method.get_long_version"class="fn">get_long_version</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>></h4></section></summary><divclass="docblock"><p>Get the long version of the cmd.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_author"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3455-3457">source</a><h4class="code-header">pub fn <ahref="#method.get_author"class="fn">get_author</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>></h4></section></summary><divclass="docblock"><p>Get the authors of the cmd.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_short_flag"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3461-3463">source</a><h4class="code-header">pub fn <ahref="#method.get_short_flag"class="fn">get_short_flag</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.char.html">char</a>></h4></section></summary><divclass="docblock"><p>Get the short flag of the subcommand.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_long_flag"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3467-3469">source</a><h4class="code-header">pub fn <ahref="#method.get_long_flag"class="fn">get_long_flag</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>></h4></section></summary><divclass="docblock"><p>Get the long flag of the subcommand.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_about"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3475-3477">source</a><h4class="code-header">pub fn <ahref="#method.get_about"class="fn">get_about</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a>></h4></section></summary><divclass="docblock"><p>Get the help message specified via <ahref="struct.Command.html#method.about"title="method clap_builder::builder::Command::about"><code>Command::about</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_long_about"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3483-3485">source</a><h4class="code-header">pub fn <ahref="#method.get_long_about"class="fn">get_long_about</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a>></h4></section></summary><divclass="docblock"><p>Get the help message specified via <ahref="struct.Command.html#method.long_about"title="method clap_builder::builder::Command::long_about"><code>Command::long_about</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.is_flatten_help_set"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3489-3491">source</a><h4class="code-header">pub fn <ahref="#method.is_flatten_help_set"class="fn">is_flatten_help_set</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a></h4></section></summary><divclass="docblock"><p>Get the custom section heading specified via <ahref="struct.Command.html#method.flatten_help"title="method clap_builder::builder::Command::flatten_help"><code>Command::flatten_help</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_next_help_heading"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3497-3499">source</a><h4class="code-header">pub fn <ahref="#method.get_next_help_heading"class="fn">get_next_help_heading</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>></h4></section></summary><divclass="docblock"><p>Get the custom section heading specified via <ahref="struct.Command.html#method.next_help_heading"title="method clap_builder::builder::Command::next_help_heading"><code>Command::next_help_heading</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_visible_aliases"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3503-3508">source</a><h4class="code-header">pub fn <ahref="#method.get_visible_aliases"class="fn">get_visible_aliases</a>(&self) -> impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = &<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>> + '_</h4></section></summary><divclass="docblock"><p>Iterate through the <em>visible</em> aliases for this subcommand.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_visible_short_flag_aliases"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3512-3517">source</a><h4class="code-header">pub fn <ahref="#method.get_visible_short_flag_aliases"class="fn">get_visible_short_flag_aliases</a>(&self) -> impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.char.html">char</a>> + '_</h4></section></summary><divclass="docblock"><p>Iterate through the <em>visible</em> short aliases for this subcommand.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_visible_long_flag_aliases"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3521-3526">source</a><h4class="code-header">pub fn <ahref="#method.get_visible_long_flag_aliases"class="fn">get_visible_long_flag_aliases</a>(&self) -> impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = &<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>> + '_</h4></section></summary><divclass="docblock"><p>Iterate through the <em>visible</em> long aliases for this subcommand.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_all_aliases"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3530-3532">source</a><h4class="code-header">pub fn <ahref="#method.get_all_aliases"class="fn">get_all_aliases</a>(&self) -> impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = &<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>> + '_</h4></section></summary><divclass="docblock"><p>Iterate through the set of <em>all</em> the aliases for this subcommand, both visible and hidden.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_all_short_flag_aliases"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3536-3538">source</a><h4class="code-header">pub fn <ahref="#method.get_all_short_flag_aliases"class="fn">get_all_short_flag_aliases</a>(&self) -> impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.char.html">char</a>> + '_</h4></section></summary><divclass="docblock"><p>Iterate through the set of <em>all</em> the short aliases for this subcommand, both visible and hidden.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_all_long_flag_aliases"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3542-3544">source</a><h4class="code-header">pub fn <ahref="#method.get_all_long_flag_aliases"class="fn">get_all_long_flag_aliases</a>(&self) -> impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = &<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>> + '_</h4></section></summary><divclass="docblock"><p>Iterate through the set of <em>all</em> the long aliases for this subcommand, both visible and hidden.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_color"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3552-3569">source</a><h4class="code-header">pub fn <ahref="#method.get_color"class="fn">get_color</a>(&self) -><aclass="enum"href="../enum.ColorChoice.html"title="enum clap_builder::ColorChoice">ColorChoice</a></h4></section></summary><divclass="docblock"><p>Should we color the output?</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_styles"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3573-3575">source</a><h4class="code-header">pub fn <ahref="#method.get_styles"class="fn">get_styles</a>(&self) ->&<aclass="struct"href="styling/struct.Styles.html"title="struct clap_builder::builder::styling::Styles">Styles</a></h4></section></summary><divclass="docblock"><p>Return the current <code>Styles</code> for the <code>Command</code></p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_subcommands"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3579-3581">source</a><h4class="code-header">pub fn <ahref="#method.get_subcommands"class="fn">get_subcommands</a>(&self) -> impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = &<aclass="struct"href="struct.Command.html"title="struct clap_builder::builder::Command">Command</a>></h4></section></summary><divclass="docblock"><p>Iterate through the set of subcommands, getting a reference to each.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_subcommands_mut"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3585-3587">source</a><h4class="code-header">pub fn <ahref="#method.get_subcommands_mut"class="fn">get_subcommands_mut</a>(&mut self) -> impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = &mut <aclass="struct"href="struct.Command.html"title="struct clap_builder::builder::Command">Command</a>></h4></section></summary><divclass="docblock"><p>Iterate through the set of subcommands, getting a mutable reference to each.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.has_subcommands"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3591-3593">source</a><h4class="code-header">pub fn <ahref="#method.has_subcommands"class="fn">has_subcommands</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a></h4></section></summary><divclass="docblock"><p>Returns <code>true</code> if this <code>Command</code> has subcommands.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_subcommand_help_heading"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3597-3599">source</a><h4class="code-header">pub fn <ahref="#method.get_subcommand_help_heading"class="fn">get_subcommand_help_heading</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>></h4></section></summary><divclass="docblock"><p>Returns the help heading for listing subcommands.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_subcommand_value_name"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3603-3605">source</a><h4class="code-header">pub fn <ahref="#method.get_subcommand_value_name"class="fn">get_subcommand_value_name</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>></h4></section></summary><divclass="docblock"><p>Returns the subcommand value name.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_before_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3609-3611">source</a><h4class="code-header">pub fn <ahref="#method.get_before_help"class="fn">get_before_help</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a>></h4></section></summary><divclass="docblock"><p>Returns the help heading for listing subcommands.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_before_long_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3615-3617">source</a><h4class="code-header">pub fn <ahref="#method.get_before_long_help"class="fn">get_before_long_help</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a>></h4></section></summary><divclass="docblock"><p>Returns the help heading for listing subcommands.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_after_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3621-3623">source</a><h4class="code-header">pub fn <ahref="#method.get_after_help"class="fn">get_after_help</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a>></h4></section></summary><divclass="docblock"><p>Returns the help heading for listing subcommands.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_after_long_help"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3627-3629">source</a><h4class="code-header">pub fn <ahref="#method.get_after_long_help"class="fn">get_after_long_help</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="struct"href="struct.StyledStr.html"title="struct clap_builder::builder::StyledStr">StyledStr</a>></h4></section></summary><divclass="docblock"><p>Returns the help heading for listing subcommands.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.find_subcommand"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3635-3638">source</a><h4class="code-header">pub fn <ahref="#method.find_subcommand"class="fn">find_subcommand</a>(&self, name: impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.AsRef.html"title="trait core::convert::AsRef">AsRef</a><<aclass="struct"href="https://doc.rust-lang.org/1.77.1/std/ffi/os_str/struct.OsStr.html"title="struct std::ffi::os_str::OsStr">OsStr</a>>) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="struct"href="struct.Command.html"title="struct clap_builder::builder::Command">Command</a>></h4></section></summary><divclass="docblock"><p>Find subcommand such that its name or one of aliases equals <code>name</code>.</p>
) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&mut <aclass="struct"href="struct.Command.html"title="struct clap_builder::builder::Command">Command</a>></h4></section></summary><divclass="docblock"><p>Find subcommand such that its name or one of aliases equals <code>name</code>, returning
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_groups"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3655-3657">source</a><h4class="code-header">pub fn <ahref="#method.get_groups"class="fn">get_groups</a>(&self) -> impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = &<aclass="struct"href="struct.ArgGroup.html"title="struct clap_builder::builder::ArgGroup">ArgGroup</a>></h4></section></summary><divclass="docblock"><p>Iterate through the set of groups.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_arguments"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3661-3663">source</a><h4class="code-header">pub fn <ahref="#method.get_arguments"class="fn">get_arguments</a>(&self) -> impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = &<aclass="struct"href="struct.Arg.html"title="struct clap_builder::builder::Arg">Arg</a>></h4></section></summary><divclass="docblock"><p>Iterate through the set of arguments.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_positionals"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3667-3669">source</a><h4class="code-header">pub fn <ahref="#method.get_positionals"class="fn">get_positionals</a>(&self) -> impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = &<aclass="struct"href="struct.Arg.html"title="struct clap_builder::builder::Arg">Arg</a>></h4></section></summary><divclass="docblock"><p>Iterate through the <em>positionals</em> arguments.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_opts"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3672-3675">source</a><h4class="code-header">pub fn <ahref="#method.get_opts"class="fn">get_opts</a>(&self) -> impl <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = &<aclass="struct"href="struct.Arg.html"title="struct clap_builder::builder::Arg">Arg</a>></h4></section></summary><divclass="docblock"><p>Iterate through the <em>options</em>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_arg_conflicts_with"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3686-3707">source</a><h4class="code-header">pub fn <ahref="#method.get_arg_conflicts_with"class="fn">get_arg_conflicts_with</a>(&self, arg: &<aclass="struct"href="struct.Arg.html"title="struct clap_builder::builder::Arg">Arg</a>) -><aclass="struct"href="https://doc.rust-lang.org/1.77.1/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><&<aclass="struct"href="struct.Arg.html"title="struct clap_builder::builder::Arg">Arg</a>></h4></section></summary><divclass="docblock"><p>Get a list of all arguments the given argument conflicts with.</p>
</div></details></div></details><detailsclass="toggle implementors-toggle"open><summary><sectionid="impl-Command-5"class="impl"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#3943-4564">source</a><ahref="#impl-Command-5"class="anchor">§</a><h3class="code-header">impl <aclass="struct"href="struct.Command.html"title="struct clap_builder::builder::Command">Command</a></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.build"class="method"><aclass="src rightside"href="../../src/clap_builder/builder/command.rs.html#4020-4023">source</a><h4class="code-header">pub fn <ahref="#method.build"class="fn">build</a>(&mut self)</h4></section></summary><divclass="docblock"><p>Prepare for introspecting on all included <ahref="struct.Command.html"title="struct clap_builder::builder::Command"><code>Command</code></a>s</p>
<p>Call this on the top-level <ahref="struct.Command.html"title="struct clap_builder::builder::Command"><code>Command</code></a> when done building and before reading state for
cases like completions, custom help output, etc.</p>
<code><ahref="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><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-ToOwned-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/alloc/borrow.rs.html#83-85">source</a><ahref="#impl-ToOwned-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html"title="trait alloc::borrow::ToOwned">ToOwned</a> for T<divclass="where">where
T: <aclass="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><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Owned"class="associatedtype trait-impl"><ahref="#associatedtype.Owned"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html#associatedtype.Owned"class="associatedtype">Owned</a> = T</h4></section></summary><divclass='docblock'>The resulting type after obtaining ownership.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.to_owned"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/alloc/borrow.rs.html#88">source</a><ahref="#method.to_owned"class="anchor">§</a><h4class="code-header">fn <ahref="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><divclass='docblock'>Creates owned data from borrowed data, usually by cloning. <ahref="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.clone_into"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/alloc/borrow.rs.html#92">source</a><ahref="#method.clone_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html#method.clone_into"class="fn">clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.reference.html">&mut T</a>)</h4></section></summary><divclass='docblock'>Uses borrowed data to replace owned data, usually by cloning. <ahref="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-ToString-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/alloc/string.rs.html#2600">source</a><ahref="#impl-ToString-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.77.1/alloc/string/trait.ToString.html"title="trait alloc::string::ToString">ToString</a> for T<divclass="where">where
T: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/fmt/trait.Display.html"title="trait core::fmt::Display">Display</a> + ?<aclass="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><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.to_string"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/alloc/string.rs.html#2606">source</a><ahref="#method.to_string"class="anchor">§</a><h4class="code-header">default fn <ahref="https://doc.rust-lang.org/1.77.1/alloc/string/trait.ToString.html#tymethod.to_string"class="fn">to_string</a>(&self) -><aclass="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><divclass='docblock'>Converts the given value to a <code>String</code>. <ahref="https://doc.rust-lang.org/1.77.1/alloc/string/trait.ToString.html#tymethod.to_string">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#804-806">source</a><ahref="#impl-TryFrom%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="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<divclass="where">where
U: <aclass="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><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl"><ahref="#associatedtype.Error-1"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="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><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#811">source</a><ahref="#method.try_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#tymethod.try_from"class="fn">try_from</a>(value: U) -><aclass="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 <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="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><divclass='docblock'>Performs the conversion.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#789-791">source</a><ahref="#impl-TryInto%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="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<divclass="where">where
U: <aclass="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><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl"><ahref="#associatedtype.Error"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="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><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_into"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#796">source</a><ahref="#method.try_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">try_into</a>(self) -><aclass="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 <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="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><divclass='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
