Files
greptimedb/flow/engine/trait.FlowStatProvider.html
2026-05-07 08:21:56 +00:00

6 lines
5.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="Provides flow runtime statistics for information schema and heartbeat reporting."><title>FlowStatProvider in flow::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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="flow" 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 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="#">FlowStatProvider</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../flow/index.html">flow</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Flow<wbr>Stat<wbr>Provider</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.flow_stat" title="flow_stat">flow_stat</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In flow::<wbr>engine</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">flow</a>::<wbr><a href="index.html">engine</a></div><h1>Trait <span class="trait">Flow<wbr>Stat<wbr>Provider</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/flow/engine.rs.html#105-108">Source</a> </span></div><pre class="rust item-decl"><code>pub trait FlowStatProvider {
// Required method
async fn <a href="#tymethod.flow_stat" class="fn">flow_stat</a>(&amp;self) -&gt; FlowStat;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Provides flow runtime statistics for information schema and heartbeat reporting.</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.flow_stat" class="method"><a class="src rightside" href="../../src/flow/engine.rs.html#107">Source</a><h4 class="code-header">async fn <a href="#tymethod.flow_stat" class="fn">flow_stat</a>(&amp;self) -&gt; FlowStat</h4></section></summary><div class="docblock"><p>Returns current runtime stats of an engine.</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 is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><div class="negative-marker"></div><section id="impl-FlowStatProvider-for-BatchingEngine" class="impl"><a class="src rightside" href="../../src/flow/batching_mode/engine.rs.html#336-348">Source</a><a href="#impl-FlowStatProvider-for-BatchingEngine" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FlowStatProvider.html" title="trait flow::engine::FlowStatProvider">FlowStatProvider</a> for <a class="struct" href="../batching_mode/engine/struct.BatchingEngine.html" title="struct flow::batching_mode::engine::BatchingEngine">BatchingEngine</a></h3></section><section id="impl-FlowStatProvider-for-StreamingEngine" class="impl"><a class="src rightside" href="../../src/flow/adapter/stat.rs.html#22-53">Source</a><a href="#impl-FlowStatProvider-for-StreamingEngine" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FlowStatProvider.html" title="trait flow::engine::FlowStatProvider">FlowStatProvider</a> for <a class="struct" href="../struct.StreamingEngine.html" title="struct flow::StreamingEngine">StreamingEngine</a></h3></section></div><script src="../../trait.impl/flow/engine/trait.FlowStatProvider.js" async></script></section></div></main></body></html>