github-actions[bot]
18 lines
7.4 KiB
HTML
18 lines
7.4 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 `handshake` fn in crate `h2`."><meta name="keywords" content="rust, rustlang, rust-lang, handshake"><title>h2::server::handshake - 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 fn"><!--[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='../../h2/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class="location"><a href="../index.html">h2</a>::<wbr><a href="index.html">server</a></p><div id="sidebar-vars" data-name="handshake" data-ty="fn" 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">Function <a href="../index.html">h2</a>::<wbr><a href="index.html">server</a>::<wbr><a class="fn" href="">handshake</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/h2/server.rs.html#350-355" title="goto source code">[src]</a></span></h1><pre class="rust fn">pub fn handshake<T>(io: T) -> <a class="struct" href="../../h2/server/struct.Handshake.html" title="struct h2::server::Handshake">Handshake</a><T, <a class="struct" href="../../bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="struct" href="../../h2/server/struct.Handshake.html" title="struct h2::server::Handshake">Handshake</a><T, B></h3><code class="content"><span class="where fmt-newline">impl<T, B: <a class="trait" href="../../bytes/buf/buf_impl/trait.Buf.html" title="trait bytes::buf::buf_impl::Buf">Buf</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="../../h2/server/struct.Handshake.html" title="struct h2::server::Handshake">Handshake</a><T, B> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../tokio/io/async_read/trait.AsyncRead.html" title="trait tokio::io::async_read::AsyncRead">AsyncRead</a> + <a class="trait" href="../../tokio/io/async_write/trait.AsyncWrite.html" title="trait tokio::io::async_write::AsyncWrite">AsyncWrite</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,<br> B: <a class="trait" href="../../bytes/buf/buf_impl/trait.Buf.html" title="trait bytes::buf::buf_impl::Buf">Buf</a> + 'static, </span></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../h2/server/struct.Connection.html" title="struct h2::server::Connection">Connection</a><T, B>, <a class="struct" href="../../h2/struct.Error.html" title="struct h2::Error">Error</a>>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../tokio/io/async_read/trait.AsyncRead.html" title="trait tokio::io::async_read::AsyncRead">AsyncRead</a> + <a class="trait" href="../../tokio/io/async_write/trait.AsyncWrite.html" title="trait tokio::io::async_write::AsyncWrite">AsyncWrite</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></pre><div class="docblock"><p>Creates a new configured HTTP/2.0 server with default configuration
|
||
values backed by <code>io</code>.</p>
|
||
<p>It is expected that <code>io</code> already be in an appropriate state to commence
|
||
the <a href="http://httpwg.org/specs/rfc7540.html#ConnectionHeader">HTTP/2.0 handshake</a>. See <a href="../index.html#handshake">Handshake</a> for more details.</p>
|
||
<p>Returns a future which resolves to the <a href="struct.Connection.html"><code>Connection</code></a> instance once the
|
||
HTTP/2.0 handshake has been completed. The returned <a href="struct.Connection.html"><code>Connection</code></a>
|
||
instance will be using default configuration values. Use <a href="../../h2/server/struct.Builder.html" title="Builder"><code>Builder</code></a> to
|
||
customize the configuration values used by a <a href="struct.Connection.html"><code>Connection</code></a> instance.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">connection</span> <span class="op">=</span> <span class="ident">server</span>::<span class="ident">handshake</span>(<span class="ident">my_io</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||
<span class="comment">// The HTTP/2.0 handshake has completed, now use `connection` to</span>
|
||
<span class="comment">// accept inbound HTTP/2.0 streams.</span></pre></div>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="h2"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |