cargo-make 0.37.24

Rust task runner and build tool.
Documentation
<!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 `src/lib/error.rs`."><title>error.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-c579a84d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="cli" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0-nightly (6067b3631 2025-01-17)" data-channel="nightly" data-search-js="search-ccb196c1.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../../static.files/src-script-56102188.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">cli/</div>error.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers">
<a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
<a href="#144" id="144">144</a>
<a href="#145" id="145">145</a>
<a href="#146" id="146">146</a>
<a href="#147" id="147">147</a>
<a href="#148" id="148">148</a>
<a href="#149" id="149">149</a>
<a href="#150" id="150">150</a>
<a href="#151" id="151">151</a>
<a href="#152" id="152">152</a>
<a href="#153" id="153">153</a>
<a href="#154" id="154">154</a>
<a href="#155" id="155">155</a>
<a href="#156" id="156">156</a>
<a href="#157" id="157">157</a>
<a href="#158" id="158">158</a>
<a href="#159" id="159">159</a>
<a href="#160" id="160">160</a>
<a href="#161" id="161">161</a>
<a href="#162" id="162">162</a>
<a href="#163" id="163">163</a>
<a href="#164" id="164">164</a>
<a href="#165" id="165">165</a>
<a href="#166" id="166">166</a>
<a href="#167" id="167">167</a>
<a href="#168" id="168">168</a>
<a href="#169" id="169">169</a>
<a href="#170" id="170">170</a>
<a href="#171" id="171">171</a>
<a href="#172" id="172">172</a>
<a href="#173" id="173">173</a>
<a href="#174" id="174">174</a>
<a href="#175" id="175">175</a>
<a href="#176" id="176">176</a>
<a href="#177" id="177">177</a>
<a href="#178" id="178">178</a>
<a href="#179" id="179">179</a>
<a href="#180" id="180">180</a>
<a href="#181" id="181">181</a>
<a href="#182" id="182">182</a>
<a href="#183" id="183">183</a>
<a href="#184" id="184">184</a></pre></div><pre class="rust"><code><span class="kw">use </span>std::cmp::PartialEq;
<span class="kw">use </span>std::string::ToString;

