mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-31 04:10:38 +00:00
20 lines
10 KiB
HTML
20 lines
10 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="Source that returns DataBatch."><title>DataBatchSource in mito2::memtable::partition_tree::shard - 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="mito2" 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="#">DataBatchSource</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../mito2/index.html">mito2</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Data<wbr>Batch<wbr>Source</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.current_data_batch" title="current_data_batch">current_data_batch</a></li><li><a href="#tymethod.current_key" title="current_key">current_key</a></li><li><a href="#tymethod.current_pk_id" title="current_pk_id">current_pk_id</a></li><li><a href="#tymethod.is_valid" title="is_valid">is_valid</a></li><li><a href="#tymethod.next" title="next">next</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In mito2::<wbr>memtable::<wbr>partition_<wbr>tree::<wbr>shard</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">mito2</a>::<wbr><a href="../../index.html">memtable</a>::<wbr><a href="../index.html">partition_tree</a>::<wbr><a href="index.html">shard</a></div><h1>Trait <span class="trait">Data<wbr>Batch<wbr>Source</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/mito2/memtable/partition_tree/shard.rs.html#117-139">Source</a> </span></div><pre class="rust item-decl"><code>pub trait DataBatchSource {
|
||
// Required methods
|
||
fn <a href="#tymethod.is_valid" class="fn">is_valid</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.next" class="fn">next</a>(&mut self) -> <a class="type" href="../../../error/type.Result.html" title="type mito2::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.current_pk_id" class="fn">current_pk_id</a>(&self) -> <a class="struct" href="../struct.PkId.html" title="struct mito2::memtable::partition_tree::PkId">PkId</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.current_key" class="fn">current_key</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.current_data_batch" class="fn">current_data_batch</a>(&self) -> <a class="struct" href="../data/struct.DataBatch.html" title="struct mito2::memtable::partition_tree::data::DataBatch">DataBatch</a><'_>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Source that returns <a href="../data/struct.DataBatch.html" title="struct mito2::memtable::partition_tree::data::DataBatch">DataBatch</a>.</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.is_valid" class="method"><a class="src rightside" href="../../../../src/mito2/memtable/partition_tree/shard.rs.html#119">Source</a><h4 class="code-header">fn <a href="#tymethod.is_valid" class="fn">is_valid</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether current source is still valid.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.next" class="method"><a class="src rightside" href="../../../../src/mito2/memtable/partition_tree/shard.rs.html#122">Source</a><h4 class="code-header">fn <a href="#tymethod.next" class="fn">next</a>(&mut self) -> <a class="type" href="../../../error/type.Result.html" title="type mito2::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Advances source to next data batch.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.current_pk_id" class="method"><a class="src rightside" href="../../../../src/mito2/memtable/partition_tree/shard.rs.html#127">Source</a><h4 class="code-header">fn <a href="#tymethod.current_pk_id" class="fn">current_pk_id</a>(&self) -> <a class="struct" href="../struct.PkId.html" title="struct mito2::memtable::partition_tree::PkId">PkId</a></h4></section></summary><div class="docblock"><p>Returns current pk id.</p>
|
||
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
|
||
<p>If source is not valid.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.current_key" class="method"><a class="src rightside" href="../../../../src/mito2/memtable/partition_tree/shard.rs.html#133">Source</a><h4 class="code-header">fn <a href="#tymethod.current_key" class="fn">current_key</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]></h4></section></summary><div class="docblock"><p>Returns the current primary key bytes or None if it doesn’t have primary key.</p>
|
||
<h5 id="panics-1"><a class="doc-anchor" href="#panics-1">§</a>Panics</h5>
|
||
<p>If source is not valid.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.current_data_batch" class="method"><a class="src rightside" href="../../../../src/mito2/memtable/partition_tree/shard.rs.html#138">Source</a><h4 class="code-header">fn <a href="#tymethod.current_data_batch" class="fn">current_data_batch</a>(&self) -> <a class="struct" href="../data/struct.DataBatch.html" title="struct mito2::memtable::partition_tree::data::DataBatch">DataBatch</a><'_></h4></section></summary><div class="docblock"><p>Returns the data part.</p>
|
||
<h5 id="panics-2"><a class="doc-anchor" href="#panics-2">§</a>Panics</h5>
|
||
<p>If source is not valid.</p>
|
||
</div></details></div><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-DataBatchSource-for-ShardMerger" class="impl"><a class="src rightside" href="../../../../src/mito2/memtable/partition_tree/shard.rs.html#292-313">Source</a><a href="#impl-DataBatchSource-for-ShardMerger" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.DataBatchSource.html" title="trait mito2::memtable::partition_tree::shard::DataBatchSource">DataBatchSource</a> for <a class="struct" href="struct.ShardMerger.html" title="struct mito2::memtable::partition_tree::shard::ShardMerger">ShardMerger</a></h3></section><section id="impl-DataBatchSource-for-DedupReader%3CT%3E" class="impl"><a class="src rightside" href="../../../../src/mito2/memtable/partition_tree/dedup.rs.html#42-108">Source</a><a href="#impl-DataBatchSource-for-DedupReader%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="trait.DataBatchSource.html" title="trait mito2::memtable::partition_tree::shard::DataBatchSource">DataBatchSource</a>> <a class="trait" href="trait.DataBatchSource.html" title="trait mito2::memtable::partition_tree::shard::DataBatchSource">DataBatchSource</a> for <a class="struct" href="../dedup/struct.DedupReader.html" title="struct mito2::memtable::partition_tree::dedup::DedupReader">DedupReader</a><T></h3></section></div><script src="../../../../trait.impl/mito2/memtable/partition_tree/shard/trait.DataBatchSource.js" async></script></section></div></main></body></html> |