blob: 702d451e2430463e9938311c06c663139f45f510 [file] [log] [blame]
<!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" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../chrono/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../chrono/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">DurationRound</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Err">Err</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.duration_round">duration_round</a></li><li><a href="#tymethod.duration_trunc">duration_trunc</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In chrono</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">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></h1><span class="out-of-band"><a class="srclink" href="../src/chrono/round.rs.html#101-143">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait DurationRound: Sized {
type <a href="#associatedtype.Err" class="associatedtype">Err</a>: Error;
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>) -&gt; Result&lt;Self, Self::<a class="associatedtype" href="trait.DurationRound.html#associatedtype.Err" title="type chrono::DurationRound::Err">Err</a>&gt;;
<span class="item-spacer"></span> 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>) -&gt; Result&lt;Self, Self::<a class="associatedtype" href="trait.DurationRound.html#associatedtype.Err" title="type chrono::DurationRound::Err">Err</a>&gt;;
}</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"><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="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Err" class="method has-srclink"><a class="srclink rightside" href="../src/chrono/round.rs.html#104">source</a><h4 class="code-header">type <a href="#associatedtype.Err" class="associatedtype">Err</a>: Error</h4></section></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 method-toggle" open><summary><section id="tymethod.duration_round" class="method has-srclink"><a class="srclink rightside" href="../src/chrono/round.rs.html#125">source</a><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>) -&gt; Result&lt;Self, Self::<a class="associatedtype" href="trait.DurationRound.html#associatedtype.Err" title="type chrono::DurationRound::Err">Err</a>&gt;</h4></section></summary><div class="docblock"><p>Return a copy rounded by Duration.</p>
<h5 id="example"><a href="#example">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>dt = NaiveDate::from_ymd_opt(<span class="number">2018</span>, <span class="number">1</span>, <span class="number">11</span>).unwrap().and_hms_milli_opt(<span class="number">12</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">154</span>).unwrap().and_local_timezone(Utc).unwrap();
<span class="macro">assert_eq!</span>(
dt.duration_round(Duration::milliseconds(<span class="number">10</span>)).unwrap().to_string(),
<span class="string">&quot;2018-01-11 12:00:00.150 UTC&quot;
</span>);
<span class="macro">assert_eq!</span>(
dt.duration_round(Duration::days(<span class="number">1</span>)).unwrap().to_string(),
<span class="string">&quot;2018-01-12 00:00:00 UTC&quot;
</span>);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.duration_trunc" class="method has-srclink"><a class="srclink rightside" href="../src/chrono/round.rs.html#142">source</a><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>) -&gt; Result&lt;Self, Self::<a class="associatedtype" href="trait.DurationRound.html#associatedtype.Err" title="type chrono::DurationRound::Err">Err</a>&gt;</h4></section></summary><div class="docblock"><p>Return a copy truncated by Duration.</p>
<h5 id="example-1"><a href="#example-1">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>dt = NaiveDate::from_ymd_opt(<span class="number">2018</span>, <span class="number">1</span>, <span class="number">11</span>).unwrap().and_hms_milli_opt(<span class="number">12</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">154</span>).unwrap().and_local_timezone(Utc).unwrap();
<span class="macro">assert_eq!</span>(
dt.duration_trunc(Duration::milliseconds(<span class="number">10</span>)).unwrap().to_string(),
<span class="string">&quot;2018-01-11 12:00:00.150 UTC&quot;
</span>);
<span class="macro">assert_eq!</span>(
dt.duration_trunc(Duration::days(<span class="number">1</span>)).unwrap().to_string(),
<span class="string">&quot;2018-01-11 00:00:00 UTC&quot;
</span>);</code></pre></div>
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-DurationRound-for-NaiveDateTime" class="impl has-srclink"><a class="srclink rightside" href="../src/chrono/round.rs.html#160-170">source</a><a href="#impl-DurationRound-for-NaiveDateTime" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.DurationRound.html" title="trait chrono::DurationRound">DurationRound</a> for <a class="struct" href="naive/struct.NaiveDateTime.html" title="struct chrono::naive::NaiveDateTime">NaiveDateTime</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Err-1" class="associatedtype 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></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-DurationRound-for-DateTime%3CTz%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/chrono/round.rs.html#148-158">source</a><a href="#impl-DurationRound-for-DateTime%3CTz%3E" class="anchor"></a><h3 class="code-header">impl&lt;Tz:&nbsp;<a class="trait" href="offset/trait.TimeZone.html" title="trait chrono::offset::TimeZone">TimeZone</a>&gt; <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>&lt;Tz&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Err-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Err-2" 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></section></div></details></div><script src="../implementors/chrono/round/trait.DurationRound.js" async></script></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.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>