Files
greptimedb/mito2/memtable/partition_tree/merger/trait.Node.html
2026-05-15 04:01:35 +00:00

17 lines
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Nodes of mergers heap."><title>Node in mito2::memtable::partition_tree::merger - 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="#">Node</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="#">Node</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.advance" title="advance">advance</a></li><li><a href="#tymethod.current_item_len" title="current_item_len">current_item_len</a></li><li><a href="#tymethod.is_behind" title="is_behind">is_behind</a></li><li><a href="#tymethod.is_valid" title="is_valid">is_valid</a></li><li><a href="#tymethod.search_key_in_current_item" title="search_key_in_current_item">search_key_in_current_item</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 mito2::<wbr>memtable::<wbr>partition_<wbr>tree::<wbr>merger</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">merger</a></div><h1>Trait <span class="trait">Node</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/mito2/memtable/partition_tree/merger.rs.html#25-44">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Node: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> {
// Required methods
fn <a href="#tymethod.is_valid" class="fn">is_valid</a>(&amp;self) -&gt; <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.is_behind" class="fn">is_behind</a>(&amp;self, other: &amp;Self) -&gt; <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.advance" class="fn">advance</a>(&amp;mut self, len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="type" href="../../../error/type.Result.html" title="type mito2::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.current_item_len" class="fn">current_item_len</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.search_key_in_current_item" class="fn">search_key_in_current_item</a>(&amp;self, other: &amp;Self) -&gt; <a class="type" href="../../../error/type.Result.html" title="type mito2::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Nodes of mergers heap.</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/merger.rs.html#27">Source</a><h4 class="code-header">fn <a href="#tymethod.is_valid" class="fn">is_valid</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns true if current node is not exhausted.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.is_behind" class="method"><a class="src rightside" href="../../../../src/mito2/memtable/partition_tree/merger.rs.html#30">Source</a><h4 class="code-header">fn <a href="#tymethod.is_behind" class="fn">is_behind</a>(&amp;self, other: &amp;Self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Whether the other node is behind (exclusive) current node.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.advance" class="method"><a class="src rightside" href="../../../../src/mito2/memtable/partition_tree/merger.rs.html#37">Source</a><h4 class="code-header">fn <a href="#tymethod.advance" class="fn">advance</a>(&amp;mut self, len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="type" href="../../../error/type.Result.html" title="type mito2::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Advances <code>len</code> rows from current batch. If current batch is empty it fetches
next batch from the node.</p>
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
<p>If the node is invalid.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.current_item_len" class="method"><a class="src rightside" href="../../../../src/mito2/memtable/partition_tree/merger.rs.html#40">Source</a><h4 class="code-header">fn <a href="#tymethod.current_item_len" class="fn">current_item_len</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Length of current item.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.search_key_in_current_item" class="method"><a class="src rightside" href="../../../../src/mito2/memtable/partition_tree/merger.rs.html#43">Source</a><h4 class="code-header">fn <a href="#tymethod.search_key_in_current_item" class="fn">search_key_in_current_item</a>(&amp;self, other: &amp;Self) -&gt; <a class="type" href="../../../error/type.Result.html" title="type mito2::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</h4></section></summary><div class="docblock"><p>Searches first key of <code>other</code> in current item and returns the index.</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="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><div class="negative-marker"></div><section id="impl-Node-for-ShardNode" class="impl"><a class="src rightside" href="../../../../src/mito2/memtable/partition_tree/shard.rs.html#403-426">Source</a><a href="#impl-Node-for-ShardNode" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Node.html" title="trait mito2::memtable::partition_tree::merger::Node">Node</a> for <a class="struct" href="../shard/struct.ShardNode.html" title="struct mito2::memtable::partition_tree::shard::ShardNode">ShardNode</a></h3></section><section id="impl-Node-for-DataNode" class="impl"><a class="src rightside" href="../../../../src/mito2/memtable/partition_tree/merger.rs.html#249-292">Source</a><a href="#impl-Node-for-DataNode" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Node.html" title="trait mito2::memtable::partition_tree::merger::Node">Node</a> for <a class="struct" href="struct.DataNode.html" title="struct mito2::memtable::partition_tree::merger::DataNode">DataNode</a></h3></section></div><script src="../../../../trait.impl/mito2/memtable/partition_tree/merger/trait.Node.js" async></script></section></div></main></body></html>