33 lines
7.0 KiB
HTML
33 lines
7.0 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="Build a command-line interface."><meta name="keywords" content="rust, rustlang, rust-lang, Command"><title>Command in clap - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc type"><!--[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">☰</div><a class="sidebar-logo" href="../clap/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div>
|
||
</a><h2 class="location">Type Definition Command</h2><div class="sidebar-elems"><h2 class="location">Other items in<br><a href="index.html">clap</a></h2><div id="sidebar-vars" data-name="Command" data-ty="type" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../clap/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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" 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 width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Type Definition <a href="index.html">clap</a>::<wbr><a class="type" href="#">Command</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></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">−</span>]</a></span><a class="srclink" href="../src/clap/build/command.rs.html#70" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust typedef"><code>pub type Command<'help> = <a class="struct" href="struct.App.html" title="struct clap::App">App</a><'help>;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Build a command-line interface.</p>
|
||
<p>This includes defining arguments, subcommands, parser behavior, and help output.
|
||
Once all configuration is complete,
|
||
the <a href="struct.App.html#method.get_matches" title="Command::get_matches"><code>Command::get_matches</code></a> family of methods starts the runtime-parsing
|
||
process. These methods then return information about the user supplied
|
||
arguments (or lack thereof).</p>
|
||
<p>When deriving a <a href="trait.Parser.html" title="crate::Parser"><code>Parser</code></a>, you can use
|
||
<a href="trait.CommandFactory.html#method.command" title="crate::CommandFactory::command"><code>CommandFactory::command</code></a> to access the
|
||
<code>Command</code>.</p>
|
||
<ul>
|
||
<li><a href="struct.App.html#basic-api" title="crate::App">Basic API</a></li>
|
||
<li><a href="struct.App.html#application-wide-settings" title="crate::App">Application-wide Settings</a></li>
|
||
<li><a href="struct.App.html#command-specific-settings" title="crate::App">Command-specific Settings</a></li>
|
||
<li><a href="struct.App.html#subcommand-specific-settings" title="crate::App">Subcommand-specific Settings</a></li>
|
||
<li><a href="struct.App.html#reflection" title="crate::App">Reflection</a></li>
|
||
</ul>
|
||
<h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"My Program"</span>)
|
||
.<span class="ident">author</span>(<span class="string">"Me, me@mail.com"</span>)
|
||
.<span class="ident">version</span>(<span class="string">"1.0.2"</span>)
|
||
.<span class="ident">about</span>(<span class="string">"Explains in brief what the program does"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">Arg::new</span>(<span class="string">"in_file"</span>).<span class="ident">index</span>(<span class="number">1</span>)
|
||
)
|
||
.<span class="ident">after_help</span>(<span class="string">"Longer explanation to appear after the options when \
|
||
displaying the help information from --help or -h"</span>)
|
||
.<span class="ident">get_matches</span>();
|
||
|
||
<span class="comment">// Your program logic starts here...</span></code></pre></div>
|
||
</div></details></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |