mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-08 14:22:58 +00:00
77 lines
21 KiB
HTML
77 lines
21 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="`ProcedureManager` executes Procedure submitted to it."><title>ProcedureManager in common_procedure - 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="common_procedure" 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="#">ProcedureManager</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../common_procedure/index.html">common_<wbr>procedure</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="#">Procedure<wbr>Manager</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.list_procedures" title="list_procedures">list_procedures</a></li><li><a href="#tymethod.procedure_state" title="procedure_state">procedure_state</a></li><li><a href="#tymethod.procedure_watcher" title="procedure_watcher">procedure_watcher</a></li><li><a href="#tymethod.register_loader" title="register_loader">register_loader</a></li><li><a href="#tymethod.start" title="start">start</a></li><li><a href="#tymethod.stop" title="stop">stop</a></li><li><a href="#tymethod.submit" title="submit">submit</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate common_<wbr>procedure</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">common_procedure</a></div><h1>Trait <span class="trait">Procedure<wbr>Manager</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_procedure/procedure.rs.html#567-596">Source</a> </span></div><pre class="rust item-decl"><code>pub trait ProcedureManager:
|
||
<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>
|
||
+ <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>
|
||
+ 'static {
|
||
// Required methods
|
||
fn <a href="#tymethod.register_loader" class="fn">register_loader</a>(
|
||
&self,
|
||
name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
||
loader: <a class="type" href="type.BoxedProcedureLoader.html" title="type common_procedure::BoxedProcedureLoader">BoxedProcedureLoader</a>,
|
||
) -> <a class="type" href="error/type.Result.html" title="type common_procedure::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.start" class="fn">start</a><'life0, 'async_trait>(
|
||
&'life0 self,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="error/type.Result.html" title="type common_procedure::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
||
<span class="where">where Self: 'async_trait,
|
||
'life0: 'async_trait</span>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.stop" class="fn">stop</a><'life0, 'async_trait>(
|
||
&'life0 self,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="error/type.Result.html" title="type common_procedure::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
||
<span class="where">where Self: 'async_trait,
|
||
'life0: 'async_trait</span>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.submit" class="fn">submit</a><'life0, 'async_trait>(
|
||
&'life0 self,
|
||
procedure: <a class="struct" href="struct.ProcedureWithId.html" title="struct common_procedure::ProcedureWithId">ProcedureWithId</a>,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="error/type.Result.html" title="type common_procedure::error::Result">Result</a><<a class="type" href="watcher/type.Watcher.html" title="type common_procedure::watcher::Watcher">Watcher</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
||
<span class="where">where Self: 'async_trait,
|
||
'life0: 'async_trait</span>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.procedure_state" class="fn">procedure_state</a><'life0, 'async_trait>(
|
||
&'life0 self,
|
||
procedure_id: <a class="struct" href="struct.ProcedureId.html" title="struct common_procedure::ProcedureId">ProcedureId</a>,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="error/type.Result.html" title="type common_procedure::error::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="enum" href="enum.ProcedureState.html" title="enum common_procedure::ProcedureState">ProcedureState</a>>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
||
<span class="where">where Self: 'async_trait,
|
||
'life0: 'async_trait</span>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.procedure_watcher" class="fn">procedure_watcher</a>(&self, procedure_id: <a class="struct" href="struct.ProcedureId.html" title="struct common_procedure::ProcedureId">ProcedureId</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="type" href="watcher/type.Watcher.html" title="type common_procedure::watcher::Watcher">Watcher</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.list_procedures" class="fn">list_procedures</a><'life0, 'async_trait>(
|
||
&'life0 self,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="error/type.Result.html" title="type common_procedure::error::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="struct.ProcedureInfo.html" title="struct common_procedure::ProcedureInfo">ProcedureInfo</a>>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
||
<span class="where">where Self: 'async_trait,
|
||
'life0: 'async_trait</span>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>ProcedureManager</code> executes <a href="trait.Procedure.html" title="trait common_procedure::Procedure">Procedure</a> submitted to it.</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.register_loader" class="method"><a class="src rightside" href="../src/common_procedure/procedure.rs.html#569">Source</a><h4 class="code-header">fn <a href="#tymethod.register_loader" class="fn">register_loader</a>(
|
||
&self,
|
||
name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
||
loader: <a class="type" href="type.BoxedProcedureLoader.html" title="type common_procedure::BoxedProcedureLoader">BoxedProcedureLoader</a>,
|
||
) -> <a class="type" href="error/type.Result.html" title="type common_procedure::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Registers loader for specific procedure type <code>name</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.start" class="method"><a class="src rightside" href="../src/common_procedure/procedure.rs.html#576">Source</a><h4 class="code-header">fn <a href="#tymethod.start" class="fn">start</a><'life0, 'async_trait>(
|
||
&'life0 self,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="error/type.Result.html" title="type common_procedure::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
||
Self: 'async_trait,
|
||
'life0: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Starts the background GC task.</p>
|
||
<p>Recovers unfinished procedures and reruns them.</p>
|
||
<p>Callers should ensure all loaders are registered.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.stop" class="method"><a class="src rightside" href="../src/common_procedure/procedure.rs.html#579">Source</a><h4 class="code-header">fn <a href="#tymethod.stop" class="fn">stop</a><'life0, 'async_trait>(
|
||
&'life0 self,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="error/type.Result.html" title="type common_procedure::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
||
Self: 'async_trait,
|
||
'life0: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Stops the background GC task.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.submit" class="method"><a class="src rightside" href="../src/common_procedure/procedure.rs.html#584">Source</a><h4 class="code-header">fn <a href="#tymethod.submit" class="fn">submit</a><'life0, 'async_trait>(
|
||
&'life0 self,
|
||
procedure: <a class="struct" href="struct.ProcedureWithId.html" title="struct common_procedure::ProcedureWithId">ProcedureWithId</a>,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="error/type.Result.html" title="type common_procedure::error::Result">Result</a><<a class="type" href="watcher/type.Watcher.html" title="type common_procedure::watcher::Watcher">Watcher</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
||
Self: 'async_trait,
|
||
'life0: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Submits a procedure to execute.</p>
|
||
<p>Returns a <a href="watcher/type.Watcher.html" title="type common_procedure::watcher::Watcher">Watcher</a> to watch the created procedure.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.procedure_state" class="method"><a class="src rightside" href="../src/common_procedure/procedure.rs.html#589">Source</a><h4 class="code-header">fn <a href="#tymethod.procedure_state" class="fn">procedure_state</a><'life0, 'async_trait>(
|
||
&'life0 self,
|
||
procedure_id: <a class="struct" href="struct.ProcedureId.html" title="struct common_procedure::ProcedureId">ProcedureId</a>,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="error/type.Result.html" title="type common_procedure::error::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="enum" href="enum.ProcedureState.html" title="enum common_procedure::ProcedureState">ProcedureState</a>>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
||
Self: 'async_trait,
|
||
'life0: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Query the procedure state.</p>
|
||
<p>Returns <code>Ok(None)</code> if the procedure doesn’t exist.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.procedure_watcher" class="method"><a class="src rightside" href="../src/common_procedure/procedure.rs.html#592">Source</a><h4 class="code-header">fn <a href="#tymethod.procedure_watcher" class="fn">procedure_watcher</a>(&self, procedure_id: <a class="struct" href="struct.ProcedureId.html" title="struct common_procedure::ProcedureId">ProcedureId</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="type" href="watcher/type.Watcher.html" title="type common_procedure::watcher::Watcher">Watcher</a>></h4></section></summary><div class="docblock"><p>Returns a <a href="watcher/type.Watcher.html" title="type common_procedure::watcher::Watcher">Watcher</a> to watch <a href="enum.ProcedureState.html" title="enum common_procedure::ProcedureState">ProcedureState</a> of specific procedure.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.list_procedures" class="method"><a class="src rightside" href="../src/common_procedure/procedure.rs.html#595">Source</a><h4 class="code-header">fn <a href="#tymethod.list_procedures" class="fn">list_procedures</a><'life0, 'async_trait>(
|
||
&'life0 self,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="error/type.Result.html" title="type common_procedure::error::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="struct.ProcedureInfo.html" title="struct common_procedure::ProcedureInfo">ProcedureInfo</a>>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
||
Self: 'async_trait,
|
||
'life0: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Returns the details of the procedure.</p>
|
||
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-ProcedureManager-for-LocalManager" class="impl"><a class="src rightside" href="../src/common_procedure/local.rs.html#801-874">Source</a><a href="#impl-ProcedureManager-for-LocalManager" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ProcedureManager.html" title="trait common_procedure::ProcedureManager">ProcedureManager</a> for <a class="struct" href="local/struct.LocalManager.html" title="struct common_procedure::local::LocalManager">LocalManager</a></h3></section></div><script src="../trait.impl/common_procedure/procedure/trait.ProcedureManager.js" async></script></section></div></main></body></html> |