blob: b2c7f0b4e1d6a851621b73343d607d4a3aee5afa [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/measure_time-0.8.2/src/formatted_duration.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>formatted_duration.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="../../measure_time/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="../../measure_time/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>
<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>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::{fmt, time::Duration};
<span class="doccomment">/// A wrapper type that allows you to Display a Duration
</span><span class="attribute">#[derive(Debug, Clone)]
</span><span class="kw">pub struct </span>FormattedDuration(Duration);
<span class="kw">pub fn </span>format_duration(val: Duration) -&gt; FormattedDuration {
FormattedDuration(val)
}
<span class="kw">fn </span>item_plural(f: <span class="kw-2">&amp;mut </span>fmt::Formatter, started: <span class="kw-2">&amp;mut </span>bool, name: <span class="kw-2">&amp;</span>str, value: u64) -&gt; fmt::Result {
<span class="kw">if </span>value &gt; <span class="number">0 </span>{
<span class="kw">if </span><span class="kw-2">*</span>started {
f.write_str(<span class="string">&quot; &quot;</span>)<span class="question-mark">?</span>;
}
<span class="macro">write!</span>(f, <span class="string">&quot;{}{}&quot;</span>, value, name)<span class="question-mark">?</span>;
<span class="kw">if </span>value &gt; <span class="number">1 </span>{
f.write_str(<span class="string">&quot;s&quot;</span>)<span class="question-mark">?</span>;
}
<span class="kw-2">*</span>started = <span class="bool-val">true</span>;
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>item_ms(
f: <span class="kw-2">&amp;mut </span>fmt::Formatter,
started: <span class="kw-2">&amp;mut </span>bool,
name: <span class="kw-2">&amp;</span>str,
duration: Duration,
) -&gt; fmt::Result {
<span class="comment">// Three cases
// 1. Above 30seconds, we dont&#39; show ms anymore
// 2. Between 30sec and 1 sec we don&#39;t show rounded ms
// 3. Below we round to two digits
</span><span class="kw">if </span>Duration::new(<span class="number">30</span>, <span class="number">0</span>) &lt; duration {
<span class="kw">return </span><span class="prelude-val">Ok</span>(());
}
<span class="kw">if </span>Duration::new(<span class="number">1</span>, <span class="number">0</span>) &lt; duration {
<span class="kw">if </span><span class="kw-2">*</span>started {
f.write_str(<span class="string">&quot; &quot;</span>)<span class="question-mark">?</span>;
}
<span class="macro">write!</span>(f, <span class="string">&quot;{}{}&quot;</span>, duration.subsec_millis(), name)<span class="question-mark">?</span>;
<span class="kw-2">*</span>started = <span class="bool-val">true</span>;
<span class="kw">return </span><span class="prelude-val">Ok</span>(());
}
<span class="comment">//show rounded
</span><span class="kw">if </span><span class="kw-2">*</span>started {
f.write_str(<span class="string">&quot; &quot;</span>)<span class="question-mark">?</span>;
}
<span class="macro">write!</span>(
f,
<span class="string">&quot;{}{}&quot;</span>,
(duration.subsec_nanos() / <span class="number">10_000</span>) <span class="kw">as </span>f32 / <span class="number">100.</span>,
name
)<span class="question-mark">?</span>;
<span class="kw-2">*</span>started = <span class="bool-val">true</span>;
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>item(
f: <span class="kw-2">&amp;mut </span>fmt::Formatter,
started: <span class="kw-2">&amp;mut </span>bool,
name: <span class="kw-2">&amp;</span>str,
value: u32,
skip: bool,
) -&gt; fmt::Result {
<span class="kw">if </span>skip {
<span class="kw">return </span><span class="prelude-val">Ok</span>(());
}
<span class="kw">if </span>value &gt; <span class="number">0 </span>{
<span class="kw">if </span><span class="kw-2">*</span>started {
f.write_str(<span class="string">&quot; &quot;</span>)<span class="question-mark">?</span>;
}
<span class="macro">write!</span>(f, <span class="string">&quot;{}{}&quot;</span>, value, name)<span class="question-mark">?</span>;
<span class="kw-2">*</span>started = <span class="bool-val">true</span>;
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">const </span>ONE_MINUTE_IN_SECONDS: u64 = <span class="number">60</span>;
<span class="kw">const </span>ONE_HOURS_IN_SECONDS: u64 = ONE_MINUTE_IN_SECONDS * <span class="number">60</span>;
<span class="kw">const </span>ONE_DAY_IN_SECONDS: u64 = ONE_HOURS_IN_SECONDS * <span class="number">24</span>;
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>FormattedDuration {
<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">let </span>secs = <span class="self">self</span>.<span class="number">0</span>.as_secs();
<span class="kw">let </span>nanos = <span class="self">self</span>.<span class="number">0</span>.subsec_nanos();
<span class="kw">if </span>secs == <span class="number">0 </span>&amp;&amp; nanos == <span class="number">0 </span>{
f.write_str(<span class="string">&quot;0s&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">return </span><span class="prelude-val">Ok</span>(());
}
<span class="kw">let </span>years = secs / <span class="number">31_557_600</span>; <span class="comment">// 365.25d
</span><span class="kw">let </span>ydays = secs % <span class="number">31_557_600</span>;
<span class="kw">let </span>months = ydays / <span class="number">2_630_016</span>; <span class="comment">// 30.44d
</span><span class="kw">let </span>mdays = ydays % <span class="number">2_630_016</span>;
<span class="kw">let </span>days = mdays / <span class="number">86400</span>;
<span class="kw">let </span>day_secs = mdays % <span class="number">86400</span>;
<span class="kw">let </span>hours = day_secs / <span class="number">3600</span>;
<span class="kw">let </span>minutes = day_secs % <span class="number">3600 </span>/ <span class="number">60</span>;
<span class="kw">let </span>seconds = day_secs % <span class="number">60</span>;
<span class="kw">let </span>started = <span class="kw-2">&amp;mut </span><span class="bool-val">false</span>;
item_plural(f, started, <span class="string">&quot;year&quot;</span>, years)<span class="question-mark">?</span>;
item_plural(f, started, <span class="string">&quot;month&quot;</span>, months)<span class="question-mark">?</span>;
item_plural(f, started, <span class="string">&quot;day&quot;</span>, days)<span class="question-mark">?</span>;
item(
f,
started,
<span class="string">&quot;h&quot;</span>,
hours <span class="kw">as </span>u32,
<span class="self">self</span>.<span class="number">0 </span>&gt; Duration::from_secs(ONE_DAY_IN_SECONDS * <span class="number">30</span>), <span class="comment">// skip hours after 30 days
</span>)<span class="question-mark">?</span>;
item(
f,
started,
<span class="string">&quot;m&quot;</span>,
minutes <span class="kw">as </span>u32,
<span class="self">self</span>.<span class="number">0 </span>&gt; Duration::from_secs(ONE_DAY_IN_SECONDS), <span class="comment">// skip minutes after one day
</span>)<span class="question-mark">?</span>;
item(
f,
started,
<span class="string">&quot;s&quot;</span>,
seconds <span class="kw">as </span>u32,
<span class="self">self</span>.<span class="number">0 </span>&gt; Duration::from_secs(ONE_HOURS_IN_SECONDS * <span class="number">3</span>), <span class="comment">// skip seconds after one hour
</span>)<span class="question-mark">?</span>;
item_ms(f, started, <span class="string">&quot;ms&quot;</span>, <span class="self">self</span>.<span class="number">0</span>)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">pub fn </span>human_readable_time(duration: Duration) -&gt; String {
format_duration(duration).to_string()
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>human_readable_time_test() {
<span class="macro">assert_eq!</span>(
human_readable_time(Duration::new(<span class="number">5</span>, <span class="number">900_000_000</span>)),
<span class="string">&quot;5s 900ms&quot;
</span>);
<span class="macro">assert_eq!</span>(
human_readable_time(Duration::new(ONE_HOURS_IN_SECONDS + <span class="number">1</span>, <span class="number">900_123_000</span>)),
<span class="string">&quot;1h 1s&quot;
</span>);
<span class="macro">assert_eq!</span>(
human_readable_time(Duration::new(ONE_HOURS_IN_SECONDS - <span class="number">1</span>, <span class="number">900_123_000</span>)),
<span class="string">&quot;59m 59s&quot;
</span>);
<span class="macro">assert_eq!</span>(
human_readable_time(Duration::new(<span class="number">3 </span>* ONE_HOURS_IN_SECONDS + <span class="number">1</span>, <span class="number">900_123_000</span>)),
<span class="string">&quot;3h&quot;
</span>);
<span class="macro">assert_eq!</span>(
human_readable_time(Duration::new(<span class="number">5</span>, <span class="number">900_123_000</span>)),
<span class="string">&quot;5s 900ms&quot;
</span>);
<span class="macro">assert_eq!</span>(
human_readable_time(Duration::new(
ONE_HOURS_IN_SECONDS * <span class="number">10 </span>+ ONE_MINUTE_IN_SECONDS * <span class="number">10 </span>+ <span class="number">10</span>, <span class="comment">// don&#39;t print seconds
</span><span class="number">123
</span>)),
<span class="string">&quot;10h 10m&quot;
</span>);
<span class="macro">assert_eq!</span>(
human_readable_time(Duration::new(
ONE_HOURS_IN_SECONDS * <span class="number">10 </span>+ ONE_MINUTE_IN_SECONDS,
<span class="number">123
</span>)),
<span class="string">&quot;10h 1m&quot;
</span>);
<span class="macro">assert_eq!</span>(
human_readable_time(Duration::new(ONE_HOURS_IN_SECONDS * <span class="number">3 </span>+ <span class="number">10</span>, <span class="number">123</span>)),
<span class="string">&quot;3h&quot;
</span>);
<span class="macro">assert_eq!</span>(human_readable_time(Duration::new(<span class="number">0</span>, <span class="number">900_000</span>)), <span class="string">&quot;0.9ms&quot;</span>);
<span class="macro">assert_eq!</span>(human_readable_time(Duration::new(<span class="number">0</span>, <span class="number">950_000</span>)), <span class="string">&quot;0.95ms&quot;</span>);
<span class="macro">assert_eq!</span>(human_readable_time(Duration::new(<span class="number">0</span>, <span class="number">1_950_000</span>)), <span class="string">&quot;1.95ms&quot;</span>);
<span class="macro">assert_eq!</span>(human_readable_time(Duration::new(<span class="number">0</span>, <span class="number">1_950_000</span>)), <span class="string">&quot;1.95ms&quot;</span>);
<span class="macro">assert_eq!</span>(human_readable_time(Duration::new(<span class="number">0</span>, <span class="number">1_957_123</span>)), <span class="string">&quot;1.95ms&quot;</span>);
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="measure_time" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>