greptimedb/mito2/region/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="Mito region."><title>mito2::region - 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 region</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 region</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="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate mito2</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></div><h1>Module <span>region</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/region.rs.html#15-3010">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Mito region.</p>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt><code>pub use <a class="mod" href="utils/index.html" title="mod mito2::region::utils">utils</a>::*;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="catchup/index.html" title="mod mito2::region::catchup">catchup</a></dt><dt><a class="mod" href="opener/index.html" title="mod mito2::region::opener">opener</a></dt><dd>Region opener.</dd><dt><a class="mod" href="options/index.html" title="mod mito2::region::options">options</a></dt><dd>Options for a region.</dd><dt><a class="mod" href="utils/index.html" title="mod mito2::region::utils">utils</a></dt><dt><a class="mod" href="version/index.html" title="mod mito2::region::version">version</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Version control of mito engine.</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.CatchupRegions.html" title="struct mito2::region::CatchupRegions">Catchup<wbr>Regions</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The regions that are catching up.</dd><dt><a class="struct" href="struct.IndexBuildSource.html" title="struct mito2::region::IndexBuildSource">Index<wbr>Build<wbr>Source</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Manifest state an index build is based on.</dd><dt><a class="struct" href="struct.ManifestContext.html" title="struct mito2::region::ManifestContext">Manifest<wbr>Context</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Context to update the region manifest.</dd><dt><a class="struct" href="struct.ManifestSstProjection.html" title="struct mito2::region::ManifestSstProjection">Manifest<wbr>SstProjection</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Columns requiring allocations or snapshots during an inspection scan.</dd><dt><a class="struct" href="struct.ManifestStats.html" title="struct mito2::region::ManifestStats">Manifest<wbr>Stats</a></dt><dd>Manifest stats.</dd><dt><a class="struct" href="struct.MitoRegion.html" title="struct mito2::region::MitoRegion">Mito<wbr>Region</a></dt><dd>Metadata and runtime status of a region.</dd><dt><a class="struct" href="struct.OpeningRegions.html" title="struct mito2::region::OpeningRegions">Opening<wbr>Regions</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Opening regions</dd><dt><a class="struct" href="struct.RegionMap.html" title="struct mito2::region::RegionMap">Region<wbr>Map</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Regions indexed by ids.</dd><dt><a class="struct" href="struct.RegionStats.html" title="struct mito2::region::RegionStats">Region<wbr>Stats</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Runtime statistics of a region.</dd><dt><a class="struct" href="struct.RegionUsage.html" title="struct mito2::region::RegionUsage">Region<wbr>Usage</a></dt><dd>Region status include region id, memtable usage, sst usage, wal usage and manifest usage.</dd><dt><a class="struct" href="struct.StagingPartitionInfo.html" title="struct mito2::region::StagingPartitionInfo">Staging<wbr>Partition<wbr>Info</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.IndexPublication.html" title="enum mito2::region::IndexPublication">Index<wbr>Publication</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Result of publishing rebuilt index metadata to the manifest.</dd><dt><a class="enum" href="enum.IndexPublicationStale.html" title="enum mito2::region::IndexPublicationStale">Index<wbr>Publication<wbr>Stale</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Why an index publication became stale.</dd><dt><a class="enum" href="enum.RegionLeaderState.html" title="enum mito2::region::RegionLeaderState">Region<wbr>Leader<wbr>State</a></dt><dt><a class="enum" href="enum.RegionRoleState.html" title="enum mito2::region::RegionRoleState">Region<wbr>Role<wbr>State</a></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.ESTIMATED_WAL_FACTOR.html" title="constant mito2::region::ESTIMATED_WAL_FACTOR">ESTIMATED_<wbr>WAL_<wbr>FACTOR</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>This is the approximate factor to estimate the size of wal.</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.manifest_file_matches.html" title="fn mito2::region::manifest_file_matches">manifest_<wbr>file_<wbr>matches</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Applies supported file predicates before allocating an inspection row. Unknown
predicates and evaluation failures are left to the query’s residual filter.</dd><dt><a class="fn" href="fn.parse_partition_expr.html" title="fn mito2::region::parse_partition_expr">parse_<wbr>partition_<wbr>expr</a></dt><dd>Parses the partition expression from a JSON string.</dd></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.CatchupRegionsRef.html" title="type mito2::region::CatchupRegionsRef">Catchup<wbr>Regions<wbr>Ref</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="type" href="type.ManifestContextRef.html" title="type mito2::region::ManifestContextRef">Manifest<wbr>Context<wbr>Ref</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="type" href="type.MitoRegionRef.html" title="type mito2::region::MitoRegionRef">Mito<wbr>Region<wbr>Ref</a></dt><dt><a class="type" href="type.OpeningRegionsRef.html" title="type mito2::region::OpeningRegionsRef">Opening<wbr>Regions<wbr>Ref</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="type" href="type.RegionMapRef.html" title="type mito2::region::RegionMapRef">Region<wbr>MapRef</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>