Skip to content

Commit

Permalink
release
Browse files Browse the repository at this point in the history
  • Loading branch information
@sagiegurari
sagiegurari committed Jul 21, 2022
1 parent d1048f7 commit 2366a22
Show file tree
Hide file tree
Showing 15 changed files with 654 additions and 472 deletions.
2 changes: 1 addition & 1 deletion docs/api/cliparser/fn.help.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
</a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In cliparser</a></h2><div id="sidebar-vars" data-name="help" data-ty="fn" 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="../cliparser/index.html"><img class="rust-logo" src="../rust-logo.svg" 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"><button type="button" id="help-button" title="help">?</button><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">Function <a href="index.html">cliparser</a>::<wbr><a class="fn" href="#">help</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/cliparser/lib.rs.html#578-580">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn help(spec: &amp;<a class="struct" href="types/struct.CliSpec.html" title="struct cliparser::types::CliSpec">CliSpec</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Generates and returns the spec help text</p>
<h1 class="fqn"><span class="in-band">Function <a href="index.html">cliparser</a>::<wbr><a class="fn" href="#">help</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/cliparser/lib.rs.html#556-558">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn help(spec: &amp;<a class="struct" href="types/struct.CliSpec.html" title="struct cliparser::types::CliSpec">CliSpec</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Generates and returns the spec help text</p>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="cliparser" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.63.0-nightly (ec55c6130 2022-06-10)" ></div>
</body></html>
199 changes: 94 additions & 105 deletions docs/api/cliparser/fn.parse.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/api/cliparser/fn.parse_any.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
</a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In cliparser</a></h2><div id="sidebar-vars" data-name="parse_any" data-ty="fn" 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="../cliparser/index.html"><img class="rust-logo" src="../rust-logo.svg" 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"><button type="button" id="help-button" title="help">?</button><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">Function <a href="index.html">cliparser</a>::<wbr><a class="fn" href="#">parse_any</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/cliparser/lib.rs.html#564-569">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn parse_any(<br>&nbsp;&nbsp;&nbsp;&nbsp;command_line: &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;&amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;specs: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;&amp;<a class="struct" href="types/struct.CliSpec.html" title="struct cliparser::types::CliSpec">CliSpec</a>&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="types/struct.CliParsed.html" title="struct cliparser::types::CliParsed">CliParsed</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="types/enum.ParserError.html" title="enum cliparser::types::ParserError">ParserError</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parsers the given command line based on the given specs and returns the result.<br>
<h1 class="fqn"><span class="in-band">Function <a href="index.html">cliparser</a>::<wbr><a class="fn" href="#">parse_any</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/cliparser/lib.rs.html#542-547">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn parse_any(<br>&nbsp;&nbsp;&nbsp;&nbsp;command_line: &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;&amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;specs: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;&amp;<a class="struct" href="types/struct.CliSpec.html" title="struct cliparser::types::CliSpec">CliSpec</a>&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="types/struct.CliParsed.html" title="struct cliparser::types::CliParsed">CliParsed</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="types/enum.ParserError.html" title="enum cliparser::types::ParserError">ParserError</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parsers the given command line based on the given specs and returns the result.<br>
In case of invalid input or none of the provided specs do not match the command line, an error will be returned.</p>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="cliparser" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.63.0-nightly (ec55c6130 2022-06-10)" ></div>
</body></html>
2 changes: 1 addition & 1 deletion docs/api/cliparser/fn.parse_process.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
</a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In cliparser</a></h2><div id="sidebar-vars" data-name="parse_process" data-ty="fn" 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="../cliparser/index.html"><img class="rust-logo" src="../rust-logo.svg" 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"><button type="button" id="help-button" title="help">?</button><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">Function <a href="index.html">cliparser</a>::<wbr><a class="fn" href="#">parse_process</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/cliparser/lib.rs.html#558-560">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn parse_process(spec: &amp;<a class="struct" href="types/struct.CliSpec.html" title="struct cliparser::types::CliSpec">CliSpec</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="types/struct.CliParsed.html" title="struct cliparser::types::CliParsed">CliParsed</a>, <a class="enum" href="types/enum.ParserError.html" title="enum cliparser::types::ParserError">ParserError</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parsers the given command line based on the given spec and returns the result.<br>
<h1 class="fqn"><span class="in-band">Function <a href="index.html">cliparser</a>::<wbr><a class="fn" href="#">parse_process</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/cliparser/lib.rs.html#536-538">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn parse_process(spec: &amp;<a class="struct" href="types/struct.CliSpec.html" title="struct cliparser::types::CliSpec">CliSpec</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="types/struct.CliParsed.html" title="struct cliparser::types::CliParsed">CliParsed</a>, <a class="enum" href="types/enum.ParserError.html" title="enum cliparser::types::ParserError">ParserError</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parsers the given command line based on the given spec and returns the result.<br>
In case of error (such as invalid input), an error will be returned.<br>
In case the command line does not match the spec, Ok(None) will be returned.</p>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="cliparser" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.63.0-nightly (ec55c6130 2022-06-10)" ></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/cliparser/fn.parse_process_any.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
</a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In cliparser</a></h2><div id="sidebar-vars" data-name="parse_process_any" data-ty="fn" 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="../cliparser/index.html"><img class="rust-logo" src="../rust-logo.svg" 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"><button type="button" id="help-button" title="help">?</button><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">Function <a href="index.html">cliparser</a>::<wbr><a class="fn" href="#">parse_process_any</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/cliparser/lib.rs.html#573-575">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn parse_process_any(<br>&nbsp;&nbsp;&nbsp;&nbsp;specs: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;&amp;<a class="struct" href="types/struct.CliSpec.html" title="struct cliparser::types::CliSpec">CliSpec</a>&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="types/struct.CliParsed.html" title="struct cliparser::types::CliParsed">CliParsed</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="types/enum.ParserError.html" title="enum cliparser::types::ParserError">ParserError</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parsers the current process command line based on the given specs and returns the result.<br>
<h1 class="fqn"><span class="in-band">Function <a href="index.html">cliparser</a>::<wbr><a class="fn" href="#">parse_process_any</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/cliparser/lib.rs.html#551-553">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn parse_process_any(<br>&nbsp;&nbsp;&nbsp;&nbsp;specs: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;&amp;<a class="struct" href="types/struct.CliSpec.html" title="struct cliparser::types::CliSpec">CliSpec</a>&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="types/struct.CliParsed.html" title="struct cliparser::types::CliParsed">CliParsed</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="types/enum.ParserError.html" title="enum cliparser::types::ParserError">ParserError</a>&gt;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parsers the current process command line based on the given specs and returns the result.<br>
In case of invalid input or none of the provided specs do not match the command line, an error will be returned.</p>
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="cliparser" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.63.0-nightly (ec55c6130 2022-06-10)" ></div>
</body></html>
Loading

0 comments on commit 2366a22

Please sign in to comment.