mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-15 12:30:38 +00:00
11 lines
9.5 KiB
HTML
11 lines
9.5 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 `BucketAligned` trait in crate `common_time`."><title>BucketAligned in common_time::timestamp_millis - 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-17e0aaed.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.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.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-5013f961.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 trait"><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="#">BucketAligned</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.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Bucket<wbr>Aligned</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.align_by_bucket" title="align_by_bucket">align_by_bucket</a></li><li><a href="#tymethod.align_to_ceil_by_bucket" title="align_to_ceil_by_bucket">align_to_ceil_by_bucket</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-BucketAligned-for-i64" title="i64">i64</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In common_<wbr>time::<wbr>timestamp_<wbr>millis</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>::<wbr><a href="index.html">timestamp_millis</a></div><h1>Trait <span class="trait">Bucket<wbr>Aligned</span> <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_millis.rs.html#83-95">Source</a> </span></div><pre class="rust item-decl"><code>pub trait BucketAligned: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
// Required methods
|
|
fn <a href="#tymethod.align_by_bucket" class="fn">align_by_bucket</a>(self, bucket_duration: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.align_to_ceil_by_bucket" class="fn">align_to_ceil_by_bucket</a>(self, bucket_duration: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
|
}</code></pre><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.align_by_bucket" class="method"><a class="src rightside" href="../../src/common_time/timestamp_millis.rs.html#88">Source</a><h4 class="code-header">fn <a href="#tymethod.align_by_bucket" class="fn">align_by_bucket</a>(self, bucket_duration: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></h4></section></summary><div class="docblock"><p>Aligns the value by <code>bucket_duration</code> or <code>None</code> if underflow occurred.</p>
|
|
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
|
|
<p>Panics if <code>bucket_duration <= 0</code>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.align_to_ceil_by_bucket" class="method"><a class="src rightside" href="../../src/common_time/timestamp_millis.rs.html#94">Source</a><h4 class="code-header">fn <a href="#tymethod.align_to_ceil_by_bucket" class="fn">align_to_ceil_by_bucket</a>(self, bucket_duration: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></h4></section></summary><div class="docblock"><p>Aligns the value by <code>bucket_duration</code> to ceil or <code>None</code> if overflow occurred.</p>
|
|
<h5 id="panics-1"><a class="doc-anchor" href="#panics-1">§</a>Panics</h5>
|
|
<p>Panics if <code>bucket_duration <= 0</code>.</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-BucketAligned-for-i64" class="impl"><a class="src rightside" href="../../src/common_time/timestamp_millis.rs.html#97-108">Source</a><a href="#impl-BucketAligned-for-i64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.BucketAligned.html" title="trait common_time::timestamp_millis::BucketAligned">BucketAligned</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></h3></section></summary><div class="impl-items"><section id="method.align_by_bucket" class="method trait-impl"><a class="src rightside" href="../../src/common_time/timestamp_millis.rs.html#98-102">Source</a><a href="#method.align_by_bucket" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.align_by_bucket" class="fn">align_by_bucket</a>(self, bucket_duration: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></h4></section><section id="method.align_to_ceil_by_bucket" class="method trait-impl"><a class="src rightside" href="../../src/common_time/timestamp_millis.rs.html#104-107">Source</a><a href="#method.align_to_ceil_by_bucket" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.align_to_ceil_by_bucket" class="fn">align_to_ceil_by_bucket</a>(self, bucket_duration: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><div class="negative-marker"></div><section id="impl-BucketAligned-for-Timestamp" class="impl"><a class="src rightside" href="../../src/common_time/timestamp_millis.rs.html#110-126">Source</a><a href="#impl-BucketAligned-for-Timestamp" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.BucketAligned.html" title="trait common_time::timestamp_millis::BucketAligned">BucketAligned</a> for <a class="struct" href="../timestamp/struct.Timestamp.html" title="struct common_time::timestamp::Timestamp">Timestamp</a></h3></section></div><script src="../../trait.impl/common_time/timestamp_millis/trait.BucketAligned.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html> |