mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-27 02:10:38 +00:00
2 lines
8.4 KiB
HTML
2 lines
8.4 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="API documentation for the Rust `router` mod in crate `common_meta`."><title>common_meta::rpc::router - 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="common_meta" 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 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 router</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../common_meta/index.html">common_<wbr>meta</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module router</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="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In common_<wbr>meta::<wbr>rpc</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">common_meta</a>::<wbr><a href="../index.html">rpc</a></div><h1>Module <span>router</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/common_meta/rpc/router.rs.html#15-945">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.LegacyPartition.html" title="struct common_meta::rpc::router::LegacyPartition">Legacy<wbr>Partition</a></dt><dt><a class="struct" href="struct.Region.html" title="struct common_meta::rpc::router::Region">Region</a></dt><dt><a class="struct" href="struct.RegionDe.html" title="struct common_meta::rpc::router::RegionDe">Region<wbr>De</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="struct" href="struct.RegionRoute.html" title="struct common_meta::rpc::router::RegionRoute">Region<wbr>Route</a></dt><dt><a class="struct" href="struct.RegionRouteBuilder.html" title="struct common_meta::rpc::router::RegionRouteBuilder">Region<wbr>Route<wbr>Builder</a></dt><dd>Builder for <a href="struct.RegionRoute.html"><code>RegionRoute</code></a>.</dd><dt><a class="struct" href="struct.RegionRoutes.html" title="struct common_meta::rpc::router::RegionRoutes">Region<wbr>Routes</a></dt><dt><a class="struct" href="struct.Table.html" title="struct common_meta::rpc::router::Table">Table</a></dt><dt><a class="struct" href="struct.TableRoute.html" title="struct common_meta::rpc::router::TableRoute">Table<wbr>Route</a></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.LeaderState.html" title="enum common_meta::rpc::router::LeaderState">Leader<wbr>State</a></dt><dd>The State of the <a href="struct.Region.html" title="struct common_meta::rpc::router::Region"><code>Region</code></a> Leader.
|
||
TODO(dennis): It’s better to add more fine-grained statuses such as <code>PENDING</code> etc.</dd><dt><a class="enum" href="enum.RegionRouteBuilderError.html" title="enum common_meta::rpc::router::RegionRouteBuilderError">Region<wbr>Route<wbr>Builder<wbr>Error</a></dt><dd>Error type for RegionRouteBuilder</dd><dt><a class="enum" href="enum.WriteRoutePolicy.html" title="enum common_meta::rpc::router::WriteRoutePolicy">Write<wbr>Route<wbr>Policy</a></dt><dd>The write route policy for the region.</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.as_utf8.html" title="fn common_meta::rpc::router::as_utf8">as_utf8</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.as_utf8_vec.html" title="fn common_meta::rpc::router::as_utf8_vec">as_<wbr>utf8_<wbr>vec</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.convert_to_region_leader_map.html" title="fn common_meta::rpc::router::convert_to_region_leader_map">convert_<wbr>to_<wbr>region_<wbr>leader_<wbr>map</a></dt><dd>Returns the HashMap<[RegionNumber], &<a href="../../peer/struct.Peer.html" title="struct common_meta::peer::Peer">Peer</a>>;</dd><dt><a class="fn" href="fn.find_follower_regions.html" title="fn common_meta::rpc::router::find_follower_regions">find_<wbr>follower_<wbr>regions</a></dt><dd>Returns the region numbers of the follower regions on the target datanode.</dd><dt><a class="fn" href="fn.find_followers.html" title="fn common_meta::rpc::router::find_followers">find_<wbr>followers</a></dt><dd>Returns the followers of the table.</dd><dt><a class="fn" href="fn.find_leader_regions.html" title="fn common_meta::rpc::router::find_leader_regions">find_<wbr>leader_<wbr>regions</a></dt><dd>Returns the region numbers of the leader regions on the target datanode.</dd><dt><a class="fn" href="fn.find_leaders.html" title="fn common_meta::rpc::router::find_leaders">find_<wbr>leaders</a></dt><dd>Returns the leader peers of the table.</dd><dt><a class="fn" href="fn.find_region_leader.html" title="fn common_meta::rpc::router::find_region_leader">find_<wbr>region_<wbr>leader</a></dt><dt><a class="fn" href="fn.from_utf8.html" title="fn common_meta::rpc::router::from_utf8">from_<wbr>utf8</a></dt><dt><a class="fn" href="fn.from_utf8_vec.html" title="fn common_meta::rpc::router::from_utf8_vec">from_<wbr>utf8_<wbr>vec</a></dt><dt><a class="fn" href="fn.operating_leader_region_roles.html" title="fn common_meta::rpc::router::operating_leader_region_roles">operating_<wbr>leader_<wbr>region_<wbr>roles</a></dt><dd>Returns the operating leader regions with corresponding <a href="../../type.DatanodeId.html" title="type common_meta::DatanodeId">DatanodeId</a> and [RegionRole].</dd><dt><a class="fn" href="fn.operating_leader_regions.html" title="fn common_meta::rpc::router::operating_leader_regions">operating_<wbr>leader_<wbr>regions</a></dt><dd>Returns the operating leader regions with corresponding <a href="../../type.DatanodeId.html" title="type common_meta::DatanodeId">DatanodeId</a>.</dd><dt><a class="fn" href="fn.pb_region_partition_expr.html" title="fn common_meta::rpc::router::pb_region_partition_expr">pb_<wbr>region_<wbr>partition_<wbr>expr</a></dt><dd>Gets the partition expression of the <code>PbRegion</code> in compatible mode.</dd><dt><a class="fn" href="fn.region_distribution.html" title="fn common_meta::rpc::router::region_distribution">region_<wbr>distribution</a></dt><dd>Returns the distribution of regions to datanodes.</dd></dl></section></div></main></body></html> |