greptimedb/mito2/cache/range_cache/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="Coordinates range-result cache loads and SST retirement. No I/O or decoding runs under the coordinator lock; loaders use the shared query runtime."><title>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 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 range_cache</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="#">Module range_<wbr>cache</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In mito2::<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></div><h1>Module <span>range_<wbr>cache</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#15-983">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Coordinates range-result cache loads and SST retirement. No I/O or decoding
runs under the coordinator lock; loaders use the shared query runtime.</p>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="shared_range/index.html" title="mod mito2::cache::range_cache::shared_range">shared_<wbr>range</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A single range scan with independently advancing readers.</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.CacheConcatState.html" title="struct mito2::cache::range_cache::CacheConcatState">Cache<wbr>Concat<wbr>State</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.CachedBatchSlice.html" title="struct mito2::cache::range_cache::CachedBatchSlice">Cached<wbr>Batch<wbr>Slice</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Cached result for one range scan.</dd><dt><a class="struct" href="struct.Entry.html" title="struct mito2::cache::range_cache::Entry">Entry</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.RangeCacheDelivery.html" title="struct mito2::cache::range_cache::RangeCacheDelivery">Range<wbr>Cache<wbr>Delivery</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Keeps completed results charged while subscribers or replay streams own them.
Cache entries retain only a weak reference: after the last reader leaves,
the resident value is covered solely by the cache’s capacity accounting.</dd><dt><a class="struct" href="struct.RangeCacheScope.html" title="struct mito2::cache::range_cache::RangeCacheScope">Range<wbr>Cache<wbr>Scope</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Separates active scans with different query memory reservations.
Completed results are reusable across scopes. The default scope is for
sources without a query-specific memory pool.</dd><dt><a class="struct" href="struct.RangeLoad.html" title="struct mito2::cache::range_cache::RangeLoad">Range<wbr>Load</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Readers own the scan; the coordinator only retains a weak registration.
Query-pool identity isolates active reservations, not completed cache values.</dd><dt><a class="struct" href="struct.RangeRegistration.html" title="struct mito2::cache::range_cache::RangeRegistration">Range<wbr>Registration</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.RangeResultCache.html" title="struct mito2::cache::range_cache::RangeResultCache">Range<wbr>Result<wbr>Cache</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Stores completed range results and coordinates reader-owned shared scans.</dd><dt><a class="struct" href="struct.RangeScanCacheValue.html" title="struct mito2::cache::range_cache::RangeScanCacheValue">Range<wbr>Scan<wbr>Cache<wbr>Value</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Compacted batches with their original stream boundaries and memory weight.</dd><dt><a class="struct" href="struct.State.html" title="struct mito2::cache::range_cache::State">State</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></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.RangeCacheCleanup.html" title="enum mito2::cache::range_cache::RangeCacheCleanup">Range<wbr>Cache<wbr>Cleanup</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="enum" href="enum.RangeCacheLookup.html" title="enum mito2::cache::range_cache::RangeCacheLookup">Range<wbr>Cache<wbr>Lookup</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.RANGE_CACHE_COMPACT_THRESHOLD_BYTES.html" title="constant mito2::cache::range_cache::RANGE_CACHE_COMPACT_THRESHOLD_BYTES">RANGE_<wbr>CACHE_<wbr>COMPACT_<wbr>THRESHOLD_<wbr>BYTES</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.RangeCacheMetricsReport.html" title="trait mito2::cache::range_cache::RangeCacheMetricsReport">Range<wbr>Cache<wbr>Metrics<wbr>Report</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Reports cache activity to the query that owns the reader or publication.</dd></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.cached_flat_range_stream.html" title="fn mito2::cache::range_cache::cached_flat_range_stream">cached_<wbr>flat_<wbr>range_<wbr>stream</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Returns a stream that replays cached record batches.</dd><dt><a class="fn" href="fn.compact_record_batches.html" title="fn mito2::cache::range_cache::compact_record_batches">compact_<wbr>record_<wbr>batches</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.should_compact_batches.html" title="fn mito2::cache::range_cache::should_compact_batches">should_<wbr>compact_<wbr>batches</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.FlightKey.html" title="type mito2::cache::range_cache::FlightKey">Flight<wbr>Key</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>