| <!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="HTTP Server"><meta name="keywords" content="rust, rustlang, rust-lang, server"><title>hyper::server - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../hyper/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../hyper/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module server</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">hyper</a>::<wbr><a class="mod" href="#">server</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/hyper/server/mod.rs.html#1-173">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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="struct.Server.html"><code>Server</code></a> type.</li> |
| <li>The lower-level <a href="conn/index.html"><code>conn</code></a> module.</li> |
| </ul> |
| <h2 id="server"><a href="#server">Server</a></h2> |
| <p>The <a href="struct.Server.html"><code>Server</code></a> is main way to start listening for HTTP requests. |
| It wraps a listener with a <a href="../service/index.html"><code>MakeService</code></a>, and then should |
| be executed to start serving requests.</p> |
| <p><a href="struct.Server.html"><code>Server</code></a> accepts connections in both HTTP1 and HTTP2 by default.</p> |
| <h3 id="examples"><a href="#examples">Examples</a></h3> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::convert::Infallible; |
| <span class="kw">use </span>std::net::SocketAddr; |
| <span class="kw">use </span>hyper::{Body, Request, Response, Server}; |
| <span class="kw">use </span>hyper::service::{make_service_fn, service_fn}; |
| |
| <span class="kw">async fn </span>handle(_req: Request<Body>) -> <span class="prelude-ty">Result</span><Response<Body>, Infallible> { |
| <span class="prelude-val">Ok</span>(Response::new(Body::from(<span class="string">"Hello World"</span>))) |
| } |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="comment">// Construct our SocketAddr to listen on... |
| </span><span class="kw">let </span>addr = SocketAddr::from(([<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>make_service = make_service_fn(|_conn| <span class="kw">async </span>{ |
| <span class="prelude-val">Ok</span>::<<span class="kw">_</span>, Infallible>(service_fn(handle)) |
| }); |
| |
| <span class="comment">// Then bind and serve... |
| </span><span class="kw">let </span>server = Server::bind(<span class="kw-2">&</span>addr).serve(make_service); |
| |
| <span class="comment">// And run forever... |
| </span><span class="kw">if let </span><span class="prelude-val">Err</span>(e) = server.<span class="kw">await </span>{ |
| <span class="macro">eprintln!</span>(<span class="string">"server error: {}"</span>, e); |
| } |
| }</code></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"><code><span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="comment">// Construct our SocketAddr to listen on... |
| </span><span class="kw">let </span>addr = SocketAddr::from(([<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>make_service = Shared::new(service_fn(handle)); |
| |
| <span class="comment">// Then bind and serve... |
| </span><span class="kw">let </span>server = Server::bind(<span class="kw-2">&</span>addr).serve(make_service); |
| |
| <span class="comment">// And run forever... |
| </span><span class="kw">if let </span><span class="prelude-val">Err</span>(e) = server.<span class="kw">await </span>{ |
| <span class="macro">eprintln!</span>(<span class="string">"server error: {}"</span>, e); |
| } |
| }</code></pre></div> |
| <p>Passing data to your request handler can be done like so:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::convert::Infallible; |
| <span class="kw">use </span>std::net::SocketAddr; |
| <span class="kw">use </span>hyper::{Body, Request, Response, Server}; |
| <span class="kw">use </span>hyper::service::{make_service_fn, service_fn}; |
| <span class="kw">use </span>hyper::server::conn::AddrStream; |
| |
| <span class="attribute">#[derive(Clone)] |
| </span><span class="kw">struct </span>AppContext { |
| <span class="comment">// Whatever data your application needs can go here |
| </span>} |
| |
| <span class="kw">async fn </span>handle( |
| context: AppContext, |
| addr: SocketAddr, |
| req: Request<Body> |
| ) -> <span class="prelude-ty">Result</span><Response<Body>, Infallible> { |
| <span class="prelude-val">Ok</span>(Response::new(Body::from(<span class="string">"Hello World"</span>))) |
| } |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="kw">let </span>context = AppContext { |
| <span class="comment">// ... |
| </span>}; |
| |
| <span class="comment">// A `MakeService` that produces a `Service` to handle each connection. |
| </span><span class="kw">let </span>make_service = make_service_fn(<span class="kw">move </span>|conn: <span class="kw-2">&</span>AddrStream| { |
| <span class="comment">// We have to clone the context to share it with each invocation of |
| // `make_service`. If your data doesn't implement `Clone` consider using |
| // an `std::sync::Arc`. |
| </span><span class="kw">let </span>context = context.clone(); |
| |
| <span class="comment">// You can grab the address of the incoming connection like so. |
| </span><span class="kw">let </span>addr = conn.remote_addr(); |
| |
| <span class="comment">// Create a `Service` for responding to the request. |
| </span><span class="kw">let </span>service = service_fn(<span class="kw">move </span>|req| { |
| handle(context.clone(), addr, req) |
| }); |
| |
| <span class="comment">// Return the service to hyper. |
| </span><span class="kw">async move </span>{ <span class="prelude-val">Ok</span>::<<span class="kw">_</span>, Infallible>(service) } |
| }); |
| |
| <span class="comment">// Run the server like above... |
| </span><span class="kw">let </span>addr = SocketAddr::from(([<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="kw">let </span>server = Server::bind(<span class="kw-2">&</span>addr).serve(make_service); |
| |
| <span class="kw">if let </span><span class="prelude-val">Err</span>(e) = server.<span class="kw">await </span>{ |
| <span class="macro">eprintln!</span>(<span class="string">"server error: {}"</span>, e); |
| } |
| }</code></pre></div> |
| </div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="accept/index.html" title="hyper::server::accept mod">accept</a></div><div class="item-right docblock-short">The <code>Accept</code> trait and supporting types.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="conn/index.html" title="hyper::server::conn mod">conn</a></div><div class="item-right docblock-short">Lower-level Server connection API.</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Builder.html" title="hyper::server::Builder struct">Builder</a></div><div class="item-right docblock-short">A builder for a <a href="struct.Server.html"><code>Server</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Server.html" title="hyper::server::Server struct">Server</a></div><div class="item-right docblock-short">A listening HTTP server that accepts connections in both HTTP1 and HTTP2 by default.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="hyper" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
