<!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 to the Rust file `src/installer.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>installer.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</head>
<body class="rustdoc source">
<nav class="sidebar">
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><pre class="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>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
</pre><pre class="rust ">
<span class="doccomment">//! # installer</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Installs external dependencies for tasks.<br></span>
<span class="doccomment">//! There are 2 types of dependencies: install_crate, install_script.<br></span>
<span class="doccomment">//! install_crate ensures the crate command is available and if not installs the crate based on the provided name.<br></span>
<span class="doccomment">//! install_script always gets executed before the task command.</span>
<span class="doccomment">//!</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"./installer_test.rs"</span>]</span>
<span class="kw">mod</span> <span class="ident">installer_test</span>;
<span class="kw">use</span> <span class="ident">command</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">process</span>::<span class="ident">Command</span>;
<span class="kw">use</span> <span class="ident">types</span>::<span class="ident">Task</span>;
<span class="kw">fn</span> <span class="ident">is_crate_installed</span>(<span class="ident">crate_name</span>: <span class="kw-2">&</span><span class="ident">str</span>) <span class="op">-></span> <span class="ident">bool</span> {
<span class="macro">debug</span><span class="macro">!</span>(<span class="string">"Getting list of installed cargo commands."</span>);
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command</span>::<span class="ident">new</span>(<span class="string">"cargo"</span>).<span class="ident">arg</span>(<span class="string">"--list"</span>).<span class="ident">output</span>();
<span class="kw">match</span> <span class="ident">result</span> {
<span class="prelude-val">Ok</span>(<span class="ident">output</span>) <span class="op">=></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">found</span> <span class="op">=</span> <span class="bool-val">false</span>;
<span class="kw">let</span> <span class="ident">exit_code</span> <span class="op">=</span> <span class="ident">command</span>::<span class="ident">get_exit_code</span>(<span class="prelude-val">Ok</span>(<span class="ident">output</span>.<span class="ident">status</span>), <span class="bool-val">false</span>);
<span class="ident">command</span>::<span class="ident">validate_exit_code</span>(<span class="ident">exit_code</span>);
<span class="kw">let</span> <span class="ident">stdout</span> <span class="op">=</span> <span class="ident">String</span>::<span class="ident">from_utf8_lossy</span>(<span class="kw-2">&</span><span class="ident">output</span>.<span class="ident">stdout</span>);
<span class="kw">let</span> <span class="ident">lines</span>: <span class="ident">Vec</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> <span class="op">=</span> <span class="ident">stdout</span>.<span class="ident">split</span>(<span class="string">' '</span>).<span class="ident">collect</span>();
<span class="kw">for</span> <span class="kw-2">mut</span> <span class="ident">line</span> <span class="kw">in</span> <span class="ident">lines</span> {
<span class="ident">line</span> <span class="op">=</span> <span class="ident">line</span>.<span class="ident">trim</span>();
<span class="macro">debug</span><span class="macro">!</span>(<span class="string">"Checking: {}"</span>, <span class="kw-2">&</span><span class="ident">line</span>);
<span class="kw">if</span> <span class="ident">line</span>.<span class="ident">contains</span>(<span class="ident">crate_name</span>) <span class="op">&&</span> <span class="ident">crate_name</span>.<span class="ident">contains</span>(<span class="ident">line</span>) {
<span class="ident">found</span> <span class="op">=</span> <span class="bool-val">true</span>;
<span class="macro">debug</span><span class="macro">!</span>(<span class="string">"Found installed crate."</span>);
<span class="kw">break</span>;
}
}
<span class="ident">found</span>
}
<span class="prelude-val">Err</span>(<span class="ident">error</span>) <span class="op">=></span> {
<span class="macro">error</span><span class="macro">!</span>(<span class="string">"Unable to check if crate is installed: {} {:#?}"</span>, <span class="ident">crate_name</span>, <span class="kw-2">&</span><span class="ident">error</span>);
<span class="bool-val">false</span>
}
}
}
<span class="kw">fn</span> <span class="ident">get_install_crate_args</span>(
<span class="ident">crate_name</span>: <span class="kw-2">&</span><span class="ident">str</span>,
<span class="ident">args</span>: <span class="kw-2">&</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">String</span><span class="op">>></span>,
) <span class="op">-></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">install_args</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="string">"install"</span>.<span class="ident">to_string</span>()];
<span class="kw">match</span> <span class="kw-2">*</span><span class="ident">args</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">args_vec</span>) <span class="op">=></span> {
<span class="kw">for</span> <span class="ident">arg</span> <span class="kw">in</span> <span class="ident">args_vec</span>.<span class="ident">iter</span>() {
<span class="ident">install_args</span>.<span class="ident">push</span>(<span class="ident">arg</span>.<span class="ident">to_string</span>());
}
}
<span class="prelude-val">None</span> <span class="op">=></span> <span class="macro">debug</span><span class="macro">!</span>(<span class="string">"No crate installation args defined."</span>),
};
<span class="ident">install_args</span>.<span class="ident">push</span>(<span class="ident">crate_name</span>.<span class="ident">to_string</span>());
<span class="ident">install_args</span>
}
<span class="kw">fn</span> <span class="ident">install_crate</span>(
<span class="ident">cargo_command</span>: <span class="kw-2">&</span><span class="ident">str</span>,
<span class="ident">crate_name</span>: <span class="kw-2">&</span><span class="ident">str</span>,
<span class="ident">args</span>: <span class="kw-2">&</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">String</span><span class="op">>></span>,
<span class="ident">validate</span>: <span class="ident">bool</span>,
) {
<span class="kw">if</span> <span class="op">!</span><span class="ident">is_crate_installed</span>(<span class="ident">cargo_command</span>) {
<span class="kw">let</span> <span class="ident">install_args</span> <span class="op">=</span> <span class="ident">get_install_crate_args</span>(<span class="ident">crate_name</span>, <span class="ident">args</span>);
<span class="ident">command</span>::<span class="ident">run_command</span>(<span class="string">"cargo"</span>, <span class="kw-2">&</span><span class="prelude-val">Some</span>(<span class="ident">install_args</span>), <span class="ident">validate</span>);
}
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">install</span>(<span class="ident">task_config</span>: <span class="kw-2">&</span><span class="ident">Task</span>) {
<span class="kw">let</span> <span class="ident">validate</span> <span class="op">=</span> <span class="op">!</span><span class="ident">task_config</span>.<span class="ident">is_force</span>();
<span class="kw">match</span> <span class="ident">task_config</span>.<span class="ident">install_crate</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">crate_name</span>) <span class="op">=></span> {
<span class="kw">let</span> <span class="ident">cargo_command</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">task_config</span>.<span class="ident">args</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">args</span>) <span class="op">=></span> <span class="kw-2">&</span><span class="ident">args</span>[<span class="number">0</span>],
<span class="prelude-val">None</span> <span class="op">=></span> {
<span class="macro">error</span><span class="macro">!</span>(<span class="string">"Missing cargo command to invoke."</span>);
<span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Missing cargo command to invoke."</span>);
}
};
<span class="ident">install_crate</span>(<span class="ident">cargo_command</span>, <span class="ident">crate_name</span>, <span class="kw-2">&</span><span class="ident">task_config</span>.<span class="ident">install_crate_args</span>, <span class="ident">validate</span>);
}
<span class="prelude-val">None</span> <span class="op">=></span> {
<span class="kw">match</span> <span class="ident">task_config</span>.<span class="ident">install_script</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">script</span>) <span class="op">=></span> {
<span class="ident">command</span>::<span class="ident">run_script</span>(<span class="kw-2">&</span><span class="ident">script</span>, <span class="ident">task_config</span>.<span class="ident">script_runner</span>.<span class="ident">clone</span>(), <span class="ident">validate</span>);
()
}
<span class="prelude-val">None</span> <span class="op">=></span> {
<span class="kw">match</span> <span class="ident">task_config</span>.<span class="ident">command</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">command</span>) <span class="op">=></span> {
<span class="kw">if</span> <span class="ident">command</span> <span class="op">==</span> <span class="string">"cargo"</span> {
<span class="kw">match</span> <span class="ident">task_config</span>.<span class="ident">args</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">args</span>) <span class="op">=></span> {
<span class="comment">// create crate name</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">crate_name</span> <span class="op">=</span> <span class="string">"cargo-"</span>.<span class="ident">to_string</span>();
<span class="ident">crate_name</span> <span class="op">=</span> <span class="ident">crate_name</span> <span class="op">+</span> <span class="kw-2">&</span><span class="ident">args</span>[<span class="number">0</span>];
<span class="ident">install_crate</span>(<span class="kw-2">&</span><span class="ident">args</span>[<span class="number">0</span>], <span class="kw-2">&</span><span class="ident">crate_name</span>, <span class="kw-2">&</span><span class="ident">task_config</span>.<span class="ident">install_crate_args</span>, <span class="ident">validate</span>);
}
<span class="prelude-val">None</span> <span class="op">=></span> <span class="macro">debug</span><span class="macro">!</span>(<span class="string">"No installation script defined."</span>),
}
}
}
<span class="prelude-val">None</span> <span class="op">=></span> <span class="macro">debug</span><span class="macro">!</span>(<span class="string">"No installation script defined."</span>),
}
}
}
}
}
}
</pre>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "cargo_make";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>