207 lines
No EOL
26 KiB
HTML
207 lines
No EOL
26 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="generator" content="rustdoc">
|
||
<meta name="description" content="API documentation for the Rust `Options` struct in crate `getopts`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Options">
|
||
|
||
<title>getopts::Options - 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="../dark.css">
|
||
<link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle">
|
||
<script src="../storage.js"></script>
|
||
|
||
|
||
<link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
|
||
|
||
</head>
|
||
<body class="rustdoc struct">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
<div class="sidebar-menu">☰</div>
|
||
<a href='../getopts/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
|
||
<p class='location'>Struct Options</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.parsing_style">parsing_style</a><a href="#method.long_only">long_only</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.reqopt">reqopt</a><a href="#method.parse">parse</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><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='index.html'>getopts</a></p><script>window.sidebarCurrent = {name: 'Options', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
|
||
</nav>
|
||
|
||
<div class="theme-picker">
|
||
<button id="theme-picker" aria-label="Pick another theme!">
|
||
<img src="../brush.svg" width="18" alt="Pick another theme!">
|
||
</button>
|
||
<div id="theme-choices"></div>
|
||
</div>
|
||
<script src="../theme.js"></script>
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</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></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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../src/getopts/lib.rs.html#124-128' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Options { /* fields omitted */ }</pre></div><div class='docblock'><p>A description of the options that a program can handle.</p>
|
||
</div>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../getopts/struct.Options.html" title="struct getopts::Options">Options</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#130-564' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../getopts/struct.Options.html" title="struct getopts::Options">Options</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#132-138' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a blank set of options.</p>
|
||
</div><h4 id='method.parsing_style' class="method"><span id='parsing_style.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.parsing_style' class='fnname'>parsing_style</a>(&mut self, style: <a class="enum" href="../getopts/enum.ParsingStyle.html" title="enum getopts::ParsingStyle">ParsingStyle</a>) -> &mut <a class="struct" href="../getopts/struct.Options.html" title="struct getopts::Options">Options</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#141-144' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the parsing style.</p>
|
||
</div><h4 id='method.long_only' class="method"><span id='long_only.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.long_only' class='fnname'>long_only</a>(&mut self, long_only: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="../getopts/struct.Options.html" title="struct getopts::Options">Options</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#154-157' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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><h4 id='method.opt' class="method"><span id='opt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.opt' class='fnname'>opt</a>(<br> &mut self, <br> short_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> long_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> desc: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> hint: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> hasarg: <a class="enum" href="../getopts/enum.HasArg.html" title="enum getopts::HasArg">HasArg</a>, <br> occur: <a class="enum" href="../getopts/enum.Occur.html" title="enum getopts::Occur">Occur</a><br>) -> &mut <a class="struct" href="../getopts/struct.Options.html" title="struct getopts::Options">Options</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#160-172' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a generic option group, stating all parameters explicitly.</p>
|
||
</div><h4 id='method.optflag' class="method"><span id='optflag.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.optflag' class='fnname'>optflag</a>(<br> &mut self, <br> short_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> long_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> desc: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> &mut <a class="struct" href="../getopts/struct.Options.html" title="struct getopts::Options">Options</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#179-191' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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>"h"</code> for a <code>-h</code> option, or <code>""</code> for none</li>
|
||
<li><code>long_name</code> - e.g. <code>"help"</code> for a <code>--help</code> option, or <code>""</code> for none</li>
|
||
<li><code>desc</code> - Description for usage help</li>
|
||
</ul>
|
||
</div><h4 id='method.optflagmulti' class="method"><span id='optflagmulti.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.optflagmulti' class='fnname'>optflagmulti</a>(<br> &mut self, <br> short_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> long_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> desc: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> &mut <a class="struct" href="../getopts/struct.Options.html" title="struct getopts::Options">Options</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#199-211' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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>"h"</code> for a <code>-h</code> option, or <code>""</code> for none</li>
|
||
<li><code>long_name</code> - e.g. <code>"help"</code> for a <code>--help</code> option, or <code>""</code> for none</li>
|
||
<li><code>desc</code> - Description for usage help</li>
|
||
</ul>
|
||
</div><h4 id='method.optflagopt' class="method"><span id='optflagopt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.optflagopt' class='fnname'>optflagopt</a>(<br> &mut self, <br> short_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> long_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> desc: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> hint: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> &mut <a class="struct" href="../getopts/struct.Options.html" title="struct getopts::Options">Options</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#220-232' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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>"h"</code> for a <code>-h</code> option, or <code>""</code> for none</li>
|
||
<li><code>long_name</code> - e.g. <code>"help"</code> for a <code>--help</code> option, or <code>""</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>"FILE"</code> for a <code>-o FILE</code> option</li>
|
||
</ul>
|
||
</div><h4 id='method.optmulti' class="method"><span id='optmulti.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.optmulti' class='fnname'>optmulti</a>(<br> &mut self, <br> short_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> long_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> desc: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> hint: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> &mut <a class="struct" href="../getopts/struct.Options.html" title="struct getopts::Options">Options</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#242-254' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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>"h"</code> for a <code>-h</code> option, or <code>""</code> for none</li>
|
||
<li><code>long_name</code> - e.g. <code>"help"</code> for a <code>--help</code> option, or <code>""</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>"FILE"</code> for a <code>-o FILE</code> option</li>
|
||
</ul>
|
||
</div><h4 id='method.optopt' class="method"><span id='optopt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.optopt' class='fnname'>optopt</a>(<br> &mut self, <br> short_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> long_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> desc: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> hint: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> &mut <a class="struct" href="../getopts/struct.Options.html" title="struct getopts::Options">Options</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#263-275' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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>"h"</code> for a <code>-h</code> option, or <code>""</code> for none</li>
|
||
<li><code>long_name</code> - e.g. <code>"help"</code> for a <code>--help</code> option, or <code>""</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>"FILE"</code> for a <code>-o FILE</code> option</li>
|
||
</ul>
|
||
</div><h4 id='method.reqopt' class="method"><span id='reqopt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.reqopt' class='fnname'>reqopt</a>(<br> &mut self, <br> short_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> long_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> desc: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> hint: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> &mut <a class="struct" href="../getopts/struct.Options.html" title="struct getopts::Options">Options</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#284-296' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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>"h"</code> for a <code>-h</code> option, or <code>""</code> for none</li>
|
||
<li><code>long_name</code> - e.g. <code>"help"</code> for a <code>--help</code> option, or <code>""</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>"FILE"</code> for a <code>-o FILE</code> option</li>
|
||
</ul>
|
||
</div><h4 id='method.parse' class="method"><span id='parse.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.parse' class='fnname'>parse</a><C: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>>(&self, args: C) -> <a class="type" href="../getopts/type.Result.html" title="type getopts::Result">Result</a> <span class="where fmt-newline">where<br> C::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::IntoIterator::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#306-438' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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><h4 id='method.short_usage' class="method"><span id='short_usage.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.short_usage' class='fnname'>short_usage</a>(&self, program_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#441-448' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Derive a short one-line usage summary from a set of long options.</p>
|
||
</div><h4 id='method.usage' class="method"><span id='usage.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.usage' class='fnname'>usage</a>(&self, brief: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#452-455' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Derive a formatted message from a set of options.</p>
|
||
</div><h4 id='method.usage_with_format' class="method"><span id='usage_with_format.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.usage_with_format' class='fnname'>usage_with_format</a><F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&mut <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a><Item = <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>(<br> &self, <br> formatter: F<br>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/getopts/lib.rs.html#459-461' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<div id='implementations-list'>
|
||
</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'>
|
||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../getopts/struct.Options.html" title="struct getopts::Options">Options</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../getopts/struct.Options.html" title="struct getopts::Options">Options</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section>
|
||
<section id='search' class="content hidden"></section>
|
||
|
||
<section class="footer"></section>
|
||
|
||
<aside id="help" class="hidden">
|
||
<div>
|
||
<h1 class="hidden">Help</h1>
|
||
|
||
<div class="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>
|
||
|
||
<div class="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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../";
|
||
window.currentCrate = "getopts";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |