image2aa 0.1.4

Convert image to ASCII Art.
Documentation
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A description of the options that a program can handle."><meta name="keywords" content="rust, rustlang, rust-lang, Options"><title>Options in getopts - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css"  id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../getopts/index.html'><div class='logo-container'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo'></div></a><h2 class="location">Struct Options</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><div class="sidebar-links"><a href="#method.long_only">long_only</a><a href="#method.new">new</a><a href="#method.opt">opt</a><a href="#method.optflag">optflag</a><a href="#method.optflagmulti">optflagmulti</a><a href="#method.optflagopt">optflagopt</a><a href="#method.optmulti">optmulti</a><a href="#method.optopt">optopt</a><a href="#method.parse">parse</a><a href="#method.parsing_style">parsing_style</a><a href="#method.reqopt">reqopt</a><a href="#method.short_usage">short_usage</a><a href="#method.usage">usage</a><a href="#method.usage_with_format">usage_with_format</a></div><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-Default">Default</a></div><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow&lt;T&gt;</a><a href="#impl-BorrowMut%3CT%3E">BorrowMut&lt;T&gt;</a><a href="#impl-From%3CT%3E">From&lt;T&gt;</a><a href="#impl-Into%3CU%3E">Into&lt;U&gt;</a><a href="#impl-TryFrom%3CU%3E">TryFrom&lt;U&gt;</a><a href="#impl-TryInto%3CU%3E">TryInto&lt;U&gt;</a></div></div><h2 class="location">Other items in<br><a href="index.html">getopts</a></h2><div id="sidebar-vars" data-name="Options" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">getopts</a>::<wbr><a class="struct" href="#">Options</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../src/getopts/lib.rs.html#127-131" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust struct">pub struct Options { /* fields omitted */ }</pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A description of the options that a program can handle.</p>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h3><a href="#impl" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#139-594" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.new" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -&gt; <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h4><a href="#method.new" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#141-147" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Create a blank set of options.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.parsing_style" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.parsing_style" class="fnname">parsing_style</a>(&amp;mut self, style: <a class="enum" href="enum.ParsingStyle.html" title="enum getopts::ParsingStyle">ParsingStyle</a>) -&gt; &amp;mut <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h4><a href="#method.parsing_style" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#150-153" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Set the parsing style.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.long_only" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.long_only" class="fnname">long_only</a>(&amp;mut self, long_only: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.bool.html">bool</a>) -&gt; &amp;mut <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h4><a href="#method.long_only" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#163-166" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Set or clear “long options only” mode.</p>
<p>In “long options only” mode, short options cannot be clustered
together, and long options can be given with either a single
“-” or the customary “–”.  This mode also changes the meaning
of “-a=b”; in the ordinary mode this will parse a short option
“-a” with argument “=b”; whereas in long-options-only mode the
argument will be simply “b”.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.opt" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.opt" class="fnname">opt</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;short_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;long_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;desc: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;hint: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;hasarg: <a class="enum" href="enum.HasArg.html" title="enum getopts::HasArg">HasArg</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;occur: <a class="enum" href="enum.Occur.html" title="enum getopts::Occur">Occur</a><br>) -&gt; &amp;mut <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h4><a href="#method.opt" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#169-188" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Create a generic option group, stating all parameters explicitly.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.optflag" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.optflag" class="fnname">optflag</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;short_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;long_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;desc: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a><br>) -&gt; &amp;mut <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h4><a href="#method.optflag" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#195-206" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Create a long option that is optional and does not take an argument.</p>
<ul>
<li><code>short_name</code> - e.g. <code>&quot;h&quot;</code> for a <code>-h</code> option, or <code>&quot;&quot;</code> for none</li>
<li><code>long_name</code> - e.g. <code>&quot;help&quot;</code> for a <code>--help</code> option, or <code>&quot;&quot;</code> for none</li>
<li><code>desc</code> - Description for usage help</li>
</ul>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.optflagmulti" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.optflagmulti" class="fnname">optflagmulti</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;short_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;long_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;desc: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a><br>) -&gt; &amp;mut <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h4><a href="#method.optflagmulti" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#214-225" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Create a long option that can occur more than once and does not
take an argument.</p>
<ul>
<li><code>short_name</code> - e.g. <code>&quot;h&quot;</code> for a <code>-h</code> option, or <code>&quot;&quot;</code> for none</li>
<li><code>long_name</code> - e.g. <code>&quot;help&quot;</code> for a <code>--help</code> option, or <code>&quot;&quot;</code> for none</li>
<li><code>desc</code> - Description for usage help</li>
</ul>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.optflagopt" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.optflagopt" class="fnname">optflagopt</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;short_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;long_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;desc: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;hint: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a><br>) -&gt; &amp;mut <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h4><a href="#method.optflagopt" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#234-251" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Create a long option that is optional and takes an optional argument.</p>
<ul>
<li><code>short_name</code> - e.g. <code>&quot;h&quot;</code> for a <code>-h</code> option, or <code>&quot;&quot;</code> for none</li>
<li><code>long_name</code> - e.g. <code>&quot;help&quot;</code> for a <code>--help</code> option, or <code>&quot;&quot;</code> for none</li>
<li><code>desc</code> - Description for usage help</li>
<li><code>hint</code> - Hint that is used in place of the argument in the usage help,
e.g. <code>&quot;FILE&quot;</code> for a <code>-o FILE</code> option</li>
</ul>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.optmulti" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.optmulti" class="fnname">optmulti</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;short_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;long_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;desc: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;hint: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a><br>) -&gt; &amp;mut <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h4><a href="#method.optmulti" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#261-278" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Create a long option that is optional, takes an argument, and may occur
multiple times.</p>
<ul>
<li><code>short_name</code> - e.g. <code>&quot;h&quot;</code> for a <code>-h</code> option, or <code>&quot;&quot;</code> for none</li>
<li><code>long_name</code> - e.g. <code>&quot;help&quot;</code> for a <code>--help</code> option, or <code>&quot;&quot;</code> for none</li>
<li><code>desc</code> - Description for usage help</li>
<li><code>hint</code> - Hint that is used in place of the argument in the usage help,
e.g. <code>&quot;FILE&quot;</code> for a <code>-o FILE</code> option</li>
</ul>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.optopt" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.optopt" class="fnname">optopt</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;short_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;long_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;desc: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;hint: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a><br>) -&gt; &amp;mut <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h4><a href="#method.optopt" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#287-304" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Create a long option that is optional and takes an argument.</p>
<ul>
<li><code>short_name</code> - e.g. <code>&quot;h&quot;</code> for a <code>-h</code> option, or <code>&quot;&quot;</code> for none</li>
<li><code>long_name</code> - e.g. <code>&quot;help&quot;</code> for a <code>--help</code> option, or <code>&quot;&quot;</code> for none</li>
<li><code>desc</code> - Description for usage help</li>
<li><code>hint</code> - Hint that is used in place of the argument in the usage help,
e.g. <code>&quot;FILE&quot;</code> for a <code>-o FILE</code> option</li>
</ul>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.reqopt" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.reqopt" class="fnname">reqopt</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;short_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;long_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;desc: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;hint: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a><br>) -&gt; &amp;mut <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h4><a href="#method.reqopt" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#313-330" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Create a long option that is required and takes an argument.</p>
<ul>
<li><code>short_name</code> - e.g. <code>&quot;h&quot;</code> for a <code>-h</code> option, or <code>&quot;&quot;</code> for none</li>
<li><code>long_name</code> - e.g. <code>&quot;help&quot;</code> for a <code>--help</code> option, or <code>&quot;&quot;</code> for none</li>
<li><code>desc</code> - Description for usage help</li>
<li><code>hint</code> - Hint that is used in place of the argument in the usage help,
e.g. <code>&quot;FILE&quot;</code> for a <code>-o FILE</code> option</li>
</ul>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.parse" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.parse" class="fnname">parse</a>&lt;C:&nbsp;<a class="trait" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>&gt;(&amp;self, args: C) -&gt; <a class="type" href="type.Result.html" title="type getopts::Result">Result</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;C::<a class="type" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.54.0/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a>&gt;,&nbsp;</span></h4><a href="#method.parse" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#340-480" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Parse command line arguments according to the provided options.</p>
<p>On success returns <code>Ok(Matches)</code>. Use methods such as <code>opt_present</code>
<code>opt_str</code>, etc. to interrogate results.</p>
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
<p>Returns <code>Err(Fail)</code> on failure: use the <code>Debug</code> implementation of <code>Fail</code>
to display information about it.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.short_usage" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.short_usage" class="fnname">short_usage</a>(&amp;self, program_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.54.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4><a href="#method.short_usage" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#483-494" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Derive a short one-line usage summary from a set of long options.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.usage" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.usage" class="fnname">usage</a>(&amp;self, brief: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.54.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4><a href="#method.usage" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#497-505" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Derive a formatted message from a set of options.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.usage_with_format" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.usage_with_format" class="fnname">usage_with_format</a>&lt;F:&nbsp;<a class="trait" href="https://doc.rust-lang.org/1.54.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&amp;mut dyn <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>&lt;Item = <a class="struct" href="https://doc.rust-lang.org/1.54.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.54.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;formatter: F<br>) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.54.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4><a href="#method.usage_with_format" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#509-514" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Derive a custom formatted message from a set of options. The formatted options provided to
a closure as an iterator.</p>
</div></details></div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Default" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h3><a href="#impl-Default" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#133-137" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.default" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -&gt; Self</h4><a href="#method.default" class="anchor"></a><a class="srclink" href="../src/getopts/lib.rs.html#134-136" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.54.0/core/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><div id="impl-RefUnwindSafe" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.54.0/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h3><a href="#impl-RefUnwindSafe" class="anchor"></a></div><div id="impl-Send" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h3><a href="#impl-Send" class="anchor"></a></div><div id="impl-Sync" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h3><a href="#impl-Sync" class="anchor"></a></div><div id="impl-Unpin" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h3><a href="#impl-Unpin" class="anchor"></a></div><div id="impl-UnwindSafe" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.54.0/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Options.html" title="struct getopts::Options">Options</a></h3><a href="#impl-UnwindSafe" class="anchor"></a></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Any" class="impl has-srclink"><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></h3><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/any.rs.html#131-135" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.type_id" class="method trait-impl has-srclink"><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.54.0/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.54.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4><a href="#method.type_id" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/any.rs.html#132" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.54.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Borrow%3CT%3E" class="impl has-srclink"><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></h3><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/borrow.rs.html#208-213" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow" class="method trait-impl has-srclink"><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.54.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&amp;</a>T</h4><a href="#method.borrow" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/borrow.rs.html#210" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.54.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></h3><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/borrow.rs.html#216-220" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow_mut" class="method trait-impl has-srclink"><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.54.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&amp;mut </a>T</h4><a href="#method.borrow_mut" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/borrow.rs.html#217" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.54.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-From%3CT%3E" class="impl has-srclink"><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#544-548" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from" class="method trait-impl has-srclink"><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.54.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -&gt; T</h4><a href="#method.from" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#545" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Into%3CU%3E" class="impl has-srclink"><h3 class="code-header in-band">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,&nbsp;</span></h3><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#533-540" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into" class="method trait-impl has-srclink"><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -&gt; U</h4><a href="#method.into" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#537" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-TryFrom%3CU%3E" class="impl has-srclink"><h3 class="code-header in-band">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,&nbsp;</span></h3><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#581-590" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4><a href="#associatedtype.Error" class="anchor"></a></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from" class="method trait-impl has-srclink"><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4><a href="#method.try_from" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#587" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-TryInto%3CU%3E" class="impl has-srclink"><h3 class="code-header in-band">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,&nbsp;</span></h3><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#567-576" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-1" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4><a href="#associatedtype.Error-1" class="anchor"></a></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_into" class="method trait-impl has-srclink"><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4><a href="#method.try_into" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#573" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="getopts" data-search-index-js="../search-index.js" data-search-js="../search.js"></div><script src="../main.js"></script></body></html>