mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-26 19:02:13 +00:00
24 lines
6.9 KiB
HTML
24 lines
6.9 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 `format64` fn in crate `ryu`."><meta name="keywords" content="rust, rustlang, rust-lang, format64"><title>ryu::raw::format64 - 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 fn"><!--[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='../../ryu/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='../index.html'>ryu</a>::<wbr><a href='index.html'>raw</a></p><script>window.sidebarCurrent = {name: 'format64', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></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 js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" 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/ryu/pretty/mod.rs.html#53-119' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../index.html'>ryu</a>::<wbr><a href='index.html'>raw</a>::<wbr><a class="fn" href=''>format64</a></span></h1><pre class='rust fn'><span class="docblock attributes">#[must_use]
|
|||
|
|
</span>pub unsafe fn format64(f: f64, result: *mut u8) -> usize</pre><div class='docblock'><p>Print f64 to the given buffer and return number of bytes written.</p>
|
|||
|
|
<p>At most 24 bytes will be written.</p>
|
|||
|
|
<h2 id="special-cases" class="section-header"><a href="#special-cases">Special cases</a></h2>
|
|||
|
|
<p>This function <strong>does not</strong> 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.</p>
|
|||
|
|
<p>Please check <a href="https://doc.rust-lang.org/std/primitive.f64.html#method.is_finite"><code>is_finite</code></a> yourself before calling this function, or
|
|||
|
|
check <a href="https://doc.rust-lang.org/std/primitive.f64.html#method.is_nan"><code>is_nan</code></a> and <a href="https://doc.rust-lang.org/std/primitive.f64.html#method.is_infinite"><code>is_infinite</code></a> and handle those cases yourself.</p>
|
|||
|
|
<h2 id="safety" class="section-header"><a href="#safety">Safety</a></h2>
|
|||
|
|
<p>The <code>result</code> pointer argument must point to sufficiently many writable bytes
|
|||
|
|
to hold Ryū's representation of <code>f</code>.</p>
|
|||
|
|
<h2 id="example" class="section-header"><a href="#example">Example</a></h2>
|
|||
|
|
<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">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="number">1.234f64</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">unsafe</span> {
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buffer</span>: [<span class="ident">u8</span>; <span class="number">24</span>] <span class="op">=</span> <span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">uninitialized</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="ident">ryu</span>::<span class="ident">raw</span>::<span class="ident">format64</span>(<span class="ident">f</span>, <span class="ident">buffer</span>.<span class="ident">as_mut_ptr</span>());
|
|||
|
|
<span class="kw">let</span> <span class="ident">slice</span> <span class="op">=</span> <span class="ident">std</span>::<span class="ident">slice</span>::<span class="ident">from_raw_parts</span>(<span class="ident">buffer</span>.<span class="ident">as_ptr</span>(), <span class="ident">len</span>);
|
|||
|
|
<span class="kw">let</span> <span class="ident">print</span> <span class="op">=</span> <span class="ident">std</span>::<span class="ident">str</span>::<span class="ident">from_utf8_unchecked</span>(<span class="ident">slice</span>);
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">print</span>, <span class="string">"1.234"</span>);
|
|||
|
|
}</pre></div>
|
|||
|
|
</div></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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse 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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "ryu";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|