31 lines
6.4 KiB
HTML
31 lines
6.4 KiB
HTML
<!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="API documentation for the Rust `dtoa` crate."><meta name="keywords" content="rust, rustlang, rust-lang, dtoa"><title>dtoa - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../dtoa/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate dtoa</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all dtoa's items</p></a><div class="block items"><ul><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'dtoa', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/dtoa/lib.rs.html#1-182' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>dtoa</a></span></h1><div class='docblock'><p>This crate provides fast functions for printing floating-point primitives to
|
||
an <a href="https://doc.rust-lang.org/std/io/trait.Write.html"><code>io::Write</code></a>. The implementation is a straightforward Rust port of <a href="https://github.com/miloyip">Milo
|
||
Yip</a>'s C++ implementation <a href="https://github.com/miloyip/rapidjson/blob/master/include/rapidjson/internal/dtoa.h">dtoa.h</a>. The original C++ code of each function
|
||
is included in comments.</p>
|
||
<p>See also <a href="https://github.com/dtolnay/itoa"><code>itoa</code></a> for printing integer primitives.</p>
|
||
<br>
|
||
<h2 id="performance-lower-is-better" class="section-header"><a href="#performance-lower-is-better">Performance (lower is better)</a></h2>
|
||
<p><img src="https://raw.githubusercontent.com/dtolnay/dtoa/master/performance.png" alt="performance" /></p>
|
||
<br>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class='information'><div class='tooltip edition'>ⓘ<span class='tooltiptext'>This code runs with edition 2018</span></div></div><div class="example-wrap"><pre class="rust rust-example-rendered edition ">
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
<span class="comment">// Write to a vector or other io::Write.</span>
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">new</span>();
|
||
<span class="ident">dtoa</span>::<span class="ident">write</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>, <span class="number">2.71828f64</span>)<span class="question-mark">?</span>;
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">buf</span>);
|
||
|
||
<span class="comment">// Write to a stack buffer.</span>
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">bytes</span> <span class="op">=</span> [<span class="string">b'\0'</span>; <span class="number">20</span>];
|
||
<span class="kw">let</span> <span class="ident">n</span> <span class="op">=</span> <span class="ident">dtoa</span>::<span class="ident">write</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">bytes</span>[..], <span class="number">2.71828f64</span>)<span class="question-mark">?</span>;
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="kw-2">&</span><span class="ident">bytes</span>[..<span class="ident">n</span>]);
|
||
|
||
<span class="prelude-val">Ok</span>(())
|
||
}</pre></div>
|
||
</div><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table><tr class='module-item'><td><a class="trait" href="trait.Floating.html" title='dtoa::Floating trait'>Floating</a></td><td class='docblock-short'><p>An floating point number that can be formatted by <code>dtoa::write</code>.</p>
|
||
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table><tr class='module-item'><td><a class="fn" href="fn.write.html" title='dtoa::write fn'>write</a></td><td class='docblock-short'><p>Write float to an <code>io::Write</code>.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "dtoa";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |