mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-09 06:42:57 +00:00
31 lines
16 KiB
HTML
31 lines
16 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 `FlowEngine` trait in crate `flow`."><title>FlowEngine 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-e56847b5.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.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="#">FlowEngine</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-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Flow<wbr>Engine</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.create_flow" title="create_flow">create_flow</a></li><li><a href="#tymethod.flow_exist" title="flow_exist">flow_exist</a></li><li><a href="#tymethod.flush_flow" title="flush_flow">flush_flow</a></li><li><a href="#tymethod.handle_flow_inserts" title="handle_flow_inserts">handle_flow_inserts</a></li><li><a href="#tymethod.handle_mark_window_dirty" title="handle_mark_window_dirty">handle_mark_window_dirty</a></li><li><a href="#tymethod.list_flows" title="list_flows">list_flows</a></li><li><a href="#tymethod.remove_flow" title="remove_flow">remove_flow</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"><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>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/flow/engine.rs.html#80-101">Source</a> </span></div><pre class="rust item-decl"><code>pub trait FlowEngine {
|
|
// Required methods
|
|
async fn <a href="#tymethod.create_flow" class="fn">create_flow</a>(
|
|
&self,
|
|
args: <a class="struct" href="struct.CreateFlowArgs.html" title="struct flow::engine::CreateFlowArgs">CreateFlowArgs</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>>, <a class="enum" href="../error/enum.Error.html" title="enum flow::error::Error">Error</a>>;
|
|
<span class="item-spacer"></span> async fn <a href="#tymethod.remove_flow" class="fn">remove_flow</a>(&self, flow_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <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>, <a class="enum" href="../error/enum.Error.html" title="enum flow::error::Error">Error</a>>;
|
|
<span class="item-spacer"></span> async fn <a href="#tymethod.flush_flow" class="fn">flush_flow</a>(&self, flow_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <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.usize.html">usize</a>, <a class="enum" href="../error/enum.Error.html" title="enum flow::error::Error">Error</a>>;
|
|
<span class="item-spacer"></span> async fn <a href="#tymethod.flow_exist" class="fn">flow_exist</a>(&self, flow_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <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.bool.html">bool</a>, <a class="enum" href="../error/enum.Error.html" title="enum flow::error::Error">Error</a>>;
|
|
<span class="item-spacer"></span> async fn <a href="#tymethod.list_flows" class="fn">list_flows</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>>, <a class="enum" href="../error/enum.Error.html" title="enum flow::error::Error">Error</a>>;
|
|
<span class="item-spacer"></span> async fn <a href="#tymethod.handle_flow_inserts" class="fn">handle_flow_inserts</a>(
|
|
&self,
|
|
request: InsertRequests,
|
|
) -> <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>, <a class="enum" href="../error/enum.Error.html" title="enum flow::error::Error">Error</a>>;
|
|
<span class="item-spacer"></span> async fn <a href="#tymethod.handle_mark_window_dirty" class="fn">handle_mark_window_dirty</a>(
|
|
&self,
|
|
req: DirtyWindowRequests,
|
|
) -> <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>, <a class="enum" href="../error/enum.Error.html" title="enum flow::error::Error">Error</a>>;
|
|
}</code></pre><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.create_flow" class="method"><a class="src rightside" href="../../src/flow/engine.rs.html#82">Source</a><h4 class="code-header">async fn <a href="#tymethod.create_flow" class="fn">create_flow</a>(&self, args: <a class="struct" href="struct.CreateFlowArgs.html" title="struct flow::engine::CreateFlowArgs">CreateFlowArgs</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>>, <a class="enum" href="../error/enum.Error.html" title="enum flow::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Create a flow using the provided arguments, return previous flow id if exists and is replaced</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.remove_flow" class="method"><a class="src rightside" href="../../src/flow/engine.rs.html#84">Source</a><h4 class="code-header">async fn <a href="#tymethod.remove_flow" class="fn">remove_flow</a>(&self, flow_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <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>, <a class="enum" href="../error/enum.Error.html" title="enum flow::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Remove a flow by its ID</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.flush_flow" class="method"><a class="src rightside" href="../../src/flow/engine.rs.html#86">Source</a><h4 class="code-header">async fn <a href="#tymethod.flush_flow" class="fn">flush_flow</a>(&self, flow_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <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.usize.html">usize</a>, <a class="enum" href="../error/enum.Error.html" title="enum flow::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Flush the flow, return the number of rows flushed</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.flow_exist" class="method"><a class="src rightside" href="../../src/flow/engine.rs.html#88">Source</a><h4 class="code-header">async fn <a href="#tymethod.flow_exist" class="fn">flow_exist</a>(&self, flow_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <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.bool.html">bool</a>, <a class="enum" href="../error/enum.Error.html" title="enum flow::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Check if the flow exists</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.list_flows" class="method"><a class="src rightside" href="../../src/flow/engine.rs.html#90">Source</a><h4 class="code-header">async fn <a href="#tymethod.list_flows" class="fn">list_flows</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>>, <a class="enum" href="../error/enum.Error.html" title="enum flow::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>List all flows</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.handle_flow_inserts" class="method"><a class="src rightside" href="../../src/flow/engine.rs.html#92-95">Source</a><h4 class="code-header">async fn <a href="#tymethod.handle_flow_inserts" class="fn">handle_flow_inserts</a>(
|
|
&self,
|
|
request: InsertRequests,
|
|
) -> <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>, <a class="enum" href="../error/enum.Error.html" title="enum flow::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Handle the insert requests for the flow</p>
|
|
</div></details><section id="tymethod.handle_mark_window_dirty" class="method"><a class="src rightside" href="../../src/flow/engine.rs.html#97-100">Source</a><h4 class="code-header">async fn <a href="#tymethod.handle_mark_window_dirty" class="fn">handle_mark_window_dirty</a>(
|
|
&self,
|
|
req: DirtyWindowRequests,
|
|
) -> <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>, <a class="enum" href="../error/enum.Error.html" title="enum flow::error::Error">Error</a>></h4></section></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"><section id="impl-FlowEngine-for-FlowDualEngine" class="impl"><a class="src rightside" href="../../src/flow/adapter/flownode_impl.rs.html#599-764">Source</a><a href="#impl-FlowEngine-for-FlowDualEngine" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FlowEngine.html" title="trait flow::engine::FlowEngine">FlowEngine</a> for <a class="struct" href="../adapter/flownode_impl/struct.FlowDualEngine.html" title="struct flow::adapter::flownode_impl::FlowDualEngine">FlowDualEngine</a></h3></section><section id="impl-FlowEngine-for-BatchingEngine" class="impl"><a class="src rightside" href="../../src/flow/batching_mode/engine.rs.html#695-723">Source</a><a href="#impl-FlowEngine-for-BatchingEngine" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FlowEngine.html" title="trait flow::engine::FlowEngine">FlowEngine</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-FlowEngine-for-StreamingEngine" class="impl"><a class="src rightside" href="../../src/flow/adapter/flownode_impl.rs.html#883-926">Source</a><a href="#impl-FlowEngine-for-StreamingEngine" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FlowEngine.html" title="trait flow::engine::FlowEngine">FlowEngine</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.FlowEngine.js" async></script></section></div></main></body></html> |