mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 04:41:02 +01:00
41 lines
16 KiB
HTML
41 lines
16 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="The common set of methods for time component."><title>Timelike 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">☰</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="#">Timelike</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.hour">hour</a></li><li><a href="#tymethod.minute">minute</a></li><li><a href="#tymethod.nanosecond">nanosecond</a></li><li><a href="#tymethod.second">second</a></li><li><a href="#tymethod.with_hour">with_hour</a></li><li><a href="#tymethod.with_minute">with_minute</a></li><li><a href="#tymethod.with_nanosecond">with_nanosecond</a></li><li><a href="#tymethod.with_second">with_second</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.hour12">hour12</a></li><li><a href="#method.num_seconds_from_midnight">num_seconds_from_midnight</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="#">Timelike</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/traits.rs.html#267-328">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Timelike: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
// Required methods
|
||
fn <a href="#tymethod.hour" class="fn">hour</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.minute" class="fn">minute</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.second" class="fn">second</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.nanosecond" class="fn">nanosecond</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.with_hour" class="fn">with_hour</a>(&self, hour: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.with_minute" class="fn">with_minute</a>(&self, min: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.with_second" class="fn">with_second</a>(&self, sec: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.with_nanosecond" class="fn">with_nanosecond</a>(&self, nano: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
||
|
||
// Provided methods
|
||
fn <a href="#method.hour12" class="fn">hour12</a>(&self) -> (<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>) { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.num_seconds_from_midnight" class="fn">num_seconds_from_midnight</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a> { ... }
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The common set of methods for time component.</p>
|
||
</div></details><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.hour" class="method"><a class="src rightside" href="../src/chrono/traits.rs.html#269">source</a><h4 class="code-header">fn <a href="#tymethod.hour" class="fn">hour</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Returns the hour number from 0 to 23.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.minute" class="method"><a class="src rightside" href="../src/chrono/traits.rs.html#284">source</a><h4 class="code-header">fn <a href="#tymethod.minute" class="fn">minute</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Returns the minute number from 0 to 59.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.second" class="method"><a class="src rightside" href="../src/chrono/traits.rs.html#287">source</a><h4 class="code-header">fn <a href="#tymethod.second" class="fn">second</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Returns the second number from 0 to 59.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.nanosecond" class="method"><a class="src rightside" href="../src/chrono/traits.rs.html#292">source</a><h4 class="code-header">fn <a href="#tymethod.nanosecond" class="fn">nanosecond</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Returns the number of nanoseconds since the whole non-leap second.
|
||
The range from 1,000,000,000 to 1,999,999,999 represents
|
||
the <a href="./naive/struct.NaiveTime.html#leap-second-handling">leap second</a>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.with_hour" class="method"><a class="src rightside" href="../src/chrono/traits.rs.html#297">source</a><h4 class="code-header">fn <a href="#tymethod.with_hour" class="fn">with_hour</a>(&self, hour: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></h4></section></summary><div class="docblock"><p>Makes a new value with the hour number changed.</p>
|
||
<p>Returns <code>None</code> when the resulting value would be invalid.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.with_minute" class="method"><a class="src rightside" href="../src/chrono/traits.rs.html#302">source</a><h4 class="code-header">fn <a href="#tymethod.with_minute" class="fn">with_minute</a>(&self, min: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></h4></section></summary><div class="docblock"><p>Makes a new value with the minute number changed.</p>
|
||
<p>Returns <code>None</code> when the resulting value would be invalid.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.with_second" class="method"><a class="src rightside" href="../src/chrono/traits.rs.html#309">source</a><h4 class="code-header">fn <a href="#tymethod.with_second" class="fn">with_second</a>(&self, sec: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></h4></section></summary><div class="docblock"><p>Makes a new value with the second number changed.</p>
|
||
<p>Returns <code>None</code> when the resulting value would be invalid.
|
||
As with the <a href="#tymethod.second"><code>second</code></a> method,
|
||
the input range is restricted to 0 through 59.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.with_nanosecond" class="method"><a class="src rightside" href="../src/chrono/traits.rs.html#316">source</a><h4 class="code-header">fn <a href="#tymethod.with_nanosecond" class="fn">with_nanosecond</a>(&self, nano: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></h4></section></summary><div class="docblock"><p>Makes a new value with nanoseconds since the whole non-leap second changed.</p>
|
||
<p>Returns <code>None</code> when the resulting value would be invalid.
|
||
As with the <a href="#tymethod.nanosecond"><code>nanosecond</code></a> method,
|
||
the input range can exceed 1,000,000,000 for leap seconds.</p>
|
||
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.hour12" class="method"><a class="src rightside" href="../src/chrono/traits.rs.html#274-281">source</a><h4 class="code-header">fn <a href="#method.hour12" class="fn">hour12</a>(&self) -> (<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>)</h4></section></summary><div class="docblock"><p>Returns the hour number from 1 to 12 with a boolean flag,
|
||
which is false for AM and true for PM.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.num_seconds_from_midnight" class="method"><a class="src rightside" href="../src/chrono/traits.rs.html#325-327">source</a><h4 class="code-header">fn <a href="#method.num_seconds_from_midnight" class="fn">num_seconds_from_midnight</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Returns the number of non-leap seconds past the last midnight.</p>
|
||
<p>Every value in 00:00:00-23:59:59 maps to an integer in 0-86399.</p>
|
||
<p>This method is not intended to provide the real number of seconds since midnight on a given
|
||
day. It does not take things like DST transitions into account.</p>
|
||
</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"><section id="impl-Timelike-for-NaiveDateTime" class="impl"><a class="src rightside" href="../src/chrono/naive/datetime/mod.rs.html#1328-1499">source</a><a href="#impl-Timelike-for-NaiveDateTime" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Timelike.html" title="trait chrono::Timelike">Timelike</a> for <a class="struct" href="naive/struct.NaiveDateTime.html" title="struct chrono::naive::NaiveDateTime">NaiveDateTime</a></h3></section><section id="impl-Timelike-for-NaiveTime" class="impl"><a class="src rightside" href="../src/chrono/naive/time/mod.rs.html#848-1067">source</a><a href="#impl-Timelike-for-NaiveTime" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Timelike.html" title="trait chrono::Timelike">Timelike</a> for <a class="struct" href="naive/struct.NaiveTime.html" title="struct chrono::naive::NaiveTime">NaiveTime</a></h3></section><section id="impl-Timelike-for-DateTime%3CTz%3E" class="impl"><a class="src rightside" href="../src/chrono/datetime/mod.rs.html#1084-1164">source</a><a href="#impl-Timelike-for-DateTime%3CTz%3E" class="anchor">§</a><h3 class="code-header">impl<Tz: <a class="trait" href="offset/trait.TimeZone.html" title="trait chrono::offset::TimeZone">TimeZone</a>> <a class="trait" href="trait.Timelike.html" title="trait chrono::Timelike">Timelike</a> for <a class="struct" href="struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Tz></h3></section></div><script src="../trait.impl/chrono/traits/trait.Timelike.js" async></script></section></div></main></body></html> |