greptimedb/mito2/cache/range_cache/trait.RangeCacheMetricsReport.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="Reports cache activity to the query that owns the reader or publication."><title>RangeCacheMetricsReport in mito2::cache::range_cache - 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="mito2" 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 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="#">RangeCacheMetricsReport</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../mito2/index.html">mito2</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="#">Range<wbr>Cache<wbr>Metrics<wbr>Report</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.inc_range_cache_hit" title="inc_range_cache_hit">inc_range_cache_hit</a></li><li><a href="#tymethod.inc_range_cache_miss" title="inc_range_cache_miss">inc_range_cache_miss</a></li><li><a href="#tymethod.inc_range_cache_size" title="inc_range_cache_size">inc_range_cache_size</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In mito2::<wbr>cache::<wbr>range_<wbr>cache</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">cache</a>::<wbr><a href="index.html">range_cache</a></div><h1>Trait <span class="trait">Range<wbr>Cache<wbr>Metrics<wbr>Report</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/cache/range_cache.rs.html#61-68">Source</a> </span></div><pre class="rust item-decl"><code>pub(crate) trait RangeCacheMetricsReport: <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
    // Required methods
    fn <a href="#tymethod.inc_range_cache_hit" class="fn">inc_range_cache_hit</a>(&amp;self);
<span class="item-spacer"></span>    fn <a href="#tymethod.inc_range_cache_miss" class="fn">inc_range_cache_miss</a>(&amp;self);
<span class="item-spacer"></span>    fn <a href="#tymethod.inc_range_cache_size" class="fn">inc_range_cache_size</a>(&amp;self, bytes: <a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.usize.html">usize</a>);
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Reports cache activity to the query that owns the reader or publication.</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.inc_range_cache_hit" class="method"><a class="src rightside" href="../../../src/mito2/cache/range_cache.rs.html#63">Source</a><h4 class="code-header">fn <a href="#tymethod.inc_range_cache_hit" class="fn">inc_range_cache_hit</a>(&amp;self)</h4></section></summary><div class="docblock"><p>Records a completed-result hit for this reader.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.inc_range_cache_miss" class="method"><a class="src rightside" href="../../../src/mito2/cache/range_cache.rs.html#65">Source</a><h4 class="code-header">fn <a href="#tymethod.inc_range_cache_miss" class="fn">inc_range_cache_miss</a>(&amp;self)</h4></section></summary><div class="docblock"><p>Records a reader without a deliverable completed result.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.inc_range_cache_size" class="method"><a class="src rightside" href="../../../src/mito2/cache/range_cache.rs.html#67">Source</a><h4 class="code-header">fn <a href="#tymethod.inc_range_cache_size" class="fn">inc_range_cache_size</a>(&amp;self, bytes: <a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Records bytes published by the reader that finishes the shared scan.</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 <b>is</b> <a href="https://doc.rust-lang.org/1.98.1/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety".</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-RangeCacheMetricsReport-for-PartitionMetricsInner" class="impl"><a class="src rightside" href="../../../src/mito2/read/scan_util.rs.html#919-937">Source</a><a href="#impl-RangeCacheMetricsReport-for-PartitionMetricsInner" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RangeCacheMetricsReport.html" title="trait mito2::cache::range_cache::RangeCacheMetricsReport">RangeCacheMetricsReport</a> for <a class="struct" href="../../read/scan_util/struct.PartitionMetricsInner.html" title="struct mito2::read::scan_util::PartitionMetricsInner">PartitionMetricsInner</a></h3></section></div><script src="../../../trait.impl/mito2/cache/range_cache/trait.RangeCacheMetricsReport.js" async></script></section></div></main></body></html>