<!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="API documentation for the Rust `AppSettings` enum in crate `structopt`."><metaname="keywords"content="rust, rustlang, rust-lang, AppSettings"><title>structopt::clap::AppSettings - Rust</title><linkrel="stylesheet"type="text/css"href="../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../dark.css"><linkrel="stylesheet"type="text/css"href="../../light.css"id="themeStyle"><scriptsrc="../../storage.js"></script><noscript><linkrel="stylesheet"href="../../noscript.css"></noscript><linkrel="shortcut icon"href="../../favicon.ico"><styletype="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><bodyclass="rustdoc enum"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><ahref='../../structopt/index.html'><divclass='logo-container'><imgsrc='../../rust-logo.png'alt='logo'></div></a><pclass='location'>Enum AppSettings</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#variants">Variants</a><divclass="sidebar-links"><ahref="#variant.AllowInvalidUtf8">AllowInvalidUtf8</a><ahref="#variant.AllArgsOverrideSelf">AllArgsOverrideSelf</a><ahref="#variant.AllowLeadingHyphen">AllowLeadingHyphen</a><ahref="#variant.AllowNegativeNumbers">AllowNegativeNumbers</a><ahref="#variant.AllowMissingPositional">AllowMissingPositional</a><ahref="#variant.AllowExternalSubcommands">AllowExternalSubcommands</a><ahref="#variant.ArgsNegateSubcommands">ArgsNegateSubcommands</a><ahref="#variant.ArgRequiredElseHelp">ArgRequiredElseHelp</a><ahref="#variant.ColoredHelp">ColoredHelp</a><ahref="#variant.ColorAuto">ColorAuto</a><ahref="#variant.ColorAlways">ColorAlways</a><ahref="#variant.ColorNever">ColorNever</a><ahref="#variant.DontCollapseArgsInUsage">DontCollapseArgsInUsage</a><ahref="#variant.DontDelimitTrailingValues">DontDelimitTrailingValues</a><ahref="#variant.DisableHelpFlags">DisableHelpFlags</a><ahref="#variant.DisableHelpSubcommand">DisableHelpSubcommand</a><ahref="#variant.DisableVersion">DisableVersion</a><ahref="#variant.DeriveDisplayOrder">DeriveDisplayOrder</a><ahref="#variant.GlobalVersion">GlobalVersion</a><ahref="#variant.Hidden">Hidden</a><ahref="#variant.HidePossibleValuesInHelp">HidePossibleValuesInHelp</a><ahref="#variant.InferSubcommands">InferSubcommands</a><ahref="#variant.NoBinaryName">NoBinaryName</a><ahref="#variant.NextLineHelp">NextLineHelp</a><ahref="#variant.PropagateGlobalValuesDown">PropagateGlobalValuesDown</a><ahref="#variant.SubcommandsNegateReqs">SubcommandsNegateReqs</a><ahref="#variant.SubcommandRequiredElseHelp">SubcommandRequiredElseHelp</a><ahref="#variant.StrictUtf8">StrictUtf8</a><ahref="#variant.SubcommandRequired">SubcommandRequired</a><ahref="#variant.TrailingVarArg">TrailingVarArg</a><ahref="#variant.UnifiedHelpMessage">UnifiedHelpMessage</a><ahref="#variant.VersionlessSubcommands">VersionlessSubcommands</a><ahref="#variant.WaitOnError">WaitOnError</a></div><aclass="sidebar-title"href="#implementations">Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Clone">Clone</a><ahref="#impl-Copy">Copy</a><ahref="#impl-Debug">Debug</a><ahref="#impl-FromStr">FromStr</a><ahref="#impl-PartialEq%3CAppSettings%3E">PartialEq<AppSettings></a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">RefUnwindSafe</a><ahref="#impl-Send">Send</a><ahref="#impl-Sync">Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">UnwindSafe</a></div><aclass="sidebar-title"href="#blanket-implementations">Blanket Implementations</a><divclass="sidebar-li
AllowInvalidUtf8,
AllArgsOverrideSelf,
AllowLeadingHyphen,
AllowNegativeNumbers,
AllowMissingPositional,
AllowExternalSubcommands,
ArgsNegateSubcommands,
ArgRequiredElseHelp,
ColoredHelp,
ColorAuto,
ColorAlways,
ColorNever,
DontCollapseArgsInUsage,
DontDelimitTrailingValues,
DisableHelpFlags,
DisableHelpSubcommand,
DisableVersion,
DeriveDisplayOrder,
GlobalVersion,
Hidden,
HidePossibleValuesInHelp,
InferSubcommands,
NoBinaryName,
NextLineHelp,
PropagateGlobalValuesDown,
SubcommandsNegateReqs,
SubcommandRequiredElseHelp,
StrictUtf8,
SubcommandRequired,
TrailingVarArg,
UnifiedHelpMessage,
VersionlessSubcommands,
WaitOnError,
// some variants omitted
}</pre></div><divclass='docblock'><p>Application level settings, which affect how <ahref="./struct.App.html"><code>App</code></a> operates</p>
<p><strong>NOTE:</strong> When these settings are used, they apply only to current command, and are <em>not</em>
propagated down or up through child or parent subcommands</p>
<spanid="variant.AllowInvalidUtf8"class="variant small-section-header"><ahref="#variant.AllowInvalidUtf8"class="anchor field"></a><codeid='AllowInvalidUtf8.v'>AllowInvalidUtf8</code></span><divclass='docblock'><p>Specifies that any invalid UTF-8 code points should <em>not</em> be treated as an error.
This is the default behavior of <code>clap</code>.</p>
<p><strong>NOTE:</strong> Using argument values with invalid UTF-8 code points requires using
or <ahref="./struct.ArgMatches.html#method.lossy_values_of"><code>ArgMatches::lossy_values_of</code></a> for those particular arguments which may contain invalid
UTF-8 values</p>
<p><strong>NOTE:</strong> This rule only applies to argument values, as flags, options, and
<ahref="./struct.SubCommand.html"><code>SubCommand</code></a>s themselves only allow valid UTF-8 code points.</p>
</div><spanid="variant.AllArgsOverrideSelf"class="variant small-section-header"><ahref="#variant.AllArgsOverrideSelf"class="anchor field"></a><codeid='AllArgsOverrideSelf.v'>AllArgsOverrideSelf</code></span><divclass='docblock'><p>Essentially sets [<code>Arg::overrides_with("itself")</code>] for all arguments.</p>
<p><strong>WARNING:</strong> Positional arguments cannot override themselves (or we would never be able
to advance to the next positional). This setting ignores positional arguments.
</div><spanid="variant.AllowLeadingHyphen"class="variant small-section-header"><ahref="#variant.AllowLeadingHyphen"class="anchor field"></a><codeid='AllowLeadingHyphen.v'>AllowLeadingHyphen</code></span><divclass='docblock'><p>Specifies that leading hyphens are allowed in argument <em>values</em>, such as negative numbers
like <code>-10</code>. (which would otherwise be parsed as another flag or option)</p>
<p><strong>NOTE:</strong> Use this setting with caution as it silences certain circumstances which would
otherwise be an error (such as accidentally forgetting to specify a value for leading
option). It is preferred to set this on a per argument basis, via <ahref="./struct.Arg.html#method.allow_hyphen_values"><code>Arg::allow_hyphen_values</code></a></p>
</div><spanid="variant.AllowNegativeNumbers"class="variant small-section-header"><ahref="#variant.AllowNegativeNumbers"class="anchor field"></a><codeid='AllowNegativeNumbers.v'>AllowNegativeNumbers</code></span><divclass='docblock'><p>Allows negative numbers to pass as values. This is similar to
<code>AllowLeadingHyphen</code> except that it only allows numbers, all
other undefined leading hyphens will fail to parse.</p>
</div><spanid="variant.AllowMissingPositional"class="variant small-section-header"><ahref="#variant.AllowMissingPositional"class="anchor field"></a><codeid='AllowMissingPositional.v'>AllowMissingPositional</code></span><divclass='docblock'><p>Allows one to implement two styles of CLIs where positionals can be used out of order.</p>
<p>The first example is a CLI where the second to last positional argument is optional, but
the final positional argument is required. Such as <code>$ prog [optional] <required></code> where one
</div><spanid="variant.AllowExternalSubcommands"class="variant small-section-header"><ahref="#variant.AllowExternalSubcommands"class="anchor field"></a><codeid='AllowExternalSubcommands.v'>AllowExternalSubcommands</code></span><divclass='docblock'><p>Specifies that an unexpected positional argument,
which would otherwise cause a <ahref="./enum.ErrorKind.html#variant.UnknownArgument"><code>ErrorKind::UnknownArgument</code></a> error,
should instead be treated as a <ahref="./struct.SubCommand.html"><code>SubCommand</code></a> within the <ahref="./struct.ArgMatches.html"><code>ArgMatches</code></a> struct.</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>
</div><spanid="variant.ArgsNegateSubcommands"class="variant small-section-header"><ahref="#variant.ArgsNegateSubcommands"class="anchor field"></a><codeid='ArgsNegateSubcommands.v'>ArgsNegateSubcommands</code></span><divclass='docblock'><p>Specifies that use of a valid <ahref="./struct.Arg.html">argument</a> negates <ahref="./struct.SubCommand.html">subcommands</a> being used after. By default
<code>clap</code> allows arguments between subcommands such as
<code><cmd> [cmd_args] <cmd2> [cmd2_args] <cmd3> [cmd3_args]</code>. This setting disables that
functionality and says that arguments can only follow the <em>final</em> subcommand. For instance
using this setting makes only the following invocations possible:</p>
</div><spanid="variant.ArgRequiredElseHelp"class="variant small-section-header"><ahref="#variant.ArgRequiredElseHelp"class="anchor field"></a><codeid='ArgRequiredElseHelp.v'>ArgRequiredElseHelp</code></span><divclass='docblock'><p>Specifies that the help text should be displayed (and then exit gracefully),
if no arguments are present at runtime (i.e. an empty run such as, <code>$ myprog</code>.</p>
<p><strong>NOTE:</strong><ahref="./struct.SubCommand.html"><code>SubCommand</code></a>s count as arguments</p>
<p><strong>NOTE:</strong> Setting <ahref="./struct.Arg.html#method.default_value"><code>Arg::default_value</code></a> effectively disables this option as it will
</div><spanid="variant.ColorAuto"class="variant small-section-header"><ahref="#variant.ColorAuto"class="anchor field"></a><codeid='ColorAuto.v'>ColorAuto</code></span><divclass='docblock'><p>Enables colored output only when the output is going to a terminal or TTY.</p>
<p><strong>NOTE:</strong> This is the default behavior of <code>clap</code>.</p>
<p><strong>NOTE:</strong> Must be compiled with the <code>color</code> cargo feature.</p>
</div><spanid="variant.ColorAlways"class="variant small-section-header"><ahref="#variant.ColorAlways"class="anchor field"></a><codeid='ColorAlways.v'>ColorAlways</code></span><divclass='docblock'><p>Enables colored output regardless of whether or not the output is going to a terminal/TTY.</p>
<p><strong>NOTE:</strong> Must be compiled with the <code>color</code> cargo feature.</p>
</div><spanid="variant.ColorNever"class="variant small-section-header"><ahref="#variant.ColorNever"class="anchor field"></a><codeid='ColorNever.v'>ColorNever</code></span><divclass='docblock'><p>Disables colored output no matter if the output is going to a terminal/TTY, or not.</p>
<p><strong>NOTE:</strong> Must be compiled with the <code>color</code> cargo feature</p>
</div><spanid="variant.DontCollapseArgsInUsage"class="variant small-section-header"><ahref="#variant.DontCollapseArgsInUsage"class="anchor field"></a><codeid='DontCollapseArgsInUsage.v'>DontCollapseArgsInUsage</code></span><divclass='docblock'><p>Disables the automatic collapsing of positional args into <code>[ARGS]</code> inside the usage string</p>
</div><spanid="variant.DontDelimitTrailingValues"class="variant small-section-header"><ahref="#variant.DontDelimitTrailingValues"class="anchor field"></a><codeid='DontDelimitTrailingValues.v'>DontDelimitTrailingValues</code></span><divclass='docblock'><p>Disables the automatic delimiting of values when <code>--</code> or <ahref="./enum.AppSettings.html#variant.TrailingVarArg"><code>AppSettings::TrailingVarArg</code></a>
was used.</p>
<p><strong>NOTE:</strong> The same thing can be done manually by setting the final positional argument to
<ahref="./struct.Arg.html#method.use_delimiter"><code>Arg::use_delimiter(false)</code></a>. Using this setting is safer, because it's easier to locate
</div><spanid="variant.DisableHelpFlags"class="variant small-section-header"><ahref="#variant.DisableHelpFlags"class="anchor field"></a><codeid='DisableHelpFlags.v'>DisableHelpFlags</code></span><divclass='docblock'><p>Disables <code>-h</code> and <code>--help</code><ahref="./struct.App.html"><code>App</code></a> without affecting any of the <ahref="./struct.SubCommand.html"><code>SubCommand</code></a>s
(Defaults to <code>false</code>; application <em>does</em> have help flags)</p>
</div><spanid="variant.DisableVersion"class="variant small-section-header"><ahref="#variant.DisableVersion"class="anchor field"></a><codeid='DisableVersion.v'>DisableVersion</code></span><divclass='docblock'><p>Disables <code>-V</code> and <code>--version</code><ahref="./struct.App.html"><code>App</code></a> without affecting any of the <ahref="./struct.SubCommand.html"><code>SubCommand</code></a>s
(Defaults to <code>false</code>; application <em>does</em> have a version flag)</p>
</div><spanid="variant.DeriveDisplayOrder"class="variant small-section-header"><ahref="#variant.DeriveDisplayOrder"class="anchor field"></a><codeid='DeriveDisplayOrder.v'>DeriveDisplayOrder</code></span><divclass='docblock'><p>Displays the arguments and <ahref="./struct.SubCommand.html"><code>SubCommand</code></a>s in the help message in the order that they were
declared in, and not alphabetically which is the default.</p>
</div><spanid="variant.GlobalVersion"class="variant small-section-header"><ahref="#variant.GlobalVersion"class="anchor field"></a><codeid='GlobalVersion.v'>GlobalVersion</code></span><divclass='docblock'><p>Specifies to use the version of the current command for all child <ahref="./struct.SubCommand.html"><code>SubCommand</code></a>s.
(Defaults to <code>false</code>; subcommands have independent version strings from their parents.)</p>
<p><strong>NOTE:</strong> The version for the current command <strong>and</strong> this setting must be set <strong>prior</strong> to
</div><spanid="variant.Hidden"class="variant small-section-header"><ahref="#variant.Hidden"class="anchor field"></a><codeid='Hidden.v'>Hidden</code></span><divclass='docblock'><p>Specifies that this <ahref="./struct.SubCommand.html"><code>SubCommand</code></a> should be hidden from help messages</p>
</div><spanid="variant.HidePossibleValuesInHelp"class="variant small-section-header"><ahref="#variant.HidePossibleValuesInHelp"class="anchor field"></a><codeid='HidePossibleValuesInHelp.v'>HidePossibleValuesInHelp</code></span><divclass='docblock'><p>Tells <code>clap</code><em>not</em> to print possible values when displaying help information.
This can be useful if there are many values, or they are explained elsewhere.</p>
</div><spanid="variant.InferSubcommands"class="variant small-section-header"><ahref="#variant.InferSubcommands"class="anchor field"></a><codeid='InferSubcommands.v'>InferSubcommands</code></span><divclass='docblock'><p>Tries to match unknown args to partial <ahref="./struct.SubCommand.html"><code>subcommands</code></a> or their <ahref="./struct.App.html#method.alias">aliases</a>. 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">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="./enum.AppSettings.html#variant.ArgsNegateSubcommands"><code>AppSeettings::ArgsNegateSubcommands</code></a> in
</div><spanid="variant.NoBinaryName"class="variant small-section-header"><ahref="#variant.NoBinaryName"class="anchor field"></a><codeid='NoBinaryName.v'>NoBinaryName</code></span><divclass='docblock'><p>Specifies that the parser should not assume the first argument passed is the binary name.
This is normally the case when using a "daemon" style mode, or an interactive CLI where one
one would not normally type the binary or program name for each command.</p>
.<spanclass="ident">arg</span>(<spanclass="ident">Arg</span>::<spanclass="ident">from_usage</span>(<spanclass="string">"<cmd>... 'commands to run'"</span>))
</div><spanid="variant.NextLineHelp"class="variant small-section-header"><ahref="#variant.NextLineHelp"class="anchor field"></a><codeid='NextLineHelp.v'>NextLineHelp</code></span><divclass='docblock'><p>Places the help string for all arguments on the line after the argument.</p>
.<spanclass="ident">arg</span>(<spanclass="ident">Arg</span>::<spanclass="ident">from_usage</span>(<spanclass="string">"[cmd] 'command to run'"</span>)
.<spanclass="ident">arg</span>(<spanclass="ident">Arg</span>::<spanclass="ident">from_usage</span>(<spanclass="string">"[cmd] 'command to run'"</span>)
</div><spanid="variant.SubcommandsNegateReqs"class="variant small-section-header"><ahref="#variant.SubcommandsNegateReqs"class="anchor field"></a><codeid='SubcommandsNegateReqs.v'>SubcommandsNegateReqs</code></span><divclass='docblock'><p>Allows <ahref="./struct.SubCommand.html"><code>SubCommand</code></a>s to override all requirements of the parent command.
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"><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><spanid="variant.SubcommandRequiredElseHelp"class="variant small-section-header"><ahref="#variant.SubcommandRequiredElseHelp"class="anchor field"></a><codeid='SubcommandRequiredElseHelp.v'>SubcommandRequiredElseHelp</code></span><divclass='docblock'><p>Specifies that the help text should be displayed (before exiting gracefully) if no
<ahref="./struct.SubCommand.html"><code>SubCommand</code></a>s are present at runtime (i.e. an empty run such as <code>$ myprog</code>).</p>
<p><strong>NOTE:</strong> This should <em>not</em> be used with <ahref="./enum.AppSettings.html#variant.SubcommandRequired"><code>AppSettings::SubcommandRequired</code></a> as they do
nearly same thing; this prints the help text, and the other prints an error.</p>
<p><strong>NOTE:</strong> If the user specifies arguments at runtime, but no subcommand the help text will
still be displayed and exit. If this is <em>not</em> the desired result, consider using
</div><spanid="variant.StrictUtf8"class="variant small-section-header"><ahref="#variant.StrictUtf8"class="anchor field"></a><codeid='StrictUtf8.v'>StrictUtf8</code></span><divclass='docblock'><p>Specifies that any invalid UTF-8 code points should be treated as an error and fail
with a <ahref="./enum.ErrorKind.html#variant.InvalidUtf8"><code>ErrorKind::InvalidUtf8</code></a> error.</p>
<p><strong>NOTE:</strong> This rule only applies to argument values; Things such as flags, options, and
<ahref="./struct.SubCommand.html"><code>SubCommand</code></a>s themselves only allow valid UTF-8 code points.</p>
</div><spanid="variant.SubcommandRequired"class="variant small-section-header"><ahref="#variant.SubcommandRequired"class="anchor field"></a><codeid='SubcommandRequired.v'>SubcommandRequired</code></span><divclass='docblock'><p>Allows specifying that if no <ahref="./struct.SubCommand.html"><code>SubCommand</code></a> is present at runtime,
error and exit gracefully.</p>
<p><strong>NOTE:</strong> This defaults to <code>false</code> (subcommands do <em>not</em> need to be present)</p>
</div><spanid="variant.TrailingVarArg"class="variant small-section-header"><ahref="#variant.TrailingVarArg"class="anchor field"></a><codeid='TrailingVarArg.v'>TrailingVarArg</code></span><divclass='docblock'><p>Specifies that the final positional argument is a "VarArg" and that <code>clap</code> should not
attempt to parse any further args.</p>
<p>The values of the trailing positional argument will contain all args from itself on.</p>
<p><strong>NOTE:</strong> The final positional argument <strong>must</strong> have <ahref="./struct.Arg.html#method.multiple"><code>Arg::multiple(true)</code></a> or the usage
.<spanclass="ident">arg</span>(<spanclass="ident">Arg</span>::<spanclass="ident">from_usage</span>(<spanclass="string">"<cmd>... 'commands to run'"</span>))
</div><spanid="variant.UnifiedHelpMessage"class="variant small-section-header"><ahref="#variant.UnifiedHelpMessage"class="anchor field"></a><codeid='UnifiedHelpMessage.v'>UnifiedHelpMessage</code></span><divclass='docblock'><p>Groups flags and options together, presenting a more unified help message
(a la <code>getopts</code> or <code>docopt</code> style).</p>
<p>The default is that the auto-generated help message will group flags, and options
separately.</p>
<p><strong>NOTE:</strong> This setting is cosmetic only and does not affect any functionality.</p>
<spanclass="comment">// running `myprog --help` will display a unified "docopt" or "getopts" style help message</span></pre></div>
</div><spanid="variant.VersionlessSubcommands"class="variant small-section-header"><ahref="#variant.VersionlessSubcommands"class="anchor field"></a><codeid='VersionlessSubcommands.v'>VersionlessSubcommands</code></span><divclass='docblock'><p>Disables <code>-V</code> and <code>--version</code> for all <ahref="./struct.SubCommand.html"><code>SubCommand</code></a>s
(Defaults to <code>false</code>; subcommands <em>do</em> have version flags.)</p>
<p><strong>NOTE:</strong> This setting must be set <strong>prior</strong> to adding any subcommands.</p>
</div><spanid="variant.WaitOnError"class="variant small-section-header"><ahref="#variant.WaitOnError"class="anchor field"></a><codeid='WaitOnError.v'>WaitOnError</code></span><divclass='docblock'><p>Will display a message "Press [ENTER]/[RETURN] to continue..." and wait for user before
exiting</p>
<p>This is most useful when writing an application which is run from a GUI shortcut, or on
Windows where a user tries to open the binary by double-clicking instead of using the
command line.</p>
<p><strong>NOTE:</strong> This setting is <strong>not</strong> recursive with <ahref="./struct.SubCommand.html"><code>SubCommand</code></a>s, meaning if you wish this
behavior for all subcommands, you must set this on each command (needing this is extremely
</div><h2id='implementations'class='small-section-header'>Trait Implementations<ahref='#implementations'class='anchor'></a></h2><divid='implementations-list'><h3id='impl-FromStr'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html"title="trait core::str::FromStr">FromStr</a> for <aclass="enum"href="../../structopt/clap/enum.AppSettings.html"title="enum structopt::clap::AppSettings">AppSettings</a></code><ahref='#impl-FromStr'class='anchor'></a><aclass='srclink'href='../../src/clap/app/settings.rs.html#982-1024'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Err'class="type"><codeid='Err.t'>type <ahref='https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html#associatedtype.Err'class="type">Err</a> = <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html"title="struct alloc::string::String">String</a></code></h4><divclass='docblock'><p>The associated error which can be returned from parsing.</p>
</div><h4id='method.from_str'class="method hidden"><codeid='from_str.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html#tymethod.from_str'class='fnname'>from_str</a>(s: &<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="enum"href="../../structopt/clap/enum.AppSettings.html"title="enum structopt::clap::AppSettings">AppSettings</a>, <<aclass="enum"href="../../structopt/clap/enum.AppSettings.html"title="enum structopt::clap::AppSettings">AppSettings</a> as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html"title="trait core::str::FromStr">FromStr</a>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html#associatedtype.Err"title="type core::str::FromStr::Err">Err</a>></code><aclass='srclink'href='../../src/clap/app/settings.rs.html#984-1023'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Parses a string <code>s</code> to return a value of this type. <ahref="https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html#tymethod.from_str">Read more</a></p>
</div></div><h3id='impl-PartialEq%3CAppSettings%3E'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html"title="trait core::cmp::PartialEq">PartialEq</a><<aclass="enum"href="../../structopt/clap/enum.AppSettings.html"title="enum structopt::clap::AppSettings">AppSettings</a>> for <aclass="enum"href="../../structopt/clap/enum.AppSettings.html"title="enum structopt::clap::AppSettings">AppSettings</a></code><ahref='#impl-PartialEq%3CAppSettings%3E'class='anchor'></a><aclass='srclink'href='../../src/clap/app/settings.rs.html#129'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.eq'class="method hidden"><codeid='eq.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq'class='fnname'>eq</a>(&self, other: &<aclass="enum"href="../../structopt/clap/enum.AppSettings.html"title="enum structopt::clap::AppSettings">AppSettings</a>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/clap/app/settings.rs.html#129'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <ahref="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div></div><h3id='impl-Debug'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a> for <aclass="enum"href="../../structopt/clap/enum.AppSettings.html"title="enum structopt::clap::AppSettings">AppSettings</a></code><ahref='#impl-Debug'class='anchor'></a><aclass='srclink'href='../../src/clap/app/settings.rs.html#129'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.fmt'class="method hidden"><codeid='fmt.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt'class='fnname'>fmt</a>(&self, f: &mut <aclass="struct"href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html"title="struct core::fmt::Formatter">Formatter</a>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <aclass="struct"href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html"title="struct core::fmt::Error">Error</a>></code><aclass='srclink'href='../../src/clap/app/settings.rs.html#129'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Formats the value using the given formatter. <ahref="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3id='impl-ToOwned'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html"title="trait alloc::borrow::ToOwned">ToOwned</a> for T <spanclass="where fmt-newline">where<br> T: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>, </span></code><ahref='#impl-ToOwned'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-92'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Owned'class="type"><codeid='Owned.t'>type <ahref='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned'class="type">Owned</a> = T</code></h4><divclass='docblock'><p>The resulting type after obtaining ownership.</p>
</div><h4id='method.to_owned'class="method hidden"><codeid='to_owned.v'>fn <ahref='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned'class='fnname'>to_owned</a>(&self) -> T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
</div><h4id='method.clone_into'class="method hidden"><codeid='clone_into.v'>fn <ahref='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into'class='fnname'>clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89-91'title='goto source code'>[src]</a></h4><divclass='stability hidden'><divclass='stab unstable'><details><summary><spanclass='emoji'>🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
</details></div></div><divclass='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
</div></div><h3id='impl-TryFrom%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></code><ahref='#impl-TryFrom%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#571-577'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error'class="type"><codeid='Error.t'>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error'class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_from'class="method hidden"><codeid='try_from.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from'class='fnname'>try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#574-576'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-TryInto%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><ahref='#impl-TryInto%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#559-566'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error-1'class="type"><codeid='Error.t-1'>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error'class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_into'class="method hidden"><codeid='try_into.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into'class='fnname'>try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#563-565'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-BorrowMut%3CT%3E'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html"title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-BorrowMut%3CT%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.borrow_mut'class="method hidden"><codeid='borrow_mut.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut'class='fnname'>borrow_mut</a>(&mut self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Mutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3id='impl-Borrow%3CT%3E'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html"title="trait core::borrow::Borrow">Borrow</a><T> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Borrow%3CT%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.borrow'class="method hidden"><codeid='borrow.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow'class='fnname'>borrow</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Immutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3id='impl-Any'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> for T <spanclass="where fmt-newline">where<br> T: 'static + ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Any'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.type_id'class="method hidden"><codeid='type_id.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id'class='fnname'>type_id</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html"title="struct core::any::TypeId">TypeId</a></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <ahref="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></div></div></section><sectionid="search"class="content hidden"></section><sectionclass="footer"></section><asideid="help"class="hidden"><div><h1class="hidden">Help</h1><divclass="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><divclass="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath="../../";window.currentCrate="structopt";</script><scriptsrc="../../aliases.js"></script><scriptsrc="../../main.js"></script><scriptdefersrc="../../search-index.js"></script></body></html>
