blob: 34f82e74f7cd91feddb43c298c23d29ab5c803e4 [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/ryu-1.0.13/src/pretty/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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="../../../ryu/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="../../../ryu/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>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
</pre><pre class="rust"><code><span class="kw">mod </span>exponent;
<span class="kw">mod </span>mantissa;
<span class="kw">use </span><span class="self">self</span>::exponent::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="self">self</span>::mantissa::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::common;
<span class="kw">use </span><span class="kw">crate</span>::d2s::{<span class="self">self</span>, <span class="kw-2">*</span>};
<span class="kw">use </span><span class="kw">crate</span>::f2s::<span class="kw-2">*</span>;
<span class="kw">use </span>core::ptr;
<span class="attribute">#[cfg(feature = <span class="string">&quot;no-panic&quot;</span>)]
</span><span class="kw">use </span>no_panic::no_panic;
<span class="doccomment">/// Print f64 to the given buffer and return number of bytes written.
///
/// At most 24 bytes will be written.
///
/// ## Special cases
///
/// This function **does not** check for NaN or infinity. If the input
/// number is not a finite float, the printed representation will be some
/// correctly formatted but unspecified numerical value.
///
/// Please check [`is_finite`] yourself before calling this function, or
/// check [`is_nan`] and [`is_infinite`] and handle those cases yourself.
///
/// [`is_finite`]: https://doc.rust-lang.org/std/primitive.f64.html#method.is_finite
/// [`is_nan`]: https://doc.rust-lang.org/std/primitive.f64.html#method.is_nan
/// [`is_infinite`]: https://doc.rust-lang.org/std/primitive.f64.html#method.is_infinite
///
/// ## Safety
///
/// The `result` pointer argument must point to sufficiently many writable bytes
/// to hold Ryū&#39;s representation of `f`.
///
/// ## Example
///
/// ```
/// use std::{mem::MaybeUninit, slice, str};
///
/// let f = 1.234f64;
///
/// unsafe {
/// let mut buffer = [MaybeUninit::&lt;u8&gt;::uninit(); 24];
/// let len = ryu::raw::format64(f, buffer.as_mut_ptr() as *mut u8);
/// let slice = slice::from_raw_parts(buffer.as_ptr() as *const u8, len);
/// let print = str::from_utf8_unchecked(slice);
/// assert_eq!(print, &quot;1.234&quot;);
/// }
/// ```
</span><span class="attribute">#[must_use]
#[cfg_attr(feature = <span class="string">&quot;no-panic&quot;</span>, no_panic)]
</span><span class="kw">pub unsafe fn </span>format64(f: f64, result: <span class="kw-2">*mut </span>u8) -&gt; usize {
<span class="kw">let </span>bits = f.to_bits();
<span class="kw">let </span>sign = ((bits &gt;&gt; (DOUBLE_MANTISSA_BITS + DOUBLE_EXPONENT_BITS)) &amp; <span class="number">1</span>) != <span class="number">0</span>;
<span class="kw">let </span>ieee_mantissa = bits &amp; ((<span class="number">1u64 </span>&lt;&lt; DOUBLE_MANTISSA_BITS) - <span class="number">1</span>);
<span class="kw">let </span>ieee_exponent =
(bits &gt;&gt; DOUBLE_MANTISSA_BITS) <span class="kw">as </span>u32 &amp; ((<span class="number">1u32 </span>&lt;&lt; DOUBLE_EXPONENT_BITS) - <span class="number">1</span>);
<span class="kw">let </span><span class="kw-2">mut </span>index = <span class="number">0isize</span>;
<span class="kw">if </span>sign {
<span class="kw-2">*</span>result = <span class="string">b&#39;-&#39;</span>;
index += <span class="number">1</span>;
}
<span class="kw">if </span>ieee_exponent == <span class="number">0 </span>&amp;&amp; ieee_mantissa == <span class="number">0 </span>{
ptr::copy_nonoverlapping(<span class="string">b&quot;0.0&quot;</span>.as_ptr(), result.offset(index), <span class="number">3</span>);
<span class="kw">return </span>sign <span class="kw">as </span>usize + <span class="number">3</span>;
}
<span class="kw">let </span>v = d2d(ieee_mantissa, ieee_exponent);
<span class="kw">let </span>length = d2s::decimal_length17(v.mantissa) <span class="kw">as </span>isize;
<span class="kw">let </span>k = v.exponent <span class="kw">as </span>isize;
<span class="kw">let </span>kk = length + k; <span class="comment">// 10^(kk-1) &lt;= v &lt; 10^kk
</span><span class="macro">debug_assert!</span>(k &gt;= -<span class="number">324</span>);
<span class="kw">if </span><span class="number">0 </span>&lt;= k &amp;&amp; kk &lt;= <span class="number">16 </span>{
<span class="comment">// 1234e7 -&gt; 12340000000.0
</span>write_mantissa_long(v.mantissa, result.offset(index + length));
<span class="kw">for </span>i <span class="kw">in </span>length..kk {
<span class="kw-2">*</span>result.offset(index + i) = <span class="string">b&#39;0&#39;</span>;
}
<span class="kw-2">*</span>result.offset(index + kk) = <span class="string">b&#39;.&#39;</span>;
<span class="kw-2">*</span>result.offset(index + kk + <span class="number">1</span>) = <span class="string">b&#39;0&#39;</span>;
index <span class="kw">as </span>usize + kk <span class="kw">as </span>usize + <span class="number">2
</span>} <span class="kw">else if </span><span class="number">0 </span>&lt; kk &amp;&amp; kk &lt;= <span class="number">16 </span>{
<span class="comment">// 1234e-2 -&gt; 12.34
</span>write_mantissa_long(v.mantissa, result.offset(index + length + <span class="number">1</span>));
ptr::copy(result.offset(index + <span class="number">1</span>), result.offset(index), kk <span class="kw">as </span>usize);
<span class="kw-2">*</span>result.offset(index + kk) = <span class="string">b&#39;.&#39;</span>;
index <span class="kw">as </span>usize + length <span class="kw">as </span>usize + <span class="number">1
</span>} <span class="kw">else if </span>-<span class="number">5 </span>&lt; kk &amp;&amp; kk &lt;= <span class="number">0 </span>{
<span class="comment">// 1234e-6 -&gt; 0.001234
</span><span class="kw-2">*</span>result.offset(index) = <span class="string">b&#39;0&#39;</span>;
<span class="kw-2">*</span>result.offset(index + <span class="number">1</span>) = <span class="string">b&#39;.&#39;</span>;
<span class="kw">let </span>offset = <span class="number">2 </span>- kk;
<span class="kw">for </span>i <span class="kw">in </span><span class="number">2</span>..offset {
<span class="kw-2">*</span>result.offset(index + i) = <span class="string">b&#39;0&#39;</span>;
}
write_mantissa_long(v.mantissa, result.offset(index + length + offset));
index <span class="kw">as </span>usize + length <span class="kw">as </span>usize + offset <span class="kw">as </span>usize
} <span class="kw">else if </span>length == <span class="number">1 </span>{
<span class="comment">// 1e30
</span><span class="kw-2">*</span>result.offset(index) = <span class="string">b&#39;0&#39; </span>+ v.mantissa <span class="kw">as </span>u8;
<span class="kw-2">*</span>result.offset(index + <span class="number">1</span>) = <span class="string">b&#39;e&#39;</span>;
index <span class="kw">as </span>usize + <span class="number">2 </span>+ write_exponent3(kk - <span class="number">1</span>, result.offset(index + <span class="number">2</span>))
} <span class="kw">else </span>{
<span class="comment">// 1234e30 -&gt; 1.234e33
</span>write_mantissa_long(v.mantissa, result.offset(index + length + <span class="number">1</span>));
<span class="kw-2">*</span>result.offset(index) = <span class="kw-2">*</span>result.offset(index + <span class="number">1</span>);
<span class="kw-2">*</span>result.offset(index + <span class="number">1</span>) = <span class="string">b&#39;.&#39;</span>;
<span class="kw-2">*</span>result.offset(index + length + <span class="number">1</span>) = <span class="string">b&#39;e&#39;</span>;
index <span class="kw">as </span>usize
+ length <span class="kw">as </span>usize
+ <span class="number">2
</span>+ write_exponent3(kk - <span class="number">1</span>, result.offset(index + length + <span class="number">2</span>))
}
}
<span class="doccomment">/// Print f32 to the given buffer and return number of bytes written.
///
/// At most 16 bytes will be written.
///
/// ## Special cases
///
/// This function **does not** check for NaN or infinity. If the input
/// number is not a finite float, the printed representation will be some
/// correctly formatted but unspecified numerical value.
///
/// Please check [`is_finite`] yourself before calling this function, or
/// check [`is_nan`] and [`is_infinite`] and handle those cases yourself.
///
/// [`is_finite`]: https://doc.rust-lang.org/std/primitive.f32.html#method.is_finite
/// [`is_nan`]: https://doc.rust-lang.org/std/primitive.f32.html#method.is_nan
/// [`is_infinite`]: https://doc.rust-lang.org/std/primitive.f32.html#method.is_infinite
///
/// ## Safety
///
/// The `result` pointer argument must point to sufficiently many writable bytes
/// to hold Ryū&#39;s representation of `f`.
///
/// ## Example
///
/// ```
/// use std::{mem::MaybeUninit, slice, str};
///
/// let f = 1.234f32;
///
/// unsafe {
/// let mut buffer = [MaybeUninit::&lt;u8&gt;::uninit(); 16];
/// let len = ryu::raw::format32(f, buffer.as_mut_ptr() as *mut u8);
/// let slice = slice::from_raw_parts(buffer.as_ptr() as *const u8, len);
/// let print = str::from_utf8_unchecked(slice);
/// assert_eq!(print, &quot;1.234&quot;);
/// }
/// ```
</span><span class="attribute">#[must_use]
#[cfg_attr(feature = <span class="string">&quot;no-panic&quot;</span>, no_panic)]
</span><span class="kw">pub unsafe fn </span>format32(f: f32, result: <span class="kw-2">*mut </span>u8) -&gt; usize {
<span class="kw">let </span>bits = f.to_bits();
<span class="kw">let </span>sign = ((bits &gt;&gt; (FLOAT_MANTISSA_BITS + FLOAT_EXPONENT_BITS)) &amp; <span class="number">1</span>) != <span class="number">0</span>;
<span class="kw">let </span>ieee_mantissa = bits &amp; ((<span class="number">1u32 </span>&lt;&lt; FLOAT_MANTISSA_BITS) - <span class="number">1</span>);
<span class="kw">let </span>ieee_exponent = (bits &gt;&gt; FLOAT_MANTISSA_BITS) &amp; ((<span class="number">1u32 </span>&lt;&lt; FLOAT_EXPONENT_BITS) - <span class="number">1</span>);
<span class="kw">let </span><span class="kw-2">mut </span>index = <span class="number">0isize</span>;
<span class="kw">if </span>sign {
<span class="kw-2">*</span>result = <span class="string">b&#39;-&#39;</span>;
index += <span class="number">1</span>;
}
<span class="kw">if </span>ieee_exponent == <span class="number">0 </span>&amp;&amp; ieee_mantissa == <span class="number">0 </span>{
ptr::copy_nonoverlapping(<span class="string">b&quot;0.0&quot;</span>.as_ptr(), result.offset(index), <span class="number">3</span>);
<span class="kw">return </span>sign <span class="kw">as </span>usize + <span class="number">3</span>;
}
<span class="kw">let </span>v = f2d(ieee_mantissa, ieee_exponent);
<span class="kw">let </span>length = common::decimal_length9(v.mantissa) <span class="kw">as </span>isize;
<span class="kw">let </span>k = v.exponent <span class="kw">as </span>isize;
<span class="kw">let </span>kk = length + k; <span class="comment">// 10^(kk-1) &lt;= v &lt; 10^kk
</span><span class="macro">debug_assert!</span>(k &gt;= -<span class="number">45</span>);
<span class="kw">if </span><span class="number">0 </span>&lt;= k &amp;&amp; kk &lt;= <span class="number">13 </span>{
<span class="comment">// 1234e7 -&gt; 12340000000.0
</span>write_mantissa(v.mantissa, result.offset(index + length));
<span class="kw">for </span>i <span class="kw">in </span>length..kk {
<span class="kw-2">*</span>result.offset(index + i) = <span class="string">b&#39;0&#39;</span>;
}
<span class="kw-2">*</span>result.offset(index + kk) = <span class="string">b&#39;.&#39;</span>;
<span class="kw-2">*</span>result.offset(index + kk + <span class="number">1</span>) = <span class="string">b&#39;0&#39;</span>;
index <span class="kw">as </span>usize + kk <span class="kw">as </span>usize + <span class="number">2
</span>} <span class="kw">else if </span><span class="number">0 </span>&lt; kk &amp;&amp; kk &lt;= <span class="number">13 </span>{
<span class="comment">// 1234e-2 -&gt; 12.34
</span>write_mantissa(v.mantissa, result.offset(index + length + <span class="number">1</span>));
ptr::copy(result.offset(index + <span class="number">1</span>), result.offset(index), kk <span class="kw">as </span>usize);
<span class="kw-2">*</span>result.offset(index + kk) = <span class="string">b&#39;.&#39;</span>;
index <span class="kw">as </span>usize + length <span class="kw">as </span>usize + <span class="number">1
</span>} <span class="kw">else if </span>-<span class="number">6 </span>&lt; kk &amp;&amp; kk &lt;= <span class="number">0 </span>{
<span class="comment">// 1234e-6 -&gt; 0.001234
</span><span class="kw-2">*</span>result.offset(index) = <span class="string">b&#39;0&#39;</span>;
<span class="kw-2">*</span>result.offset(index + <span class="number">1</span>) = <span class="string">b&#39;.&#39;</span>;
<span class="kw">let </span>offset = <span class="number">2 </span>- kk;
<span class="kw">for </span>i <span class="kw">in </span><span class="number">2</span>..offset {
<span class="kw-2">*</span>result.offset(index + i) = <span class="string">b&#39;0&#39;</span>;
}
write_mantissa(v.mantissa, result.offset(index + length + offset));
index <span class="kw">as </span>usize + length <span class="kw">as </span>usize + offset <span class="kw">as </span>usize
} <span class="kw">else if </span>length == <span class="number">1 </span>{
<span class="comment">// 1e30
</span><span class="kw-2">*</span>result.offset(index) = <span class="string">b&#39;0&#39; </span>+ v.mantissa <span class="kw">as </span>u8;
<span class="kw-2">*</span>result.offset(index + <span class="number">1</span>) = <span class="string">b&#39;e&#39;</span>;
index <span class="kw">as </span>usize + <span class="number">2 </span>+ write_exponent2(kk - <span class="number">1</span>, result.offset(index + <span class="number">2</span>))
} <span class="kw">else </span>{
<span class="comment">// 1234e30 -&gt; 1.234e33
</span>write_mantissa(v.mantissa, result.offset(index + length + <span class="number">1</span>));
<span class="kw-2">*</span>result.offset(index) = <span class="kw-2">*</span>result.offset(index + <span class="number">1</span>);
<span class="kw-2">*</span>result.offset(index + <span class="number">1</span>) = <span class="string">b&#39;.&#39;</span>;
<span class="kw-2">*</span>result.offset(index + length + <span class="number">1</span>) = <span class="string">b&#39;e&#39;</span>;
index <span class="kw">as </span>usize
+ length <span class="kw">as </span>usize
+ <span class="number">2
</span>+ write_exponent2(kk - <span class="number">1</span>, result.offset(index + length + <span class="number">2</span>))
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="ryu" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>