sascha
/
difftastic
mirror of https://github.com/Wilfred/difftastic/
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
difftastic/rustdoc/clap_builder/index.html

25 lines
13 KiB
HTML
Raw Permalink Blame History Unescape Escape

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!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="`clap_builder`"><title>clap_builder - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="clap_builder" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[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">&#9776;</button><a class="logo-container" href="../clap_builder/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../clap_builder/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><h2><a href="../clap_builder/index.html">clap_builder</a><span class="version">4.5.23</span></h2></div><div class="sidebar-elems"><ul class="block">
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Aliases</a></li></ul></section></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../clap_builder/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">clap_builder</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/clap_builder/lib.rs.html#6-49">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="clap_builder"><a href="#clap_builder"><code>clap_builder</code></a></h2>
<p>Builder implementation for clap.</p>
<p><a href="https://docs.rs/clap">docs.rs</a></p>
<ul>
<li><a href="https://docs.rs/clap/latest/clap/_derive/_tutorial/index.html">Derive Tutorial</a></li>
<li><a href="https://docs.rs/clap/latest/clap/_derive/index.html">Derive Reference</a></li>
</ul>
<h3 id="license"><a href="#license">License</a></h3>
<p>Licensed under either of</p>
<ul>
<li>Apache License, Version 2.0 (<a href="LICENSE-APACHE">LICENSE-APACHE</a> or <a href="https://www.apache.org/licenses/LICENSE-2.0">https://www.apache.org/licenses/LICENSE-2.0</a>)</li>
<li>MIT license (<a href="LICENSE-MIT">LICENSE-MIT</a> or <a href="https://opensource.org/licenses/MIT">https://opensource.org/licenses/MIT</a>)</li>
</ul>
<p>at your option.</p>
<h4 id="contribution"><a href="#contribution">Contribution</a></h4>
<p>Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.</p>
<p>See <a href="CONTRIBUTING.md">CONTRIBUTING</a> for more details.</p>
</div></details><h2 id="reexports" class="section-header"><a href="#reexports">Re-exports</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.ArgAction"><code>pub use crate::builder::<a class="enum" href="builder/enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a>;</code></div></li><li><div class="item-name" id="reexport.Command"><code>pub use crate::builder::<a class="struct" href="builder/struct.Command.html" title="struct clap_builder::builder::Command">Command</a>;</code></div></li><li><div class="item-name" id="reexport.ValueHint"><code>pub use crate::builder::<a class="enum" href="builder/enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a>;</code></div></li><li><div class="item-name" id="reexport.Arg"><code>pub use crate::builder::<a class="struct" href="builder/struct.Arg.html" title="struct clap_builder::builder::Arg">Arg</a>;</code></div></li><li><div class="item-name" id="reexport.ArgGroup"><code>pub use crate::builder::<a class="struct" href="builder/struct.ArgGroup.html" title="struct clap_builder::builder::ArgGroup">ArgGroup</a>;</code></div></li><li><div class="item-name" id="reexport.ArgMatches"><code>pub use crate::parser::<a class="struct" href="parser/struct.ArgMatches.html" title="struct clap_builder::parser::ArgMatches">ArgMatches</a>;</code></div></li></ul><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="builder/index.html" title="mod clap_builder::builder">builder</a></div><div class="desc docblock-short">Define <a href="builder/struct.Command.html" title="struct clap_builder::builder::Command"><code>Command</code></a> line <a href="builder/struct.Arg.html" title="struct clap_builder::builder::Arg">arguments</a></div></li><li><div class="item-name"><a class="mod" href="error/index.html" title="mod clap_builder::error">error</a></div><div class="desc docblock-short">Error reporting</div></li><li><div class="item-name"><a class="mod" href="parser/index.html" title="mod clap_builder::parser">parser</a></div><div class="desc docblock-short"><a href="builder/struct.Command.html" title="struct clap_builder::builder::Command"><code>Command</code></a> line argument parser</div></li></ul><h2 id="macros" class="section-header"><a href="#macros">Macros</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.arg.html" title="macro clap_builder::arg">arg</a></div><div class="desc docblock-short">Create an <a href="builder/struct.Arg.html" title="struct clap_builder::builder::Arg"><code>Arg</code></a> from a usage string.</div></li><li><div class="item-name"><a class="macro" href="macro.command.html" title="macro clap_builder::command">command</a></div><div class="desc docblock-short">Allows you to build the <code>Command</code> instance from your Cargo.toml at compile time.</div></li><li><div class="item-name"><a class="macro" href="macro.crate_authors.html" title="macro clap_builder::crate_authors">crate_authors</a></div><div class="desc docblock-short">Allows you to pull the authors for the command from your Cargo.toml at
compile time in the form:
<code>&quot;author1 lastname &lt;author1@example.com&gt;:author2 lastname &lt;author2@example.com&gt;&quot;</code></div></li><li><div class="item-name"><a class="macro" href="macro.crate_description.html" title="macro clap_builder::crate_description">crate_description</a></div><div class="desc docblock-short">Allows you to pull the description from your Cargo.toml at compile time.</div></li><li><div class="item-name"><a class="macro" href="macro.crate_name.html" title="macro clap_builder::crate_name">crate_name</a></div><div class="desc docblock-short">Allows you to pull the name from your Cargo.toml at compile time.</div></li><li><div class="item-name"><a class="macro" href="macro.crate_version.html" title="macro clap_builder::crate_version">crate_version</a></div><div class="desc docblock-short">Allows you to pull the version from your Cargo.toml at compile time as
<code>MAJOR.MINOR.PATCH_PKGVERSION_PRE</code></div></li><li><div class="item-name"><a class="macro" href="macro.value_parser.html" title="macro clap_builder::value_parser">value_parser</a></div><div class="desc docblock-short">Select a <a href="builder/struct.ValueParser.html" title="struct clap_builder::builder::ValueParser"><code>ValueParser</code></a> implementation from the intended type</div></li></ul><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Id.html" title="struct clap_builder::Id">Id</a></div><div class="desc docblock-short"><a href="builder/struct.Arg.html" title="struct clap_builder::builder::Arg"><code>Arg</code></a> or <a href="builder/struct.ArgGroup.html" title="struct clap_builder::builder::ArgGroup"><code>ArgGroup</code></a> identifier</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.ColorChoice.html" title="enum clap_builder::ColorChoice">ColorChoice</a></div><div class="desc docblock-short">Represents the color preferences for program output</div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Args.html" title="trait clap_builder::Args">Args</a></div><div class="desc docblock-short">Parse a set of arguments into a user-defined container.</div></li><li><div class="item-name"><a class="trait" href="trait.CommandFactory.html" title="trait clap_builder::CommandFactory">CommandFactory</a></div><div class="desc docblock-short">Create a <a href="builder/struct.Command.html" title="struct clap_builder::builder::Command"><code>Command</code></a> relevant for a user-defined container.</div></li><li><div class="item-name"><a class="trait" href="trait.FromArgMatches.html" title="trait clap_builder::FromArgMatches">FromArgMatches</a></div><div class="desc docblock-short">Converts an instance of <a href="parser/struct.ArgMatches.html" title="struct clap_builder::parser::ArgMatches"><code>ArgMatches</code></a> to a user-defined container.</div></li><li><div class="item-name"><a class="trait" href="trait.Parser.html" title="trait clap_builder::Parser">Parser</a></div><div class="desc docblock-short">Parse command-line arguments into <code>Self</code>.</div></li><li><div class="item-name"><a class="trait" href="trait.Subcommand.html" title="trait clap_builder::Subcommand">Subcommand</a></div><div class="desc docblock-short">Parse a sub-command into a user-defined enum.</div></li><li><div class="item-name"><a class="trait" href="trait.ValueEnum.html" title="trait clap_builder::ValueEnum">ValueEnum</a></div><div class="desc docblock-short">Parse arguments into enums.</div></li></ul><h2 id="types" class="section-header"><a href="#types">Type Aliases</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.Error.html" title="type clap_builder::Error">Error</a></div><div class="desc docblock-short">Command Line Argument Parser Error</div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink