mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-10 15:22:56 +00:00
32 lines
12 KiB
HTML
32 lines
12 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 `Server` trait in crate `servers`."><title>Server in servers::server - 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="#">Server</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.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Server</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.shutdown" title="shutdown">shutdown</a></li><li><a href="#tymethod.start" title="start">start</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.bind_addr" title="bind_addr">bind_addr</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In servers::<wbr>server</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">server</a></div><h1>Trait <span class="trait">Server</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/server.rs.html#134-150">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Server: <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> {
|
||
// Required methods
|
||
fn <a href="#tymethod.shutdown" class="fn">shutdown</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 servers::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.start" class="fn">start</a><'life0, 'async_trait>(
|
||
&'life0 mut self,
|
||
listening: <a class="enum" href="https://doc.rust-lang.org/nightly/core/net/socket_addr/enum.SocketAddr.html" title="enum core::net::socket_addr::SocketAddr">SocketAddr</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 servers::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.name" class="fn">name</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>;
|
||
|
||
// Provided method
|
||
fn <a href="#method.bind_addr" class="fn">bind_addr</a>(&self) -> <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="https://doc.rust-lang.org/nightly/core/net/socket_addr/enum.SocketAddr.html" title="enum core::net::socket_addr::SocketAddr">SocketAddr</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.shutdown" class="method"><a class="src rightside" href="../../src/servers/server.rs.html#136">Source</a><h4 class="code-header">fn <a href="#tymethod.shutdown" class="fn">shutdown</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 servers::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>Shutdown the server gracefully.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.start" class="method"><a class="src rightside" href="../../src/servers/server.rs.html#141">Source</a><h4 class="code-header">fn <a href="#tymethod.start" class="fn">start</a><'life0, 'async_trait>(
|
||
&'life0 mut self,
|
||
listening: <a class="enum" href="https://doc.rust-lang.org/nightly/core/net/socket_addr/enum.SocketAddr.html" title="enum core::net::socket_addr::SocketAddr">SocketAddr</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 servers::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 server and binds on <code>listening</code>.</p>
|
||
<p>Caller should ensure <code>start()</code> is only invoked once.</p>
|
||
</div></details><section id="tymethod.name" class="method"><a class="src rightside" href="../../src/servers/server.rs.html#143">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></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.bind_addr" class="method"><a class="src rightside" href="../../src/servers/server.rs.html#147-149">Source</a><h4 class="code-header">fn <a href="#method.bind_addr" class="fn">bind_addr</a>(&self) -> <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="https://doc.rust-lang.org/nightly/core/net/socket_addr/enum.SocketAddr.html" title="enum core::net::socket_addr::SocketAddr">SocketAddr</a>></h4></section></summary><div class="docblock"><p>Finds the actual bind address of this server.
|
||
If not found (returns <code>None</code>), maybe it’s not started yet, or just don’t have it.</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-Server-for-GrpcServer" class="impl"><a class="src rightside" href="../../src/servers/grpc.rs.html#313-407">Source</a><a href="#impl-Server-for-GrpcServer" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Server.html" title="trait servers::server::Server">Server</a> for <a class="struct" href="../grpc/struct.GrpcServer.html" title="struct servers::grpc::GrpcServer">GrpcServer</a></h3></section><section id="impl-Server-for-HttpServer" class="impl"><a class="src rightside" href="../../src/servers/http.rs.html#1203-1287">Source</a><a href="#impl-Server-for-HttpServer" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Server.html" title="trait servers::server::Server">Server</a> for <a class="struct" href="../http/struct.HttpServer.html" title="struct servers::http::HttpServer">HttpServer</a></h3></section><section id="impl-Server-for-MysqlServer" class="impl"><a class="src rightside" href="../../src/servers/mysql/server.rs.html#238-268">Source</a><a href="#impl-Server-for-MysqlServer" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Server.html" title="trait servers::server::Server">Server</a> for <a class="struct" href="../mysql/server/struct.MysqlServer.html" title="struct servers::mysql::server::MysqlServer">MysqlServer</a></h3></section><section id="impl-Server-for-PostgresServer" class="impl"><a class="src rightside" href="../../src/servers/postgres/server.rs.html#120-147">Source</a><a href="#impl-Server-for-PostgresServer" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Server.html" title="trait servers::server::Server">Server</a> for <a class="struct" href="../postgres/struct.PostgresServer.html" title="struct servers::postgres::PostgresServer">PostgresServer</a></h3></section></div><script src="../../trait.impl/servers/server/trait.Server.js" async></script></section></div></main></body></html> |