<span class="attr">#[derive(
    strum_macros::AsRefStr,
    strum_macros::Display,
    strum_macros::EnumDiscriminants,
    strum_macros::IntoStaticStr,
    Debug,
)]
#[repr(u16)]
</span><span class="kw">pub enum </span>CargoMakeError {
    <span class="attr">#[strum(
        to_string = <span class="string">"A cycle between different env variables has been detected \
    (E001, see: https://github.com/sagiegurari/cargo-make#e001 for more information). {0}"
    </span>)]
    </span>EnvVarCycle(String) = <span class="number">100</span>,

    <span class="attr">#[strum(to_string = <span class="string">"Detected cycle while resolving alias {0}: {1}"</span>)]
    </span>AliasCycle(String, String) = <span class="number">101</span>,

    <span class="attr">#[strum(to_string = <span class="string">"Circular reference found for task: {0:#?}"</span>)]
    </span>CircularReference(String) = <span class="number">102</span>,

    <span class="attr">#[strum(to_string = <span class="string">"Unable to run, minimum required version is: {0}"</span>)]
    </span>VersionTooOld(String) = <span class="number">103</span>,

    <span class="attr">#[strum(to_string = <span class="string">"Error while executing command, unable to extract exit code."</span>)]
    </span>ExitCodeValidation = <span class="number">104</span>,

    <span class="attr">#[strum(to_string = <span class="string">"Error while executing command, exit code: {0}"</span>)]
    </span>ExitCodeError(i32) = <span class="number">105</span>,

    <span class="attr">#[strum(to_string = <span class="string">"Unable to parse internal descriptor: {0}"</span>)]
    </span>DescriptorParseFailed(String) = <span class="number">106</span>,

    <span class="attr">#[strum(to_string = <span class="string">"Unable to parse external file: {0:#?}, {1}"</span>)]
    </span>ParseFileFailed(String, String) = <span class="number">107</span>,

    <span class="attr">#[strum(to_string = <span class="string">"{0}"</span>)]
    </span>Arity(<span class="kw-2">&amp;</span><span class="lifetime">'static </span>str) = <span class="number">108</span>,

    <span class="attr">#[strum(to_string = <span class="string">"{0}"</span>)]
    </span>MethodCallRestriction(<span class="kw-2">&amp;</span><span class="lifetime">'static </span>str) = <span class="number">109</span>,

    <span class="attr">#[strum(to_string = <span class="string">"Task {0:#?} is {1}"</span>)]
    </span>TaskIs(String, <span class="kw-2">&amp;</span><span class="lifetime">'static </span>str) = <span class="number">110</span>,

    <span class="attr">#[strum(to_string = <span class="string">"{0}"</span>)]
    </span>NotFound(String) = <span class="number">404</span>,

    <span class="comment">// ************************
    // * Library level errors *
    // ************************
    </span><span class="attr">#[strum(to_string = <span class="string">"`std::io::Error` error. {error:?}"</span>)]
    </span>StdIoError { error: std::io::Error } = <span class="number">700</span>,

    <span class="attr">#[strum(to_string = <span class="string">"`std::fmt::Error` error. {error:?}"</span>)]
    </span>StdFmtError { error: std::fmt::Error } = <span class="number">709</span>,

    <span class="attr">#[strum(to_string = <span class="string">"{0:?}"</span>)]
    </span>ExitCode(std::process::ExitCode) = <span class="number">710</span>,

    <span class="attr">#[strum(to_string = <span class="string">"`toml::de::Error` error. {error:?}"</span>)]
    </span>TomlDeError { error: toml::de::Error } = <span class="number">720</span>,

    <span class="attr">#[strum(to_string = <span class="string">"`fsio::error::FsIOError` error. {error:?}"</span>)]
    </span>FsIOError { error: fsio::error::FsIOError } = <span class="number">730</span>,

    <span class="attr">#[strum(to_string = <span class="string">"`cliparser::types::ParserError` error. {error:?}"</span>)]
    </span>ParserError {
        error: cliparser::types::ParserError,
    } = <span class="number">731</span>,
}

<span class="kw">impl </span>CargoMakeError {
    <span class="kw">fn </span>discriminant(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u16 {
        <span class="kw">unsafe </span>{ <span class="kw-2">*</span>(<span class="self">self </span><span class="kw">as </span><span class="kw-2">*const </span><span class="self">Self </span><span class="kw">as </span><span class="kw-2">*const </span>u16) }
    }
}

<span class="kw">impl </span>From&lt;std::io::Error&gt; <span class="kw">for </span>CargoMakeError {
    <span class="kw">fn </span>from(error: std::io::Error) -&gt; <span class="self">Self </span>{
        <span class="self">Self</span>::StdIoError { error }
    }
}

<span class="kw">impl </span>From&lt;std::fmt::Error&gt; <span class="kw">for </span>CargoMakeError {
    <span class="kw">fn </span>from(error: std::fmt::Error) -&gt; <span class="self">Self </span>{
        <span class="self">Self</span>::StdFmtError { error }
    }
}

<span class="kw">impl </span>From&lt;toml::de::Error&gt; <span class="kw">for </span>CargoMakeError {
    <span class="kw">fn </span>from(error: toml::de::Error) -&gt; <span class="self">Self </span>{
        <span class="self">Self</span>::TomlDeError { error }
    }
}

<span class="kw">impl </span>From&lt;fsio::error::FsIOError&gt; <span class="kw">for </span>CargoMakeError {
    <span class="kw">fn </span>from(error: fsio::error::FsIOError) -&gt; <span class="self">Self </span>{
        <span class="self">Self</span>::FsIOError { error }
    }
} <span class="comment">// ::ParserError

</span><span class="kw">impl </span>From&lt;cliparser::types::ParserError&gt; <span class="kw">for </span>CargoMakeError {
    <span class="kw">fn </span>from(error: cliparser::types::ParserError) -&gt; <span class="self">Self </span>{
        <span class="self">Self</span>::ParserError { error }
    }
}

<span class="kw">impl </span>From&lt;std::process::ExitCode&gt; <span class="kw">for </span>CargoMakeError {
    <span class="kw">fn </span>from(error: std::process::ExitCode) -&gt; <span class="self">Self </span>{
        <span class="self">Self</span>::ExitCode(error)
    }
}

<span class="kw">impl </span>std::process::Termination <span class="kw">for </span>CargoMakeError {
    <span class="kw">fn </span>report(<span class="self">self</span>) -&gt; std::process::ExitCode {
        <span class="kw">if let </span>CargoMakeError::ExitCode(exit_code) = <span class="self">self </span>{
            <span class="kw">return </span>exit_code;
        }
        <span class="kw">let </span>status_code = <span class="self">self</span>.discriminant();
        <span class="kw">if </span>status_code &gt; u8::MAX <span class="kw">as </span>u16 {
            <span class="macro">eprintln!</span>(<span class="string">"exit code {}"</span>, status_code);
            std::process::ExitCode::FAILURE
        } <span class="kw">else </span>{
            std::process::ExitCode::from(status_code <span class="kw">as </span>u8)
        }
    }
}

<span class="kw">pub enum </span>SuccessOrCargoMakeError&lt;T&gt; {
    <span class="prelude-val">Ok</span>(T),
    <span class="prelude-val">Err</span>(CargoMakeError),
}

<span class="kw">impl</span>&lt;T&gt; From&lt;<span class="prelude-ty">Result</span>&lt;T, CargoMakeError&gt;&gt; <span class="kw">for </span>SuccessOrCargoMakeError&lt;T&gt; {
    <span class="kw">fn </span>from(value: <span class="prelude-ty">Result</span>&lt;T, CargoMakeError&gt;) -&gt; <span class="self">Self </span>{
        <span class="kw">match </span>value {
            <span class="prelude-val">Ok</span>(val) =&gt; SuccessOrCargoMakeError::Ok(val),
            <span class="prelude-val">Err</span>(error) =&gt; SuccessOrCargoMakeError::Err(error),
        }
    }
}

<span class="comment">// Can't use `Result` because
// [E0117] Only traits defined in the current crate can be implemented for arbitrary types
</span><span class="kw">impl</span>&lt;T: std::any::Any&gt; std::process::Termination <span class="kw">for </span>SuccessOrCargoMakeError&lt;T&gt; {
    <span class="kw">fn </span>report(<span class="self">self</span>) -&gt; std::process::ExitCode {
        <span class="kw">const </span>PROCESS_EXIT_CODE: <span class="kw">fn</span>(i32) -&gt; std::process::ExitCode = |e: i32| {
            <span class="kw">if </span>e &gt; u8::MAX <span class="kw">as </span>i32 {
                <span class="macro">eprintln!</span>(<span class="string">"exit code {}"</span>, e);
                std::process::ExitCode::FAILURE
            } <span class="kw">else </span>{
                std::process::ExitCode::from(e <span class="kw">as </span>u8)
            }
        };

        <span class="kw">match </span><span class="self">self </span>{
            SuccessOrCargoMakeError::Ok(e)
                <span class="kw">if </span>std::any::TypeId::of::&lt;T&gt;()
                    == std::any::TypeId::of::&lt;std::process::ExitCode&gt;() =&gt;
            {
                <span class="kw-2">*</span>(<span class="kw-2">&amp;</span>e <span class="kw">as </span><span class="kw-2">&amp;</span><span class="kw">dyn </span>std::any::Any)
                    .downcast_ref::&lt;std::process::ExitCode&gt;()
                    .unwrap()
            }
            SuccessOrCargoMakeError::Ok(<span class="kw">_</span>) =&gt; std::process::ExitCode::SUCCESS,
            SuccessOrCargoMakeError::Err(err) =&gt; <span class="kw">match </span>err {
                CargoMakeError::StdIoError { error } <span class="kw">if </span>error.raw_os_error().is_some() =&gt; {
                    <span class="kw">let </span>e = <span class="kw">unsafe </span>{ error.raw_os_error().unwrap_unchecked() };
                    <span class="macro">eprintln!</span>(<span class="string">"{}"</span>, e.to_string());
                    PROCESS_EXIT_CODE(e)
                }
                CargoMakeError::ExitCode(error) =&gt; error,
                <span class="kw">_ </span>=&gt; {
                    <span class="macro">eprintln!</span>(<span class="string">"{}"</span>, err.to_string());
                    PROCESS_EXIT_CODE(err.discriminant() <span class="kw">as </span>i32)
                }
            },
        }
    }
}
</code></pre></div></section></main></body></html>