49 lines
20 KiB
HTML
49 lines
20 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="Converts an instance of [`ArgMatches`] to a user-defined container."><meta name="keywords" content="rust, rustlang, rust-lang, FromArgMatches"><title>FromArgMatches 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 defer src="sidebar-items.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 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">☰</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="#">FromArgMatches</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.from_arg_matches">from_arg_matches</a></li><li><a href="#tymethod.update_from_arg_matches">update_from_arg_matches</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><ul><li><a href="#method.from_arg_matches_mut">from_arg_matches_mut</a></li><li><a href="#method.update_from_arg_matches_mut">update_from_arg_matches_mut</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul><li><a href="#impl-FromArgMatches-for-Box%3CT%3E">Box<T></a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In clap</a></h2></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">Trait <a href="index.html">clap</a>::<wbr><a class="trait" href="#">FromArgMatches</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/derive.rs.html#176-254">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait FromArgMatches: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
fn <a href="#tymethod.from_arg_matches" class="fnname">from_arg_matches</a>(matches: &<a class="struct" href="parser/struct.ArgMatches.html" title="struct clap::parser::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="type" href="type.Error.html" title="type clap::Error">Error</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.update_from_arg_matches" class="fnname">update_from_arg_matches</a>(<br> &mut self,<br> matches: &<a class="struct" href="parser/struct.ArgMatches.html" title="struct clap::parser::ArgMatches">ArgMatches</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>, <a class="type" href="type.Error.html" title="type clap::Error">Error</a>>;
|
||
|
||
fn <a href="#method.from_arg_matches_mut" class="fnname">from_arg_matches_mut</a>(matches: &mut <a class="struct" href="parser/struct.ArgMatches.html" title="struct clap::parser::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="type" href="type.Error.html" title="type clap::Error">Error</a>> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.update_from_arg_matches_mut" class="fnname">update_from_arg_matches_mut</a>(<br> &mut self,<br> matches: &mut <a class="struct" href="parser/struct.ArgMatches.html" title="struct clap::parser::ArgMatches">ArgMatches</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>, <a class="type" href="type.Error.html" title="type clap::Error">Error</a>> { ... }
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Converts an instance of <a href="parser/struct.ArgMatches.html" title="ArgMatches"><code>ArgMatches</code></a> to a user-defined container.</p>
|
||
<p>Derived as part of <a href="trait.Parser.html" title="Parser"><code>Parser</code></a>, <a href="trait.Args.html" title="Args"><code>Args</code></a>, and <a href="trait.Subcommand.html" title="Subcommand"><code>Subcommand</code></a>.</p>
|
||
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.from_arg_matches" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#209">source</a></div><h4 class="code-header">fn <a href="#tymethod.from_arg_matches" class="fnname">from_arg_matches</a>(matches: &<a class="struct" href="parser/struct.ArgMatches.html" title="struct clap::parser::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="type" href="type.Error.html" title="type clap::Error">Error</a>></h4></div></summary><div class="docblock"><p>Instantiate <code>Self</code> from <a href="parser/struct.ArgMatches.html" title="ArgMatches"><code>ArgMatches</code></a>, parsing the arguments as needed.</p>
|
||
<p>Motivation: If our application had two CLI options, <code>--name <STRING></code> and the flag <code>--debug</code>, we may create a struct as follows:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">struct</span> <span class="ident">Context</span> {
|
||
<span class="ident">name</span>: <span class="ident">String</span>,
|
||
<span class="ident">debug</span>: <span class="ident">bool</span>
|
||
}</code></pre></div>
|
||
<p>We then need to convert the <code>ArgMatches</code> that <code>clap</code> generated into our struct.
|
||
<code>from_arg_matches</code> serves as the equivalent of:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">ArgMatches</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Context</span> {
|
||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">m</span>: <span class="ident">ArgMatches</span>) -> <span class="self">Self</span> {
|
||
<span class="ident">Context</span> {
|
||
<span class="ident">name</span>: <span class="ident">m</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">String</span><span class="op">></span>(<span class="string">"name"</span>).<span class="ident">unwrap</span>().<span class="ident">clone</span>(),
|
||
<span class="ident">debug</span>: <span class="kw-2">*</span><span class="ident">m</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>(<span class="string">"debug"</span>).<span class="ident">expect</span>(<span class="string">"defaulted by clap"</span>),
|
||
}
|
||
}
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.update_from_arg_matches" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#248">source</a></div><h4 class="code-header">fn <a href="#tymethod.update_from_arg_matches" class="fnname">update_from_arg_matches</a>(&mut self, matches: &<a class="struct" href="parser/struct.ArgMatches.html" title="struct clap::parser::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>, <a class="type" href="type.Error.html" title="type clap::Error">Error</a>></h4></div></summary><div class="docblock"><p>Assign values from <code>ArgMatches</code> to <code>self</code>.</p>
|
||
</div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="method.from_arg_matches_mut" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#243-245">source</a></div><h4 class="code-header">fn <a href="#method.from_arg_matches_mut" class="fnname">from_arg_matches_mut</a>(matches: &mut <a class="struct" href="parser/struct.ArgMatches.html" title="struct clap::parser::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="type" href="type.Error.html" title="type clap::Error">Error</a>></h4></div></summary><div class="docblock"><p>Instantiate <code>Self</code> from <a href="parser/struct.ArgMatches.html" title="ArgMatches"><code>ArgMatches</code></a>, parsing the arguments as needed.</p>
|
||
<p>Motivation: If our application had two CLI options, <code>--name <STRING></code> and the flag <code>--debug</code>, we may create a struct as follows:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">struct</span> <span class="ident">Context</span> {
|
||
<span class="ident">name</span>: <span class="ident">String</span>,
|
||
<span class="ident">debug</span>: <span class="ident">bool</span>
|
||
}</code></pre></div>
|
||
<p>We then need to convert the <code>ArgMatches</code> that <code>clap</code> generated into our struct.
|
||
<code>from_arg_matches_mut</code> serves as the equivalent of:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">ArgMatches</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Context</span> {
|
||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">m</span>: <span class="ident">ArgMatches</span>) -> <span class="self">Self</span> {
|
||
<span class="ident">Context</span> {
|
||
<span class="ident">name</span>: <span class="ident">m</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">String</span><span class="op">></span>(<span class="string">"name"</span>).<span class="ident">unwrap</span>().<span class="ident">to_string</span>(),
|
||
<span class="ident">debug</span>: <span class="kw-2">*</span><span class="ident">m</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>(<span class="string">"debug"</span>).<span class="ident">expect</span>(<span class="string">"defaulted by clap"</span>),
|
||
}
|
||
}
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="method.update_from_arg_matches_mut" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#251-253">source</a></div><h4 class="code-header">fn <a href="#method.update_from_arg_matches_mut" class="fnname">update_from_arg_matches_mut</a>(<br> &mut self,<br> matches: &mut <a class="struct" href="parser/struct.ArgMatches.html" title="struct clap::parser::ArgMatches">ArgMatches</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>, <a class="type" href="type.Error.html" title="type clap::Error">Error</a>></h4></div></summary><div class="docblock"><p>Assign values from <code>ArgMatches</code> to <code>self</code>.</p>
|
||
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FromArgMatches-for-Box%3CT%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#432-445">source</a></span><a href="#impl-FromArgMatches-for-Box%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T: <a class="trait" href="trait.FromArgMatches.html" title="trait clap::FromArgMatches">FromArgMatches</a>> <a class="trait" href="trait.FromArgMatches.html" title="trait clap::FromArgMatches">FromArgMatches</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T></h3></section></summary><div class="impl-items"><section id="method.from_arg_matches" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#433-435">source</a></span><a href="#method.from_arg_matches" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.from_arg_matches" class="fnname">from_arg_matches</a>(matches: &<a class="struct" href="parser/struct.ArgMatches.html" title="struct clap::parser::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="type" href="type.Error.html" title="type clap::Error">Error</a>></h4></section><section id="method.from_arg_matches_mut-1" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#436-438">source</a></span><a href="#method.from_arg_matches_mut-1" class="anchor"></a><h4 class="code-header">fn <a href="#method.from_arg_matches_mut" class="fnname">from_arg_matches_mut</a>(matches: &mut <a class="struct" href="parser/struct.ArgMatches.html" title="struct clap::parser::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="type" href="type.Error.html" title="type clap::Error">Error</a>></h4></section><section id="method.update_from_arg_matches" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#439-441">source</a></span><a href="#method.update_from_arg_matches" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.update_from_arg_matches" class="fnname">update_from_arg_matches</a>(&mut self, matches: &<a class="struct" href="parser/struct.ArgMatches.html" title="struct clap::parser::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>, <a class="type" href="type.Error.html" title="type clap::Error">Error</a>></h4></section><section id="method.update_from_arg_matches_mut-1" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#442-444">source</a></span><a href="#method.update_from_arg_matches_mut-1" class="anchor"></a><h4 class="code-header">fn <a href="#method.update_from_arg_matches_mut" class="fnname">update_from_arg_matches_mut</a>(<br> &mut self,<br> matches: &mut <a class="struct" href="parser/struct.ArgMatches.html" title="struct clap::parser::ArgMatches">ArgMatches</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>, <a class="type" href="type.Error.html" title="type clap::Error">Error</a>></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../implementors/clap/derive/trait.FromArgMatches.js" data-ignore-extern-crates="alloc" async></script></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> |