<!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/cli_commands/print_steps.rs`."><title>print_steps.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/cli_commands/</div>print_steps.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></pre></div><pre class="rust"><code><span class="doccomment">//! # print_steps
//!
//! Prints the execution plan in multiple formats.
//!
</span><span class="attr">#[cfg(test)]
#[path = <span class="string">"print_steps_test.rs"</span>]
</span><span class="kw">mod </span>print_steps_test;
<span class="kw">use </span><span class="kw">crate</span>::error::CargoMakeError;
<span class="kw">use </span>std::io;
<span class="kw">use </span><span class="kw">crate</span>::execution_plan::ExecutionPlanBuilder;
<span class="kw">use </span><span class="kw">crate</span>::types::{Config, CrateInfo, ExecutionPlan};
<span class="kw">use </span>regex::Regex;
<span class="attr">#[derive(Debug)]
</span><span class="kw">enum </span>PrintFormat {
<span class="doccomment">/// The default format
</span>Default,
<span class="doccomment">/// Prints a short description of the task
</span>ShortDescription,
}
<span class="kw">impl </span>PartialEq <span class="kw">for </span>PrintFormat {
<span class="kw">fn </span>eq(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span>PrintFormat) -> bool {
<span class="kw">match </span><span class="self">self </span>{
PrintFormat::Default => <span class="kw">match </span>other {
PrintFormat::Default => <span class="bool-val">true</span>,
<span class="kw">_ </span>=> <span class="bool-val">false</span>,
},
PrintFormat::ShortDescription => <span class="kw">match </span>other {
PrintFormat::ShortDescription => <span class="bool-val">true</span>,
<span class="kw">_ </span>=> <span class="bool-val">false</span>,
},
}
}
}
<span class="kw">fn </span>get_format_type(output_format: <span class="kw-2">&</span>str) -> PrintFormat {
<span class="kw">if </span>output_format == <span class="string">"short-description" </span>{
PrintFormat::ShortDescription
} <span class="kw">else </span>{
PrintFormat::Default
}
}
<span class="kw">fn </span>print_short_description(
output_buffer: <span class="kw-2">&mut </span><span class="kw">impl </span>io::Write,
execution_plan: <span class="kw-2">&</span>ExecutionPlan,
) -> io::Result<()> {
<span class="kw">let </span><span class="kw-2">mut </span>counter = <span class="number">1</span>;
<span class="kw">for </span>step <span class="kw">in </span><span class="kw-2">&</span>execution_plan.steps {
<span class="kw">let </span>task = <span class="kw-2">&</span>step.config;
<span class="kw">let </span>description = <span class="kw">match </span><span class="kw-2">&</span>task.description {
<span class="prelude-val">Some</span>(value) => value,
<span class="prelude-val">None </span>=> <span class="string">"no description"</span>,
};
<span class="macro">writeln!</span>(
output_buffer,
<span class="string">"{}. {} - {}"</span>,
counter, <span class="kw-2">&</span>step.name, <span class="kw-2">&</span>description
)<span class="question-mark">?</span>;
counter = counter + <span class="number">1</span>;
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>print_default(
output_buffer: <span class="kw-2">&mut </span><span class="kw">impl </span>io::Write,
execution_plan: <span class="kw-2">&</span>ExecutionPlan,
) -> io::Result<()> {
<span class="macro">writeln!</span>(output_buffer, <span class="string">"{:#?}"</span>, <span class="kw-2">&</span>execution_plan)
}
<span class="doccomment">/// Only prints the execution plan
</span><span class="kw">pub fn </span>print(
output_buffer: <span class="kw-2">&mut </span><span class="kw">impl </span>io::Write,
config: <span class="kw-2">&</span>Config,
task: <span class="kw-2">&</span>str,
output_format: <span class="kw-2">&</span>str,
disable_workspace: bool,
skip_tasks_pattern: <span class="kw-2">&</span><span class="prelude-ty">Option</span><String>,
crateinfo: <span class="kw-2">&</span>CrateInfo,
skip_init_end_tasks: bool,
) -> <span class="prelude-ty">Result</span><(), CargoMakeError> {
<span class="kw">let </span>skip_tasks_pattern_regex = <span class="kw">match </span>skip_tasks_pattern {
<span class="prelude-val">Some</span>(<span class="kw-2">ref </span>pattern) => <span class="kw">match </span>Regex::new(pattern) {
<span class="prelude-val">Ok</span>(reg) => <span class="prelude-val">Some</span>(reg),
<span class="prelude-val">Err</span>(<span class="kw">_</span>) => {
<span class="macro">warn!</span>(<span class="string">"Invalid skip tasks pattern provided: {}"</span>, pattern);
<span class="prelude-val">None
</span>}
},
<span class="prelude-val">None </span>=> <span class="prelude-val">None</span>,
};
<span class="kw">let </span>execution_plan = ExecutionPlanBuilder {
crate_info: <span class="prelude-val">Some</span>(crateinfo),
disable_workspace,
skip_tasks_pattern: skip_tasks_pattern_regex.as_ref(),
skip_init_end_tasks,
..ExecutionPlanBuilder::new(<span class="kw-2">&</span>config, <span class="kw-2">&</span>task)
}
.build()<span class="question-mark">?</span>;
<span class="macro">debug!</span>(<span class="string">"Created execution plan: {:#?}"</span>, <span class="kw-2">&</span>execution_plan);
<span class="kw">let </span>print_format = get_format_type(<span class="kw-2">&</span>output_format);
<span class="kw">match </span>print_format {
PrintFormat::ShortDescription => print_short_description(output_buffer, <span class="kw-2">&</span>execution_plan)<span class="question-mark">?</span>,
PrintFormat::Default => print_default(output_buffer, <span class="kw-2">&</span>execution_plan)<span class="question-mark">?</span>,
};
<span class="prelude-val">Ok</span>(())
}
</code></pre></div></section></main></body></html>