mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-04 12:22:55 +00:00
3 lines
8.9 KiB
HTML
3 lines
8.9 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="Region Engine’s definition"><title>store_api::region_engine - 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-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="store_api" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.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"><!--[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_engine</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../store_api/index.html">store_<wbr>api</a><span class="version">1.0.0-beta.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module region_<wbr>engine</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</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 store_<wbr>api</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"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">store_api</a></div><h1>Module <span>region_<wbr>engine</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/store_api/region_engine.rs.html#15-1012">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Region Engine’s definition</p>
|
||
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.GrantedRegion.html" title="struct store_api::region_engine::GrantedRegion">Granted<wbr>Region</a></dt><dt><a class="struct" href="struct.MitoCopyRegionFromRequest.html" title="struct store_api::region_engine::MitoCopyRegionFromRequest">Mito<wbr>Copy<wbr>Region<wbr>From<wbr>Request</a></dt><dd>Request to copy files from a source region to a target region.</dd><dt><a class="struct" href="struct.MitoCopyRegionFromResponse.html" title="struct store_api::region_engine::MitoCopyRegionFromResponse">Mito<wbr>Copy<wbr>Region<wbr>From<wbr>Response</a></dt><dt><a class="struct" href="struct.PartitionRange.html" title="struct store_api::region_engine::PartitionRange">Partition<wbr>Range</a></dt><dd>Represents one data range within a partition</dd><dt><a class="struct" href="struct.PrepareRequest.html" title="struct store_api::region_engine::PrepareRequest">Prepare<wbr>Request</a></dt><dd>Request to override the scanner properties.</dd><dt><a class="struct" href="struct.QueryScanContext.html" title="struct store_api::region_engine::QueryScanContext">Query<wbr>Scan<wbr>Context</a></dt><dd>Necessary context of the query for the scanner.</dd><dt><a class="struct" href="struct.RegionStatistic.html" title="struct store_api::region_engine::RegionStatistic">Region<wbr>Statistic</a></dt><dd>Represents the statistics of a region.</dd><dt><a class="struct" href="struct.RemapManifestsRequest.html" title="struct store_api::region_engine::RemapManifestsRequest">Remap<wbr>Manifests<wbr>Request</a></dt><dd>Request to remap manifests from old regions to new regions.</dd><dt><a class="struct" href="struct.RemapManifestsResponse.html" title="struct store_api::region_engine::RemapManifestsResponse">Remap<wbr>Manifests<wbr>Response</a></dt><dd>Response to remap manifests from old regions to new regions.</dd><dt><a class="struct" href="struct.ScannerProperties.html" title="struct store_api::region_engine::ScannerProperties">Scanner<wbr>Properties</a></dt><dd>Properties of the <a href="trait.RegionScanner.html" title="trait store_api::region_engine::RegionScanner">RegionScanner</a>.</dd><dt><a class="struct" href="struct.SetRegionRoleStateRequest.html" title="struct store_api::region_engine::SetRegionRoleStateRequest">SetRegion<wbr>Role<wbr>State<wbr>Request</a></dt><dd>The request to set region role state.</dd><dt><a class="struct" href="struct.SinglePartitionScanner.html" title="struct store_api::region_engine::SinglePartitionScanner">Single<wbr>Partition<wbr>Scanner</a></dt><dd>A <a href="trait.RegionScanner.html" title="trait store_api::region_engine::RegionScanner">RegionScanner</a> that only scans a single partition.</dd></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.RegionManifestInfo.html" title="enum store_api::region_engine::RegionManifestInfo">Region<wbr>Manifest<wbr>Info</a></dt><dd>The manifest info of a region.</dd><dt><a class="enum" href="enum.RegionRole.html" title="enum store_api::region_engine::RegionRole">Region<wbr>Role</a></dt><dd>The role of the region.
|
||
TODO(weny): rename it to <code>RegionRoleState</code></dd><dt><a class="enum" href="enum.ScannerPartitioning.html" title="enum store_api::region_engine::ScannerPartitioning">Scanner<wbr>Partitioning</a></dt><dd>Output partition properties of the <a href="trait.RegionScanner.html" title="trait store_api::region_engine::RegionScanner">RegionScanner</a>.</dd><dt><a class="enum" href="enum.SetRegionRoleStateResponse.html" title="enum store_api::region_engine::SetRegionRoleStateResponse">SetRegion<wbr>Role<wbr>State<wbr>Response</a></dt><dd>The response of setting region role state.</dd><dt><a class="enum" href="enum.SetRegionRoleStateSuccess.html" title="enum store_api::region_engine::SetRegionRoleStateSuccess">SetRegion<wbr>Role<wbr>State<wbr>Success</a></dt><dd>The success response of setting region role state.</dd><dt><a class="enum" href="enum.SettableRegionRoleState.html" title="enum store_api::region_engine::SettableRegionRoleState">Settable<wbr>Region<wbr>Role<wbr>State</a></dt><dd>The settable region role state.</dd><dt><a class="enum" href="enum.SyncRegionFromRequest.html" title="enum store_api::region_engine::SyncRegionFromRequest">Sync<wbr>Region<wbr>From<wbr>Request</a></dt><dd>Request to sync the region from a manifest or a region.</dd><dt><a class="enum" href="enum.SyncRegionFromResponse.html" title="enum store_api::region_engine::SyncRegionFromResponse">Sync<wbr>Region<wbr>From<wbr>Response</a></dt><dd>The response of syncing the region.</dd></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.RegionEngine.html" title="trait store_api::region_engine::RegionEngine">Region<wbr>Engine</a></dt><dt><a class="trait" href="trait.RegionScanner.html" title="trait store_api::region_engine::RegionScanner">Region<wbr>Scanner</a></dt><dd>A scanner that provides a way to scan the region concurrently.</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.BatchResponses.html" title="type store_api::region_engine::BatchResponses">Batch<wbr>Responses</a></dt><dt><a class="type" href="type.RegionEngineRef.html" title="type store_api::region_engine::RegionEngineRef">Region<wbr>Engine<wbr>Ref</a></dt><dt><a class="type" href="type.RegionScannerRef.html" title="type store_api::region_engine::RegionScannerRef">Region<wbr>Scanner<wbr>Ref</a></dt></dl></section></div></main></body></html> |