mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-26 19:58:50 +01:00
25 lines
6.2 KiB
HTML
25 lines
6.2 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="Print f64 to the given buffer and return number of bytes written."><title>format64 in ryu::raw - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="ryu" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../ryu/index.html">ryu</a><span class="version">1.0.15</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In ryu::raw</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../ryu/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">ryu</a>::<wbr><a href="index.html">raw</a>::<wbr><a class="fn" href="#">format64</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/ryu/pretty/mod.rs.html#52-118">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub unsafe fn format64(f: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.f64.html">f64</a>, result: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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>
|
||
<h3 id="special-cases"><a href="#special-cases">Special cases</a></h3>
|
||
<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>
|
||
<h3 id="safety"><a href="#safety">Safety</a></h3>
|
||
<p>The <code>result</code> pointer argument must point to sufficiently many writable bytes
|
||
to hold Ryū’s representation of <code>f</code>.</p>
|
||
<h3 id="example"><a href="#example">Example</a></h3>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::{mem::MaybeUninit, slice, str};
|
||
|
||
<span class="kw">let </span>f = <span class="number">1.234f64</span>;
|
||
|
||
<span class="kw">unsafe </span>{
|
||
<span class="kw">let </span><span class="kw-2">mut </span>buffer = [MaybeUninit::<u8>::uninit(); <span class="number">24</span>];
|
||
<span class="kw">let </span>len = ryu::raw::format64(f, buffer.as_mut_ptr() <span class="kw">as </span><span class="kw-2">*mut </span>u8);
|
||
<span class="kw">let </span>slice = slice::from_raw_parts(buffer.as_ptr() <span class="kw">as </span><span class="kw-2">*const </span>u8, len);
|
||
<span class="kw">let </span>print = str::from_utf8_unchecked(slice);
|
||
<span class="macro">assert_eq!</span>(print, <span class="string">"1.234"</span>);
|
||
}</code></pre></div>
|
||
</div></details></section></div></main></body></html> |