mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
73 lines
11 KiB
HTML
73 lines
11 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` mod in crate `hyper`."><meta name="keywords" content="rust, rustlang, rust-lang, server"><title>hyper::server - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../hyper/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module server</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li></ul></div><p class="location"><a href="../index.html">hyper</a></p><div id="sidebar-vars" data-name="server" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">hyper</a>::<wbr><a class="mod" href="">server</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/hyper/server/mod.rs.html#1-105" title="goto source code">[src]</a></span></h1><div class="docblock"><p>HTTP Server</p>
|
||
<p>A <code>Server</code> is created to listen on a port, parse HTTP requests, and hand
|
||
them off to a <code>Service</code>.</p>
|
||
<p>There are two levels of APIs provide for constructing HTTP servers:</p>
|
||
<ul>
|
||
<li>The higher-level <a href="../../hyper/server/struct.Server.html"><code>Server</code></a> type.</li>
|
||
<li>The lower-level <a href="../../hyper/server/conn/index.html"><code>conn</code></a> module.</li>
|
||
</ul>
|
||
<h1 id="server" class="section-header"><a href="#server">Server</a></h1>
|
||
<p>The <a href="../../hyper/server/struct.Server.html"><code>Server</code></a> is main way to start listening for HTTP requests.
|
||
It wraps a listener with a <a href="../../hyper/service/index.html"><code>MakeService</code></a>, and then should
|
||
be executed to start serving requests.</p>
|
||
<p><a href="../../hyper/server/struct.Server.html"><code>Server</code></a> accepts connections in both HTTP1 and HTTP2 by default.</p>
|
||
<h2 id="example" class="section-header"><a href="#example">Example</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">convert</span>::<span class="ident">Infallible</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">net</span>::<span class="ident">SocketAddr</span>;
|
||
<span class="kw">use</span> <span class="ident">hyper</span>::{<span class="ident">Body</span>, <span class="ident">Request</span>, <span class="ident">Response</span>, <span class="ident">Server</span>};
|
||
<span class="kw">use</span> <span class="ident">hyper</span>::<span class="ident">service</span>::{<span class="ident">make_service_fn</span>, <span class="ident">service_fn</span>};
|
||
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">handle</span>(<span class="ident">_req</span>: <span class="ident">Request</span><span class="op"><</span><span class="ident">Body</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Response</span><span class="op"><</span><span class="ident">Body</span><span class="op">></span>, <span class="ident">Infallible</span><span class="op">></span> {
|
||
<span class="prelude-val">Ok</span>(<span class="ident">Response</span>::<span class="ident">new</span>(<span class="ident">Body</span>::<span class="ident">from</span>(<span class="string">"Hello World"</span>)))
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="comment">// Construct our SocketAddr to listen on...</span>
|
||
<span class="kw">let</span> <span class="ident">addr</span> <span class="op">=</span> <span class="ident">SocketAddr</span>::<span class="ident">from</span>(([<span class="number">127</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">1</span>], <span class="number">3000</span>));
|
||
|
||
<span class="comment">// And a MakeService to handle each connection...</span>
|
||
<span class="kw">let</span> <span class="ident">make_service</span> <span class="op">=</span> <span class="ident">make_service_fn</span>(<span class="op">|</span><span class="ident">_conn</span><span class="op">|</span> <span class="kw">async</span> {
|
||
<span class="prelude-val">Ok</span>::<span class="op"><</span><span class="kw">_</span>, <span class="ident">Infallible</span><span class="op">></span>(<span class="ident">service_fn</span>(<span class="ident">handle</span>))
|
||
});
|
||
|
||
<span class="comment">// Then bind and serve...</span>
|
||
<span class="kw">let</span> <span class="ident">server</span> <span class="op">=</span> <span class="ident">Server</span>::<span class="ident">bind</span>(<span class="kw-2">&</span><span class="ident">addr</span>).<span class="ident">serve</span>(<span class="ident">make_service</span>);
|
||
|
||
<span class="comment">// And run forever...</span>
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span> <span class="ident">server</span>.<span class="kw">await</span> {
|
||
<span class="macro">eprintln</span><span class="macro">!</span>(<span class="string">"server error: {}"</span>, <span class="ident">e</span>);
|
||
}
|
||
}</pre></div>
|
||
<p>If you don't need the connection and your service implements <code>Clone</code> you can use
|
||
<a href="https://docs.rs/tower/latest/tower/make/struct.Shared.html"><code>tower::make::Shared</code></a> instead of <code>make_service_fn</code> which is a bit simpler:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="comment">// Construct our SocketAddr to listen on...</span>
|
||
<span class="kw">let</span> <span class="ident">addr</span> <span class="op">=</span> <span class="ident">SocketAddr</span>::<span class="ident">from</span>(([<span class="number">127</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">1</span>], <span class="number">3000</span>));
|
||
|
||
<span class="comment">// Shared is a MakeService that produces services by cloning an inner service...</span>
|
||
<span class="kw">let</span> <span class="ident">make_service</span> <span class="op">=</span> <span class="ident">Shared</span>::<span class="ident">new</span>(<span class="ident">service_fn</span>(<span class="ident">handle</span>));
|
||
|
||
<span class="comment">// Then bind and serve...</span>
|
||
<span class="kw">let</span> <span class="ident">server</span> <span class="op">=</span> <span class="ident">Server</span>::<span class="ident">bind</span>(<span class="kw-2">&</span><span class="ident">addr</span>).<span class="ident">serve</span>(<span class="ident">make_service</span>);
|
||
|
||
<span class="comment">// And run forever...</span>
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span> <span class="ident">server</span>.<span class="kw">await</span> {
|
||
<span class="macro">eprintln</span><span class="macro">!</span>(<span class="string">"server error: {}"</span>, <span class="ident">e</span>);
|
||
}
|
||
}</pre></div>
|
||
</div><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2>
|
||
<table><tr class="module-item"><td><a class="mod" href="accept/index.html" title="hyper::server::accept mod">accept</a></td><td class="docblock-short"><p>The <code>Accept</code> trait and supporting types.</p>
|
||
</td></tr><tr class="module-item"><td><a class="mod" href="conn/index.html" title="hyper::server::conn mod">conn</a></td><td class="docblock-short"><p>Lower-level Server connection API.</p>
|
||
</td></tr></table><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.Builder.html" title="hyper::server::Builder struct">Builder</a></td><td class="docblock-short"><p>A builder for a <a href="../../hyper/server/struct.Server.html"><code>Server</code></a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Server.html" title="hyper::server::Server struct">Server</a></td><td class="docblock-short"><p>A listening HTTP server that accepts connections in both HTTP1 and HTTP2 by default.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="hyper"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |