edlang/clap/trait.CommandFactory.html
2024-02-27 06:59:44 +00:00

13 lines
9.3 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Create a `Command` relevant for a user-defined container."><title>CommandFactory in clap - 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" 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="sidebar-items.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 trait"><!--[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/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/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><h2><a href="../clap/index.html">clap</a><span class="version">4.5.1</span></h2></div><h2 class="location"><a href="#">CommandFactory</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.command">command</a></li><li><a href="#tymethod.command_for_update">command_for_update</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-CommandFactory-for-Box%3CT%3E">Box&lt;T&gt;</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate clap</a></h2></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/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>Trait <a href="index.html">clap</a>::<wbr><a class="trait" href="#">CommandFactory</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/derive.rs.html#107">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait CommandFactory: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
// Required methods
fn <a href="#tymethod.command" class="fn">command</a>() -&gt; <a class="struct" href="struct.Command.html" title="struct clap::Command">Command</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.command_for_update" class="fn">command_for_update</a>() -&gt; <a class="struct" href="struct.Command.html" title="struct clap::Command">Command</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Create a <a href="struct.Command.html" title="struct clap::Command"><code>Command</code></a> relevant for a user-defined container.</p>
<p>Derived as part of <a href="trait.Parser.html" title="trait clap::Parser"><code>Parser</code></a>.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.command" class="method"><a class="src rightside" href="../src/clap_builder/derive.rs.html#111">source</a><h4 class="code-header">fn <a href="#tymethod.command" class="fn">command</a>() -&gt; <a class="struct" href="struct.Command.html" title="struct clap::Command">Command</a></h4></section></summary><div class="docblock"><p>Build a <a href="struct.Command.html" title="struct clap::Command"><code>Command</code></a> that can instantiate <code>Self</code>.</p>
<p>See <a href="trait.FromArgMatches.html#method.from_arg_matches_mut" title="associated function clap::FromArgMatches::from_arg_matches_mut"><code>FromArgMatches::from_arg_matches_mut</code></a> for instantiating <code>Self</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.command_for_update" class="method"><a class="src rightside" href="../src/clap_builder/derive.rs.html#115">source</a><h4 class="code-header">fn <a href="#tymethod.command_for_update" class="fn">command_for_update</a>() -&gt; <a class="struct" href="struct.Command.html" title="struct clap::Command">Command</a></h4></section></summary><div class="docblock"><p>Build a <a href="struct.Command.html" title="struct clap::Command"><code>Command</code></a> that can update <code>self</code>.</p>
<p>See <a href="trait.FromArgMatches.html#method.update_from_arg_matches_mut" title="method clap::FromArgMatches::update_from_arg_matches_mut"><code>FromArgMatches::update_from_arg_matches_mut</code></a> for updating <code>self</code>.</p>
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-CommandFactory-for-Box%3CT%3E" class="impl"><a class="src rightside" href="../src/clap_builder/derive.rs.html#313">source</a><a href="#impl-CommandFactory-for-Box%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="trait.CommandFactory.html" title="trait clap::CommandFactory">CommandFactory</a> for <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;T&gt;<div class="where">where
T: <a class="trait" href="trait.CommandFactory.html" title="trait clap::CommandFactory">CommandFactory</a>,</div></h3></section></summary><div class="impl-items"><section id="method.command" class="method trait-impl"><a class="src rightside" href="../src/clap_builder/derive.rs.html#314">source</a><a href="#method.command" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.command" class="fn">command</a>&lt;'help&gt;() -&gt; <a class="struct" href="struct.Command.html" title="struct clap::Command">Command</a></h4></section><section id="method.command_for_update" class="method trait-impl"><a class="src rightside" href="../src/clap_builder/derive.rs.html#317">source</a><a href="#method.command_for_update" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.command_for_update" class="fn">command_for_update</a>&lt;'help&gt;() -&gt; <a class="struct" href="struct.Command.html" title="struct clap::Command">Command</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/clap_builder/derive/trait.CommandFactory.js" data-ignore-extern-crates="alloc" async></script></section></div></main></body></html>