33 lines
13 KiB
HTML
33 lines
13 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="Define [`Command`] line [arguments][`Arg`]"><meta name="keywords" content="rust, rustlang, rust-lang, builder"><title>clap::builder - 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 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 mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><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"></h2></nav><nav class="sidebar"><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"><a href="#">Module builder</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div></section></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"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">clap</a>::<wbr><a class="mod" href="#">builder</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></h1><span class="out-of-band"><a class="srclink" href="../../src/clap/builder/mod.rs.html#1-60">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Define <a href="struct.Command.html" title="Command"><code>Command</code></a> line <a href="struct.Arg.html" title="Arg">arguments</a></p>
|
||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Arg.html" title="clap::builder::Arg struct">Arg</a></div><div class="item-right docblock-short"><p>The abstract representation of a command line argument. Used to set all the options and
|
||
relationships that define a valid argument for the program.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ArgGroup.html" title="clap::builder::ArgGroup struct">ArgGroup</a></div><div class="item-right docblock-short"><p>Family of related <a href="struct.Arg.html">arguments</a>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BoolValueParser.html" title="clap::builder::BoolValueParser struct">BoolValueParser</a></div><div class="item-right docblock-short"><p>Implementation for <a href="struct.ValueParser.html#method.bool" title="ValueParser::bool"><code>ValueParser::bool</code></a></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BoolishValueParser.html" title="clap::builder::BoolishValueParser struct">BoolishValueParser</a></div><div class="item-right docblock-short"><p>Parse bool-like string values, everything else is <code>true</code></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Command.html" title="clap::builder::Command struct">Command</a></div><div class="item-right docblock-short"><p>Build a command-line interface.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EnumValueParser.html" title="clap::builder::EnumValueParser struct">EnumValueParser</a></div><div class="item-right docblock-short"><p>Parse an <a href="../trait.ValueEnum.html" title="crate::ValueEnum"><code>ValueEnum</code></a> value.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FalseyValueParser.html" title="clap::builder::FalseyValueParser struct">FalseyValueParser</a></div><div class="item-right docblock-short"><p>Parse false-like string values, everything else is <code>true</code></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MapValueParser.html" title="clap::builder::MapValueParser struct">MapValueParser</a></div><div class="item-right docblock-short"><p>Adapt a <code>TypedValueParser</code> from one value to another</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.NonEmptyStringValueParser.html" title="clap::builder::NonEmptyStringValueParser struct">NonEmptyStringValueParser</a></div><div class="item-right docblock-short"><p>Parse non-empty string values</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OsStr.html" title="clap::builder::OsStr struct">OsStr</a></div><div class="item-right docblock-short"><p>A UTF-8-encoded fixed string</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OsStringValueParser.html" title="clap::builder::OsStringValueParser struct">OsStringValueParser</a></div><div class="item-right docblock-short"><p>Implementation for <a href="struct.ValueParser.html#method.os_string" title="ValueParser::os_string"><code>ValueParser::os_string</code></a></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PathBufValueParser.html" title="clap::builder::PathBufValueParser struct">PathBufValueParser</a></div><div class="item-right docblock-short"><p>Implementation for <a href="struct.ValueParser.html#method.path_buf" title="ValueParser::path_buf"><code>ValueParser::path_buf</code></a></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PossibleValue.html" title="clap::builder::PossibleValue struct">PossibleValue</a></div><div class="item-right docblock-short"><p>A possible value of an argument.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PossibleValuesParser.html" title="clap::builder::PossibleValuesParser struct">PossibleValuesParser</a></div><div class="item-right docblock-short"><p>Verify the value is from an enumerated set of <a href="struct.PossibleValue.html" title="crate::builder::PossibleValue"><code>PossibleValue</code></a>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RangedI64ValueParser.html" title="clap::builder::RangedI64ValueParser struct">RangedI64ValueParser</a></div><div class="item-right docblock-short"><p>Parse number that fall within a range of values</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RangedU64ValueParser.html" title="clap::builder::RangedU64ValueParser struct">RangedU64ValueParser</a></div><div class="item-right docblock-short"><p>Parse number that fall within a range of values</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Str.html" title="clap::builder::Str struct">Str</a></div><div class="item-right docblock-short"><p>A UTF-8-encoded fixed string</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StringValueParser.html" title="clap::builder::StringValueParser struct">StringValueParser</a></div><div class="item-right docblock-short"><p>Implementation for <a href="struct.ValueParser.html#method.string" title="ValueParser::string"><code>ValueParser::string</code></a></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StyledStr.html" title="clap::builder::StyledStr struct">StyledStr</a></div><div class="item-right docblock-short"><p>Terminal-styling container</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ValueParser.html" title="clap::builder::ValueParser struct">ValueParser</a></div><div class="item-right docblock-short"><p>Parse/validate argument values</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ValueRange.html" title="clap::builder::ValueRange struct">ValueRange</a></div><div class="item-right docblock-short"><p>Values per occurrence for an argument</p>
|
||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ArgAction.html" title="clap::builder::ArgAction enum">ArgAction</a></div><div class="item-right docblock-short"><p>Behavior of arguments when they are encountered while parsing</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ArgPredicate.html" title="clap::builder::ArgPredicate enum">ArgPredicate</a></div><div class="item-right docblock-short"><p>Operations to perform on argument values</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Resettable.html" title="clap::builder::Resettable enum">Resettable</a></div><div class="item-right docblock-short"><p>Clearable builder value</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ValueHint.html" title="clap::builder::ValueHint enum">ValueHint</a></div><div class="item-right docblock-short"><p>Provide shell with hint on how to complete an argument.</p>
|
||
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.IntoResettable.html" title="clap::builder::IntoResettable trait">IntoResettable</a></div><div class="item-right docblock-short"><p>Convert to the intended resettable type</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.TypedValueParser.html" title="clap::builder::TypedValueParser trait">TypedValueParser</a></div><div class="item-right docblock-short"><p>Parse/validate argument values</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ValueParserFactory.html" title="clap::builder::ValueParserFactory trait">ValueParserFactory</a></div><div class="item-right docblock-short"><p>Register a type with <a href="../macro.value_parser.html" title="crate::value_parser!">value_parser!</a></p>
|
||
</div></div></div></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.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |