blob: 048e0312969fbd6869f863b8799fd1bad9f25cf0 [file] [log] [blame]
<!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/clap-2.34.0/src/completions/shell.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>shell.rs - source</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" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../clap/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../clap/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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"><a href="../../../help.html">?</a></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><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
</pre><pre class="rust"><code><span class="attribute">#[allow(deprecated, unused_imports)]
</span><span class="kw">use </span>std::ascii::AsciiExt;
<span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::str::FromStr;
<span class="doccomment">/// Describes which shell to produce a completions file for
</span><span class="attribute">#[derive(Debug, Copy, Clone)]
</span><span class="kw">pub enum </span>Shell {
<span class="doccomment">/// Generates a .bash completion file for the Bourne Again SHell (BASH)
</span>Bash,
<span class="doccomment">/// Generates a .fish completion file for the Friendly Interactive SHell (fish)
</span>Fish,
<span class="doccomment">/// Generates a completion file for the Z SHell (ZSH)
</span>Zsh,
<span class="doccomment">/// Generates a completion file for PowerShell
</span>PowerShell,
<span class="doccomment">/// Generates a completion file for Elvish
</span>Elvish,
}
<span class="kw">impl </span>Shell {
<span class="doccomment">/// A list of possible variants in `&amp;&#39;static str` form
</span><span class="kw">pub fn </span>variants() -&gt; [<span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str; <span class="number">5</span>] {
[<span class="string">&quot;zsh&quot;</span>, <span class="string">&quot;bash&quot;</span>, <span class="string">&quot;fish&quot;</span>, <span class="string">&quot;powershell&quot;</span>, <span class="string">&quot;elvish&quot;</span>]
}
}
<span class="kw">impl </span>FromStr <span class="kw">for </span>Shell {
<span class="kw">type </span><span class="prelude-val">Err </span>= String;
<span class="attribute">#[cfg_attr(feature = <span class="string">&quot;cargo-clippy&quot;</span>, allow(clippy::wildcard_in_or_patterns))]
</span><span class="kw">fn </span>from_str(s: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, <span class="self">Self</span>::Err&gt; {
<span class="kw">match </span>s {
<span class="string">&quot;ZSH&quot; </span>| <span class="kw">_ if </span>s.eq_ignore_ascii_case(<span class="string">&quot;zsh&quot;</span>) =&gt; <span class="prelude-val">Ok</span>(Shell::Zsh),
<span class="string">&quot;FISH&quot; </span>| <span class="kw">_ if </span>s.eq_ignore_ascii_case(<span class="string">&quot;fish&quot;</span>) =&gt; <span class="prelude-val">Ok</span>(Shell::Fish),
<span class="string">&quot;BASH&quot; </span>| <span class="kw">_ if </span>s.eq_ignore_ascii_case(<span class="string">&quot;bash&quot;</span>) =&gt; <span class="prelude-val">Ok</span>(Shell::Bash),
<span class="string">&quot;POWERSHELL&quot; </span>| <span class="kw">_ if </span>s.eq_ignore_ascii_case(<span class="string">&quot;powershell&quot;</span>) =&gt; <span class="prelude-val">Ok</span>(Shell::PowerShell),
<span class="string">&quot;ELVISH&quot; </span>| <span class="kw">_ if </span>s.eq_ignore_ascii_case(<span class="string">&quot;elvish&quot;</span>) =&gt; <span class="prelude-val">Ok</span>(Shell::Elvish),
<span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(String::from(
<span class="string">&quot;[valid values: bash, fish, zsh, powershell, elvish]&quot;</span>,
)),
}
}
}
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>Shell {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
Shell::Bash =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;BASH&quot;</span>),
Shell::Fish =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;FISH&quot;</span>),
Shell::Zsh =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;ZSH&quot;</span>),
Shell::PowerShell =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;POWERSHELL&quot;</span>),
Shell::Elvish =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;ELVISH&quot;</span>),
}
}
}
</code></pre></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.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>