OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-28 04:41:02 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
f4bb79d2d629ee5166f17b80ca2aa0e621d1c837
google-apis-rs/chrono/trait.DurationRound.html
Sebastian Thiel f4bb79d2d6 Update documentation
2024-03-05 21:06:01 +01:00

37 lines
13 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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."><title>DurationRound in chrono - 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="chrono" 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 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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../chrono/index.html">chrono</a><span class="version">0.4.31</span></h2></div><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="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate chrono</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="../chrono/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>Trait <a href="index.html">chrono</a>::<wbr><a class="trait" href="#">DurationRound</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/chrono/round.rs.html#101-143">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait DurationRound: <a class="trait" href="https://doc.rust-lang.org/1.76.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.76.0/core/error/trait.Error.html" title="trait core::error::Error">Error</a>;
// Required methods
fn <a href="#tymethod.duration_round" class="fn">duration_round</a>(self, duration: <a class="struct" href="struct.Duration.html" title="struct chrono::Duration">Duration</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&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="fn">duration_trunc</a>(self, duration: <a class="struct" href="struct.Duration.html" title="struct chrono::Duration">Duration</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, Self::<a class="associatedtype" href="trait.DurationRound.html#associatedtype.Err" title="type chrono::DurationRound::Err">Err</a>&gt;;
}</code></pre><details class="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="method chrono::Duration::num_nanoseconds"><code>Duration::num_nanoseconds</code></a> and
<a href="struct.DateTime.html#method.timestamp_nanos" title="method chrono::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="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Err" class="method"><a class="src rightside" href="../src/chrono/round.rs.html#104">source</a><h4 class="code-header">type <a href="#associatedtype.Err" class="associatedtype">Err</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/error/trait.Error.html" title="trait core::error::Error">Error</a></h4></section></summary><div class="docblock"><p>Error that can occur in rounding or truncating</p>
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.duration_round" class="method"><a class="src rightside" href="../src/chrono/round.rs.html#125">source</a><h4 class="code-header">fn <a href="#tymethod.duration_round" class="fn">duration_round</a>(self, duration: <a class="struct" href="struct.Duration.html" title="struct chrono::Duration">Duration</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&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">"2018-01-11 12:00:00.150 UTC"
</span>);
<span class="macro">assert_eq!</span>(
dt.duration_round(Duration::days(<span class="number">1</span>)).unwrap().to_string(),
<span class="string">"2018-01-12 00:00:00 UTC"
</span>);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.duration_trunc" class="method"><a class="src rightside" href="../src/chrono/round.rs.html#142">source</a><h4 class="code-header">fn <a href="#tymethod.duration_trunc" class="fn">duration_trunc</a>(self, duration: <a class="struct" href="struct.Duration.html" title="struct chrono::Duration">Duration</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&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">"2018-01-11 12:00:00.150 UTC"
</span>);
<span class="macro">assert_eq!</span>(
dt.duration_trunc(Duration::days(<span class="number">1</span>)).unwrap().to_string(),
<span class="string">"2018-01-11 00:00:00 UTC"
</span>);</code></pre></div>
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-DurationRound-for-NaiveDateTime" class="impl"><a class="src rightside" href="../src/chrono/round.rs.html#157-167">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"><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="toggle implementors-toggle"><summary><section id="impl-DurationRound-for-DateTime%3CTz%3E" class="impl"><a class="src rightside" href="../src/chrono/round.rs.html#145-155">source</a><a href="#impl-DurationRound-for-DateTime%3CTz%3E" class="anchor">§</a><h3 class="code-header">impl&lt;Tz: <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"><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="../trait.impl/chrono/round/trait.DurationRound.js" async></script></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink