Files
greptimedb/api/v1/meta/cluster_server/trait.Cluster.html
T

43 lines
13 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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="Generated trait containing gRPC methods that should be implemented for use with ClusterServer."><title>Cluster in api::v1::meta::cluster_server - 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="api" 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="#">Cluster</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../api/index.html">api</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="#">Cluster</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.batch_get" title="batch_get">batch_get</a></li><li><a href="#tymethod.metasrv_peers" title="metasrv_peers">metasrv_peers</a></li><li><a href="#tymethod.range" title="range">range</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In api::<wbr>v1::<wbr>meta::<wbr>cluster_<wbr>server</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">api</a>::<wbr><a href="../../index.html">v1</a>::<wbr><a href="../index.html">meta</a>::<wbr><a href="index.html">cluster_server</a></div><h1>Trait <span class="trait">Cluster</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"></span></div><pre class="rust item-decl"><code>pub trait Cluster:
<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>
+ 'static {
// Required methods
fn <a href="#tymethod.batch_get" class="fn">batch_get</a>&lt;'life0, 'async_trait&gt;(
&amp;'life0 self,
request: Request&lt;<a class="struct" href="../struct.BatchGetRequest.html" title="struct api::v1::meta::BatchGetRequest">BatchGetRequest</a>&gt;,
) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.98.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>&lt;Output = <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Response&lt;<a class="struct" href="../struct.BatchGetResponse.html" title="struct api::v1::meta::BatchGetResponse">BatchGetResponse</a>&gt;, Status&gt;&gt; + <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait&gt;&gt;
<span class="where">where 'life0: 'async_trait,
Self: 'async_trait</span>;
<span class="item-spacer"></span> fn <a href="#tymethod.range" class="fn">range</a>&lt;'life0, 'async_trait&gt;(
&amp;'life0 self,
request: Request&lt;<a class="struct" href="../struct.RangeRequest.html" title="struct api::v1::meta::RangeRequest">RangeRequest</a>&gt;,
) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.98.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>&lt;Output = <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Response&lt;<a class="struct" href="../struct.RangeResponse.html" title="struct api::v1::meta::RangeResponse">RangeResponse</a>&gt;, Status&gt;&gt; + <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait&gt;&gt;
<span class="where">where 'life0: 'async_trait,
Self: 'async_trait</span>;
<span class="item-spacer"></span> fn <a href="#tymethod.metasrv_peers" class="fn">metasrv_peers</a>&lt;'life0, 'async_trait&gt;(
&amp;'life0 self,
request: Request&lt;<a class="struct" href="../struct.MetasrvPeersRequest.html" title="struct api::v1::meta::MetasrvPeersRequest">MetasrvPeersRequest</a>&gt;,
) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.98.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>&lt;Output = <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Response&lt;<a class="struct" href="../struct.MetasrvPeersResponse.html" title="struct api::v1::meta::MetasrvPeersResponse">MetasrvPeersResponse</a>&gt;, Status&gt;&gt; + <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait&gt;&gt;
<span class="where">where 'life0: 'async_trait,
Self: 'async_trait</span>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Generated trait containing gRPC methods that should be implemented for use with ClusterServer.</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.batch_get" class="method"><h4 class="code-header">fn <a href="#tymethod.batch_get" class="fn">batch_get</a>&lt;'life0, 'async_trait&gt;(
&amp;'life0 self,
request: Request&lt;<a class="struct" href="../struct.BatchGetRequest.html" title="struct api::v1::meta::BatchGetRequest">BatchGetRequest</a>&gt;,
) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.98.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>&lt;Output = <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Response&lt;<a class="struct" href="../struct.BatchGetResponse.html" title="struct api::v1::meta::BatchGetResponse">BatchGetResponse</a>&gt;, Status&gt;&gt; + <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait&gt;&gt;<div class="where">where
'life0: 'async_trait,
Self: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Batch get kvs by input keys from leader’s in_memory kv store.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.range" class="method"><h4 class="code-header">fn <a href="#tymethod.range" class="fn">range</a>&lt;'life0, 'async_trait&gt;(
&amp;'life0 self,
request: Request&lt;<a class="struct" href="../struct.RangeRequest.html" title="struct api::v1::meta::RangeRequest">RangeRequest</a>&gt;,
) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.98.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>&lt;Output = <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Response&lt;<a class="struct" href="../struct.RangeResponse.html" title="struct api::v1::meta::RangeResponse">RangeResponse</a>&gt;, Status&gt;&gt; + <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait&gt;&gt;<div class="where">where
'life0: 'async_trait,
Self: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Range get the kvs from leader’s in_memory kv store.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.metasrv_peers" class="method"><h4 class="code-header">fn <a href="#tymethod.metasrv_peers" class="fn">metasrv_peers</a>&lt;'life0, 'async_trait&gt;(
&amp;'life0 self,
request: Request&lt;<a class="struct" href="../struct.MetasrvPeersRequest.html" title="struct api::v1::meta::MetasrvPeersRequest">MetasrvPeersRequest</a>&gt;,
) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.98.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>&lt;Output = <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Response&lt;<a class="struct" href="../struct.MetasrvPeersResponse.html" title="struct api::v1::meta::MetasrvPeersResponse">MetasrvPeersResponse</a>&gt;, Status&gt;&gt; + <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait&gt;&gt;<div class="where">where
'life0: 'async_trait,
Self: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Returns all the peers of metasrv.</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><script src="../../../../trait.impl/greptime_proto/v1/meta/cluster_server/trait.Cluster.js" async></script></section></div></main></body></html>