greptimedb/common_time/timestamp/index.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 `timestamp` mod in crate `common_time`."><title>common_time::timestamp - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_time" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-417ebf0a.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module timestamp</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../common_time/index.html">common_<wbr>time</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module timestamp</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate common_<wbr>time</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">common_time</a></div><h1>Module <span>timestamp</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/common_time/timestamp.rs.html#15-1638">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Timestamp.html" title="struct common_time::timestamp::Timestamp">Timestamp</a></dt><dd>Timestamp represents the value of units(seconds/milliseconds/microseconds/nanoseconds) elapsed
since UNIX epoch. The valid value range of <a href="struct.Timestamp.html" title="struct common_time::timestamp::Timestamp">Timestamp</a> depends on it’s unit (all in UTC timezone):</dd><dt><a class="struct" href="struct.UnitQuotient.html" title="struct common_time::timestamp::UnitQuotient">Unit<wbr>Quotient</a></dt><dd>The exact division of a timestamp value into a different unit:
<code>quotient * from_scale + remainder == value * to_scale</code> with
<code>0 &lt;= remainder &lt; from_scale</code>. <code>quotient</code> is the value floored in
<code>to_unit</code>; <code>remainder == 0</code> iff the value is representable in <code>to_unit</code>.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.TimeUnit.html" title="enum common_time::timestamp::TimeUnit">Time<wbr>Unit</a></dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.div_mod_units.html" title="fn common_time::timestamp::div_mod_units">div_<wbr>mod_<wbr>units</a></dt><dd>Divides a <code>value</code> given in <code>from_unit</code> by <code>to_unit</code>, i.e. computes its
value in <code>to_unit</code> exactly (floor division). Returns <code>None</code> if the
quotient overflows <code>i64</code>.</dd><dt><a class="fn" href="fn.naive_datetime_to_timestamp.html" title="fn common_time::timestamp::naive_datetime_to_timestamp">naive_<wbr>datetime_<wbr>to_<wbr>timestamp</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Converts the naive datetime (which has no specific timezone) to a
nanosecond epoch timestamp in UTC.</dd><dt><a class="fn" href="fn.timestamp_unit_scale.html" title="fn common_time::timestamp::timestamp_unit_scale">timestamp_<wbr>unit_<wbr>scale</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Number of units in one second.</dd></dl></section></div></main></body></html>