mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-09 23:02:55 +00:00
51 lines
13 KiB
HTML
51 lines
13 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="GrpcQueryInterceptor can track life cycle of a grpc request and customize or abort its execution at given point."><title>GrpcQueryInterceptor in servers::interceptor - 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="servers" 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 trait"><!--[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="#">GrpcQueryInterceptor</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../servers/index.html">servers</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="#">Grpc<wbr>Query<wbr>Interceptor</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error" title="Error">Error</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.post_execute" title="post_execute">post_execute</a></li><li><a href="#method.pre_bulk_insert" title="pre_bulk_insert">pre_bulk_insert</a></li><li><a href="#method.pre_execute" title="pre_execute">pre_execute</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-GrpcQueryInterceptor-for-Option%3C%26Arc%3Cdyn+GrpcQueryInterceptor%3CError+=+E%3E+%2B+Send+%2B+Sync%3E%3E" title="Option<&GrpcQueryInterceptorRef<E>>">Option<&GrpcQueryInterceptorRef<E>></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In servers::<wbr>interceptor</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">servers</a>::<wbr><a href="index.html">interceptor</a></div><h1>Trait <span class="trait">Grpc<wbr>Query<wbr>Interceptor</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/servers/interceptor.rs.html#140-170">Source</a> </span></div><pre class="rust item-decl"><code>pub trait GrpcQueryInterceptor {
|
|
type <a href="#associatedtype.Error" class="associatedtype">Error</a>: ErrorExt;
|
|
|
|
// Provided methods
|
|
fn <a href="#method.pre_execute" class="fn">pre_execute</a>(
|
|
&self,
|
|
_request: &Request,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.GrpcQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::GrpcQueryInterceptor::Error">Error</a>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.pre_bulk_insert" class="fn">pre_bulk_insert</a>(
|
|
&self,
|
|
_table: TableRef,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.GrpcQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::GrpcQueryInterceptor::Error">Error</a>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.post_execute" class="fn">post_execute</a>(
|
|
&self,
|
|
output: Output,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Output, Self::<a class="associatedtype" href="trait.GrpcQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::GrpcQueryInterceptor::Error">Error</a>> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>GrpcQueryInterceptor can track life cycle of a grpc request and customize or
|
|
abort its execution at given point.</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.Error" class="method"><a class="src rightside" href="../../src/servers/interceptor.rs.html#141">Source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a>: ErrorExt</h4></section></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.pre_execute" class="method"><a class="src rightside" href="../../src/servers/interceptor.rs.html#144-150">Source</a><h4 class="code-header">fn <a href="#method.pre_execute" class="fn">pre_execute</a>(
|
|
&self,
|
|
_request: &Request,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.GrpcQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::GrpcQueryInterceptor::Error">Error</a>></h4></section></summary><div class="docblock"><p>Called before request is actually executed.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.pre_bulk_insert" class="method"><a class="src rightside" href="../../src/servers/interceptor.rs.html#153-159">Source</a><h4 class="code-header">fn <a href="#method.pre_bulk_insert" class="fn">pre_bulk_insert</a>(
|
|
&self,
|
|
_table: TableRef,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.GrpcQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::GrpcQueryInterceptor::Error">Error</a>></h4></section></summary><div class="docblock"><p>Called before bulk insert is executed.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.post_execute" class="method"><a class="src rightside" href="../../src/servers/interceptor.rs.html#163-169">Source</a><h4 class="code-header">fn <a href="#method.post_execute" class="fn">post_execute</a>(
|
|
&self,
|
|
output: Output,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Output, Self::<a class="associatedtype" href="trait.GrpcQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::GrpcQueryInterceptor::Error">Error</a>></h4></section></summary><div class="docblock"><p>Called after execution finished. The implementation can modify the
|
|
output if needed.</p>
|
|
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-GrpcQueryInterceptor-for-Option%3C%26Arc%3Cdyn+GrpcQueryInterceptor%3CError+=+E%3E+%2B+Send+%2B+Sync%3E%3E" class="impl"><a class="src rightside" href="../../src/servers/interceptor.rs.html#175-216">Source</a><a href="#impl-GrpcQueryInterceptor-for-Option%3C%26Arc%3Cdyn+GrpcQueryInterceptor%3CError+=+E%3E+%2B+Send+%2B+Sync%3E%3E" class="anchor">§</a><h3 class="code-header">impl<E> <a class="trait" href="trait.GrpcQueryInterceptor.html" title="trait servers::interceptor::GrpcQueryInterceptor">GrpcQueryInterceptor</a> for <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="type" href="type.GrpcQueryInterceptorRef.html" title="type servers::interceptor::GrpcQueryInterceptorRef">GrpcQueryInterceptorRef</a><E>><div class="where">where
|
|
E: ErrorExt,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/servers/interceptor.rs.html#179">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = E</h4></section><section id="method.pre_execute-1" class="method trait-impl"><a class="src rightside" href="../../src/servers/interceptor.rs.html#181-191">Source</a><a href="#method.pre_execute-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.pre_execute" class="fn">pre_execute</a>(
|
|
&self,
|
|
_request: &Request,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.GrpcQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::GrpcQueryInterceptor::Error">Error</a>></h4></section><section id="method.pre_bulk_insert-1" class="method trait-impl"><a class="src rightside" href="../../src/servers/interceptor.rs.html#193-203">Source</a><a href="#method.pre_bulk_insert-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.pre_bulk_insert" class="fn">pre_bulk_insert</a>(
|
|
&self,
|
|
_table: TableRef,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.GrpcQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::GrpcQueryInterceptor::Error">Error</a>></h4></section><section id="method.post_execute-1" class="method trait-impl"><a class="src rightside" href="../../src/servers/interceptor.rs.html#205-215">Source</a><a href="#method.post_execute-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.post_execute" class="fn">post_execute</a>(
|
|
&self,
|
|
output: Output,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Output, Self::<a class="associatedtype" href="trait.GrpcQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::GrpcQueryInterceptor::Error">Error</a>></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/servers/interceptor/trait.GrpcQueryInterceptor.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html> |