mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
40 lines
13 KiB
HTML
40 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="API documentation for the Rust `DurationRound` trait in crate `chrono`."><meta name="keywords" content="rust, rustlang, rust-lang, DurationRound"><title>chrono::DurationRound - Rust</title><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../chrono/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Trait DurationRound</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Err">Err</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.duration_round">duration_round</a><a href="#tymethod.duration_trunc">duration_trunc</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">chrono</a></p><div id="sidebar-vars" data-name="DurationRound" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><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" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">chrono</a>::<wbr><a class="trait" href="">DurationRound</a></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 type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait DurationRound: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
type <a href="#associatedtype.Err" class="type">Err</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/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="../chrono/struct.Duration.html" title="struct chrono::Duration">Duration</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="../chrono/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="../chrono/struct.Duration.html" title="struct chrono::Duration">Duration</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="../chrono/trait.DurationRound.html#associatedtype.Err" title="type chrono::DurationRound::Err">Err</a>>;
|
||
}</pre></div><div class="docblock"><p>Extension trait for rounding or truncating a DateTime by a Duration.</p>
|
||
<h1 id="limitations" class="section-header"><a href="#limitations">Limitations</a></h1>
|
||
<p>Both rounding and truncating are done via <a href="../chrono/struct.Duration.html#method.num_nanoseconds" title="Duration::num_nanoseconds"><code>Duration::num_nanoseconds</code></a> and
|
||
<a href="../chrono/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><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><h3 id="associatedtype.Err" class="method"><code>type <a href="#associatedtype.Err" class="type">Err</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html" title="trait std::error::Error">Error</a></code><a class="srclink" href="../src/chrono/round.rs.html#105" title="goto source code">[src]</a></h3><div class="docblock"><p>Error that can occur in rounding or truncating</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.duration_round" class="method"><code>fn <a href="#tymethod.duration_round" class="fnname">duration_round</a>(self, duration: <a class="struct" href="../chrono/struct.Duration.html" title="struct chrono::Duration">Duration</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="../chrono/trait.DurationRound.html#associatedtype.Err" title="type chrono::DurationRound::Err">Err</a>></code><a class="srclink" href="../src/chrono/round.rs.html#126" title="goto source code">[src]</a></h3><div class="docblock"><p>Return a copy rounded by Duration.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<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="macro">!</span>(
|
||
<span class="ident">dt</span>.<span class="ident">duration_round</span>(<span class="ident">Duration</span>::<span class="ident">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="macro">!</span>(
|
||
<span class="ident">dt</span>.<span class="ident">duration_round</span>(<span class="ident">Duration</span>::<span class="ident">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>
|
||
);</pre></div>
|
||
</div><h3 id="tymethod.duration_trunc" class="method"><code>fn <a href="#tymethod.duration_trunc" class="fnname">duration_trunc</a>(self, duration: <a class="struct" href="../chrono/struct.Duration.html" title="struct chrono::Duration">Duration</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="../chrono/trait.DurationRound.html#associatedtype.Err" title="type chrono::DurationRound::Err">Err</a>></code><a class="srclink" href="../src/chrono/round.rs.html#143" title="goto source code">[src]</a></h3><div class="docblock"><p>Return a copy truncated by Duration.</p>
|
||
<h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<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="macro">!</span>(
|
||
<span class="ident">dt</span>.<span class="ident">duration_trunc</span>(<span class="ident">Duration</span>::<span class="ident">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="macro">!</span>(
|
||
<span class="ident">dt</span>.<span class="ident">duration_trunc</span>(<span class="ident">Duration</span>::<span class="ident">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>
|
||
);</pre></div>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-DurationRound" class="impl"><code class="in-band">impl<Tz: <a class="trait" href="../chrono/offset/trait.TimeZone.html" title="trait chrono::offset::TimeZone">TimeZone</a>> DurationRound for <a class="struct" href="../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Tz></code><a href="#impl-DurationRound" class="anchor"></a><a class="srclink" href="../src/chrono/round.rs.html#149-200" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Err-1" class="type"><code>type <a href="#associatedtype.Err-1" class="type">Err</a> = <a class="enum" href="../chrono/enum.RoundingError.html" title="enum chrono::RoundingError">RoundingError</a></code></h4><h4 id="method.duration_round" class="method hidden"><code>fn <a href="#method.duration_round" class="fnname">duration_round</a>(self, duration: <a class="struct" href="../chrono/struct.Duration.html" title="struct chrono::Duration">Duration</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="../chrono/trait.DurationRound.html#associatedtype.Err" title="type chrono::DurationRound::Err">Err</a>></code><a class="srclink" href="../src/chrono/round.rs.html#152-179" title="goto source code">[src]</a></h4><h4 id="method.duration_trunc" class="method hidden"><code>fn <a href="#method.duration_trunc" class="fnname">duration_trunc</a>(self, duration: <a class="struct" href="../chrono/struct.Duration.html" title="struct chrono::Duration">Duration</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="../chrono/trait.DurationRound.html#associatedtype.Err" title="type chrono::DurationRound::Err">Err</a>></code><a class="srclink" href="../src/chrono/round.rs.html#181-199" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/chrono/trait.DurationRound.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="chrono"></div>
|
||
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |