Files
google-apis-rs/hyper/server/conn/index.html
2021-04-02 00:20:57 +08:00

50 lines
9.8 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="API documentation for the Rust `conn` mod in crate `hyper`."><meta name="keywords" content="rust, rustlang, rust-lang, conn"><title>hyper::server::conn - 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">&#9776;</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 conn</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class="location"><a href="../../index.html">hyper</a>::<wbr><a href="../index.html">server</a></p><div id="sidebar-vars" data-name="conn" 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 href="../index.html">server</a>::<wbr><a class="mod" href="">conn</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">&#x2212;</span>]</a></span><a class="srclink" href="../../../src/hyper/server/conn.rs.html#1-1164" title="goto source code">[src]</a></span></h1><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 don't have need to manage connections yourself, consider using the
higher-level <a href="../../../hyper/server/index.html">Server</a> API.</p>
<h2 id="example" class="section-header"><a href="#example">Example</a></h2>
<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">
<span class="kw">use</span> <span class="ident">http</span>::{<span class="ident">Request</span>, <span class="ident">Response</span>, <span class="ident">StatusCode</span>};
<span class="kw">use</span> <span class="ident">hyper</span>::{<span class="ident">server</span>::<span class="ident">conn</span>::<span class="ident">Http</span>, <span class="ident">service</span>::<span class="ident">service_fn</span>, <span class="ident">Body</span>};
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">net</span>::<span class="ident">SocketAddr</span>, <span class="ident">convert</span>::<span class="ident">Infallible</span>};
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">TcpListener</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="op">-</span><span class="op">&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span>(), <span class="ident">Box</span><span class="op">&lt;</span><span class="kw">dyn</span> <span class="ident">std</span>::<span class="ident">error</span>::<span class="ident">Error</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span><span class="op">&gt;</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">addr</span>: <span class="ident">SocketAddr</span> <span class="op">=</span> ([<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>).<span class="ident">into</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">tcp_listener</span> <span class="op">=</span> <span class="ident">TcpListener</span>::<span class="ident">bind</span>(<span class="ident">addr</span>).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">loop</span> {
<span class="kw">let</span> (<span class="ident">tcp_stream</span>, <span class="kw">_</span>) <span class="op">=</span> <span class="ident">tcp_listener</span>.<span class="ident">accept</span>().<span class="kw">await</span><span class="question-mark">?</span>;
<span class="ident">tokio</span>::<span class="ident">task</span>::<span class="ident">spawn</span>(<span class="kw">async</span> <span class="kw">move</span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Err</span>(<span class="ident">http_err</span>) <span class="op">=</span> <span class="ident">Http</span>::<span class="ident">new</span>()
.<span class="ident">http1_only</span>(<span class="bool-val">true</span>)
.<span class="ident">http1_keep_alive</span>(<span class="bool-val">true</span>)
.<span class="ident">serve_connection</span>(<span class="ident">tcp_stream</span>, <span class="ident">service_fn</span>(<span class="ident">hello</span>))
.<span class="kw">await</span> {
<span class="macro">eprintln</span><span class="macro">!</span>(<span class="string">&quot;Error while serving HTTP connection: {}&quot;</span>, <span class="ident">http_err</span>);
}
});
}
}
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">hello</span>(<span class="ident">_req</span>: <span class="ident">Request</span><span class="op">&lt;</span><span class="ident">Body</span><span class="op">&gt;</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">Response</span><span class="op">&lt;</span><span class="ident">Body</span><span class="op">&gt;</span>, <span class="ident">Infallible</span><span class="op">&gt;</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">&quot;Hello World!&quot;</span>)))
}</pre></div>
</div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.AddrIncoming.html" title="hyper::server::conn::AddrIncoming struct">AddrIncoming</a></td><td class="docblock-short"><p>A stream of connections from binding to an address.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AddrStream.html" title="hyper::server::conn::AddrStream struct">AddrStream</a></td><td class="docblock-short"><p>A transport returned yieled by <code>AddrIncoming</code>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Connecting.html" title="hyper::server::conn::Connecting struct">Connecting</a></td><td class="docblock-short"><p>A future building a new <code>Service</code> to a <code>Connection</code>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Connection.html" title="hyper::server::conn::Connection struct">Connection</a></td><td class="docblock-short"><p>A future binding a connection with a Service.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Http.html" title="hyper::server::conn::Http struct">Http</a></td><td class="docblock-short"><p>A lower-level configuration of the HTTP protocol.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Parts.html" title="hyper::server::conn::Parts struct">Parts</a></td><td class="docblock-short"><p>Deconstructed parts of a <code>Connection</code>.</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>