Files
google-apis-rs/hyper/server/conn/index.html
2024-03-05 21:06:01 +01:00

39 lines
8.2 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Lower-level Server connection API."><title>hyper::server::conn - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="hyper" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.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">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../hyper/index.html">hyper</a><span class="version">0.14.27</span></h2></div><h2 class="location"><a href="#">Module conn</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section><h2><a href="../index.html">In hyper::server</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../hyper/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">hyper</a>::<wbr><a href="../index.html">server</a>::<wbr><a class="mod" href="#">conn</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../src/hyper/server/conn.rs.html#1-1079">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Lower-level Server connection API.</p>
<p>The types in this module are to provide a lower-level API based around a
single connection. Accepting a connection and binding it with a service
are not handled at this level. This module provides the building blocks to
customize those things externally.</p>
<p>If you dont have need to manage connections yourself, consider using the
higher-level <a href="../index.html" title="mod hyper::server">Server</a> API.</p>
<h3 id="example"><a href="#example">Example</a></h3>
<p>A simple example that uses the <code>Http</code> struct to talk HTTP over a Tokio TCP stream</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>http::{Request, Response, StatusCode};
<span class="kw">use </span>hyper::{server::conn::Http, service::service_fn, Body};
<span class="kw">use </span>std::{net::SocketAddr, convert::Infallible};
<span class="kw">use </span>tokio::net::TcpListener;
<span class="attr">#[tokio::main]
</span><span class="kw">async fn </span>main() -&gt; <span class="prelude-ty">Result</span>&lt;(), Box&lt;<span class="kw">dyn </span>std::error::Error + Send + Sync&gt;&gt; {
<span class="kw">let </span>addr: SocketAddr = ([<span class="number">127</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">1</span>], <span class="number">8080</span>).into();
<span class="kw">let </span><span class="kw-2">mut </span>tcp_listener = TcpListener::bind(addr).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">loop </span>{
<span class="kw">let </span>(tcp_stream, <span class="kw">_</span>) = tcp_listener.accept().<span class="kw">await</span><span class="question-mark">?</span>;
tokio::task::spawn(<span class="kw">async move </span>{
<span class="kw">if let </span><span class="prelude-val">Err</span>(http_err) = Http::new()
.http1_only(<span class="bool-val">true</span>)
.http1_keep_alive(<span class="bool-val">true</span>)
.serve_connection(tcp_stream, service_fn(hello))
.<span class="kw">await </span>{
<span class="macro">eprintln!</span>(<span class="string">"Error while serving HTTP connection: {}"</span>, http_err);
}
});
}
}
<span class="kw">async fn </span>hello(_req: Request&lt;Body&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;Response&lt;Body&gt;, Infallible&gt; {
<span class="prelude-val">Ok</span>(Response::new(Body::from(<span class="string">"Hello World!"</span>)))
}</code></pre></div>
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AddrIncoming.html" title="struct hyper::server::conn::AddrIncoming">AddrIncoming</a></div><div class="desc docblock-short">A stream of connections from binding to an address.</div></li><li><div class="item-name"><a class="struct" href="struct.AddrStream.html" title="struct hyper::server::conn::AddrStream">AddrStream</a></div><div class="desc docblock-short">A transport returned yieled by <code>AddrIncoming</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Connecting.html" title="struct hyper::server::conn::Connecting">Connecting</a></div><div class="desc docblock-short">A future building a new <code>Service</code> to a <code>Connection</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Connection.html" title="struct hyper::server::conn::Connection">Connection</a></div><div class="desc docblock-short">A future binding a connection with a Service.</div></li><li><div class="item-name"><a class="struct" href="struct.Http.html" title="struct hyper::server::conn::Http">Http</a></div><div class="desc docblock-short">A lower-level configuration of the HTTP protocol.</div></li><li><div class="item-name"><a class="struct" href="struct.Parts.html" title="struct hyper::server::conn::Parts">Parts</a></div><div class="desc docblock-short">Deconstructed parts of a <code>Connection</code>.</div></li></ul></section></div></main></body></html>