37 lines
13 KiB
HTML
37 lines
13 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 rounding or truncating a DateTime by a Duration."><meta name="keywords" content="rust, rustlang, rust-lang, DurationRound"><title>DurationRound 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 DurationRound</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#associated-types">Associated Types</a></h3><div class="sidebar-links"><a href="#associatedtype.Err">Err</a></div><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.duration_round">duration_round</a><a href="#tymethod.duration_trunc">duration_trunc</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="DurationRound" 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="#">DurationRound</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#102-144" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait DurationRound: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
type <a href="#associatedtype.Err" class="associatedtype">Err</a>: <a class="trait" href="https://doc.rust-lang.org/1.59.0/std/error/trait.Error.html" title="trait std::error::Error">Error</a>;
|
||
fn <a href="#tymethod.duration_round" class="fnname">duration_round</a>(self, duration: <a class="struct" href="struct.Duration.html" title="struct chrono::Duration">Duration</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="associatedtype" href="trait.DurationRound.html#associatedtype.Err" title="type chrono::DurationRound::Err">Err</a>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.duration_trunc" class="fnname">duration_trunc</a>(self, duration: <a class="struct" href="struct.Duration.html" title="struct chrono::Duration">Duration</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="associatedtype" href="trait.DurationRound.html#associatedtype.Err" title="type chrono::DurationRound::Err">Err</a>>;
|
||
}</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 rounding or truncating a DateTime by a Duration.</p>
|
||
<h2 id="limitations" class="section-header"><a href="#limitations">Limitations</a></h2>
|
||
<p>Both rounding and truncating are done via <a href="struct.Duration.html#method.num_nanoseconds" title="Duration::num_nanoseconds"><code>Duration::num_nanoseconds</code></a> and
|
||
<a href="struct.DateTime.html#method.timestamp_nanos" title="DateTime::timestamp_nanos"><code>DateTime::timestamp_nanos</code></a>. This means that they will fail if either the
|
||
<code>Duration</code> or the <code>DateTime</code> are too big to represented as nanoseconds. They
|
||
will also fail if the <code>Duration</code> is bigger than the timestamp.</p>
|
||
</div></details><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Err" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/chrono/round.rs.html#105" title="goto source code">[src]</a></div><h4 class="code-header">type <a href="#associatedtype.Err" class="associatedtype">Err</a>: <a class="trait" href="https://doc.rust-lang.org/1.59.0/std/error/trait.Error.html" title="trait std::error::Error">Error</a></h4></div></summary><div class="docblock"><p>Error that can occur in rounding or truncating</p>
|
||
</div></details></div><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.duration_round" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/chrono/round.rs.html#126" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.duration_round" class="fnname">duration_round</a>(self, duration: <a class="struct" href="struct.Duration.html" title="struct chrono::Duration">Duration</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="associatedtype" href="trait.DurationRound.html#associatedtype.Err" title="type chrono::DurationRound::Err">Err</a>></h4></div></summary><div class="docblock"><p>Return a copy rounded by Duration.</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">duration_round</span>(<span class="ident">Duration::milliseconds</span>(<span class="number">10</span>)).<span class="ident">unwrap</span>().<span class="ident">to_string</span>(),
|
||
<span class="string">"2018-01-11 12:00:00.150 UTC"</span>
|
||
);
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">dt</span>.<span class="ident">duration_round</span>(<span class="ident">Duration::days</span>(<span class="number">1</span>)).<span class="ident">unwrap</span>().<span class="ident">to_string</span>(),
|
||
<span class="string">"2018-01-12 00:00:00 UTC"</span>
|
||
);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.duration_trunc" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/chrono/round.rs.html#143" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.duration_trunc" class="fnname">duration_trunc</a>(self, duration: <a class="struct" href="struct.Duration.html" title="struct chrono::Duration">Duration</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="associatedtype" href="trait.DurationRound.html#associatedtype.Err" title="type chrono::DurationRound::Err">Err</a>></h4></div></summary><div class="docblock"><p>Return a copy truncated by Duration.</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">duration_trunc</span>(<span class="ident">Duration::milliseconds</span>(<span class="number">10</span>)).<span class="ident">unwrap</span>().<span class="ident">to_string</span>(),
|
||
<span class="string">"2018-01-11 12:00:00.150 UTC"</span>
|
||
);
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">dt</span>.<span class="ident">duration_trunc</span>(<span class="ident">Duration::days</span>(<span class="number">1</span>)).<span class="ident">unwrap</span>().<span class="ident">to_string</span>(),
|
||
<span class="string">"2018-01-11 00:00:00 UTC"</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"><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-DurationRound" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/chrono/round.rs.html#149-200" title="goto source code">[src]</a></div><a href="#impl-DurationRound" class="anchor"></a><h3 class="code-header in-band">impl<Tz: <a class="trait" href="offset/trait.TimeZone.html" title="trait chrono::offset::TimeZone">TimeZone</a>> <a class="trait" href="trait.DurationRound.html" title="trait chrono::DurationRound">DurationRound</a> for <a class="struct" href="struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Tz></h3></div></summary><div class="impl-items"><div id="associatedtype.Err-1" class="type trait-impl has-srclink"><a href="#associatedtype.Err-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Err" class="associatedtype">Err</a> = <a class="enum" href="enum.RoundingError.html" title="enum chrono::RoundingError">RoundingError</a></h4></div></div></details></div><script type="text/javascript" src="../implementors/chrono/trait.DurationRound.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> |