26 lines
10 KiB
HTML
26 lines
10 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="Extension trait for subsecond rounding or truncation to a maximum number of digits. Rounding can be used to decrease the error variance when serializing/persisting to lower precision. Truncation is the default behavior in Chrono display formatting. Either can be used to guarantee equality (e.g. for testing) when round-tripping through a lower precision format."><meta name="keywords" content="rust, rustlang, rust-lang, SubsecRound"><title>SubsecRound in chrono - Rust</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" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.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 trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../chrono/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Trait SubsecRound</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.round_subsecs">round_subsecs</a><a href="#tymethod.trunc_subsecs">trunc_subsecs</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="index.html">chrono</a></h2><div id="sidebar-vars" data-name="SubsecRound" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../chrono/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">chrono</a>::<wbr><a class="trait" href="#">SubsecRound</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><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/chrono/round.rs.html#21-46" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait SubsecRound {
|
||
fn <a href="#tymethod.round_subsecs" class="fnname">round_subsecs</a>(self, digits: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u16.html">u16</a>) -> Self;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.trunc_subsecs" class="fnname">trunc_subsecs</a>(self, digits: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u16.html">u16</a>) -> Self;
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extension trait for subsecond rounding or truncation to a maximum number
|
||
of digits. Rounding can be used to decrease the error variance when
|
||
serializing/persisting to lower precision. Truncation is the default
|
||
behavior in Chrono display formatting. Either can be used to guarantee
|
||
equality (e.g. for testing) when round-tripping through a lower precision
|
||
format.</p>
|
||
</div></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.round_subsecs" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/chrono/round.rs.html#33" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.round_subsecs" class="fnname">round_subsecs</a>(self, digits: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u16.html">u16</a>) -> Self</h4></div></summary><div class="docblock"><p>Return a copy rounded to the specified number of subsecond digits. With
|
||
9 or more digits, self is returned unmodified. Halfway values are
|
||
rounded up (away from zero).</p>
|
||
<h5 id="example" class="section-header"><a href="#example">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">dt</span> <span class="op">=</span> <span class="ident">Utc</span>.<span class="ident">ymd</span>(<span class="number">2018</span>, <span class="number">1</span>, <span class="number">11</span>).<span class="ident">and_hms_milli</span>(<span class="number">12</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">154</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">dt</span>.<span class="ident">round_subsecs</span>(<span class="number">2</span>).<span class="ident">nanosecond</span>(), <span class="number">150_000_000</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">dt</span>.<span class="ident">round_subsecs</span>(<span class="number">1</span>).<span class="ident">nanosecond</span>(), <span class="number">200_000_000</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.trunc_subsecs" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/chrono/round.rs.html#45" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.trunc_subsecs" class="fnname">trunc_subsecs</a>(self, digits: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u16.html">u16</a>) -> Self</h4></div></summary><div class="docblock"><p>Return a copy truncated to the specified number of subsecond
|
||
digits. With 9 or more digits, self is returned unmodified.</p>
|
||
<h5 id="example-1" class="section-header"><a href="#example-1">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">dt</span> <span class="op">=</span> <span class="ident">Utc</span>.<span class="ident">ymd</span>(<span class="number">2018</span>, <span class="number">1</span>, <span class="number">11</span>).<span class="ident">and_hms_milli</span>(<span class="number">12</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">154</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">dt</span>.<span class="ident">trunc_subsecs</span>(<span class="number">2</span>).<span class="ident">nanosecond</span>(), <span class="number">150_000_000</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">dt</span>.<span class="ident">trunc_subsecs</span>(<span class="number">1</span>).<span class="ident">nanosecond</span>(), <span class="number">100_000_000</span>);</code></pre></div>
|
||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><div id="impl-SubsecRound" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/chrono/round.rs.html#48-76" title="goto source code">[src]</a></div><a href="#impl-SubsecRound" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="trait.SubsecRound.html" title="trait chrono::SubsecRound">SubsecRound</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="trait.Timelike.html" title="trait chrono::Timelike">Timelike</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a><<a class="struct" href="struct.Duration.html" title="struct chrono::Duration">Duration</a>, Output = T> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/ops/arith/trait.Sub.html" title="trait core::ops::arith::Sub">Sub</a><<a class="struct" href="struct.Duration.html" title="struct chrono::Duration">Duration</a>, Output = T>, </span></h3></div></div><script type="text/javascript" src="../implementors/chrono/trait.SubsecRound.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="chrono" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |