mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-08 14:22:58 +00:00
45 lines
16 KiB
HTML
45 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 `App` trait in crate `cmd`."><title>App in cmd - 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="cmd" 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="#">App</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../cmd/index.html">cmd</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="#">App</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.name" title="name">name</a></li><li><a href="#tymethod.start" title="start">start</a></li><li><a href="#tymethod.stop" title="stop">stop</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.pre_start" title="pre_start">pre_start</a></li><li><a href="#method.run" title="run">run</a></li><li><a href="#method.wait_signal" title="wait_signal">wait_signal</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 cmd</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">cmd</a></div><h1>Trait <span class="trait">App</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/cmd/lib.rs.html#72-109">Source</a> </span></div><pre class="rust item-decl"><code>pub trait App: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> {
|
|
// Required methods
|
|
fn <a href="#tymethod.name" class="fn">name</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.start" class="fn">start</a><'life0, 'async_trait>(
|
|
&'life0 mut 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 cmd::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 mut 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 cmd::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>;
|
|
|
|
// Provided methods
|
|
fn <a href="#method.pre_start" class="fn">pre_start</a><'life0, 'async_trait>(
|
|
&'life0 mut 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 cmd::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="#method.wait_signal" class="fn">wait_signal</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.run" class="fn">run</a><'life0, 'async_trait>(
|
|
&'life0 mut 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 cmd::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> { ... }
|
|
}</code></pre><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.name" class="method"><a class="src rightside" href="../src/cmd/lib.rs.html#73">Source</a><h4 class="code-header">fn <a href="#tymethod.name" class="fn">name</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section><section id="tymethod.start" class="method"><a class="src rightside" href="../src/cmd/lib.rs.html#80">Source</a><h4 class="code-header">fn <a href="#tymethod.start" class="fn">start</a><'life0, 'async_trait>(
|
|
&'life0 mut 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 cmd::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><section id="tymethod.stop" class="method"><a class="src rightside" href="../src/cmd/lib.rs.html#87">Source</a><h4 class="code-header">fn <a href="#tymethod.stop" class="fn">stop</a><'life0, 'async_trait>(
|
|
&'life0 mut 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 cmd::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></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_start" class="method"><a class="src rightside" href="../src/cmd/lib.rs.html#76-78">Source</a><h4 class="code-header">fn <a href="#method.pre_start" class="fn">pre_start</a><'life0, 'async_trait>(
|
|
&'life0 mut 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 cmd::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>A hook for implementor to make something happened before actual startup. Defaults to no-op.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.wait_signal" class="method"><a class="src rightside" href="../src/cmd/lib.rs.html#83-85">Source</a><h4 class="code-header">fn <a href="#method.wait_signal" class="fn">wait_signal</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Waits the quit signal by default.</p>
|
|
</div></details><section id="method.run" class="method"><a class="src rightside" href="../src/cmd/lib.rs.html#89-108">Source</a><h4 class="code-header">fn <a href="#method.run" class="fn">run</a><'life0, 'async_trait>(
|
|
&'life0 mut 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 cmd::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></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-App-for-Instance" class="impl"><a class="src rightside" href="../src/cmd/cli.rs.html#48-64">Source</a><a href="#impl-App-for-Instance" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.App.html" title="trait cmd::App">App</a> for cmd::cli::<a class="struct" href="cli/struct.Instance.html" title="struct cmd::cli::Instance">Instance</a></h3></section><section id="impl-App-for-Instance-1" class="impl"><a class="src rightside" href="../src/cmd/datanode.rs.html#73-92">Source</a><a href="#impl-App-for-Instance-1" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.App.html" title="trait cmd::App">App</a> for cmd::datanode::<a class="struct" href="datanode/struct.Instance.html" title="struct cmd::datanode::Instance">Instance</a></h3></section><section id="impl-App-for-Instance-2" class="impl"><a class="src rightside" href="../src/cmd/flownode.rs.html#84-103">Source</a><a href="#impl-App-for-Instance-2" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.App.html" title="trait cmd::App">App</a> for cmd::flownode::<a class="struct" href="flownode/struct.Instance.html" title="struct cmd::flownode::Instance">Instance</a></h3></section><section id="impl-App-for-Instance-3" class="impl"><a class="src rightside" href="../src/cmd/frontend.rs.html#89-112">Source</a><a href="#impl-App-for-Instance-3" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.App.html" title="trait cmd::App">App</a> for cmd::frontend::<a class="struct" href="frontend/struct.Instance.html" title="struct cmd::frontend::Instance">Instance</a></h3></section><section id="impl-App-for-Instance-4" class="impl"><a class="src rightside" href="../src/cmd/metasrv.rs.html#65-84">Source</a><a href="#impl-App-for-Instance-4" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.App.html" title="trait cmd::App">App</a> for cmd::metasrv::<a class="struct" href="metasrv/struct.Instance.html" title="struct cmd::metasrv::Instance">Instance</a></h3></section><section id="impl-App-for-Instance-5" class="impl"><a class="src rightside" href="../src/cmd/standalone.rs.html#136-193">Source</a><a href="#impl-App-for-Instance-5" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.App.html" title="trait cmd::App">App</a> for cmd::standalone::<a class="struct" href="standalone/struct.Instance.html" title="struct cmd::standalone::Instance">Instance</a></h3></section></div><script src="../trait.impl/cmd/trait.App.js" async></script></section></div></main></body></html> |