Initial docs commit
This commit is contained in:
Uttarayan Mondal
@@ -0,0 +1,20 @@
|
||||
<!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="Creates a new configured HTTP/2.0 client with default configuration values backed by `io`."><meta name="keywords" content="rust, rustlang, rust-lang, handshake"><title>h2::client::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">client</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">client</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/client.rs.html#1114-1123" title="goto source code">[src]</a></span></h1><pre class="rust fn">pub async fn handshake<T>(<br> io: T<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../../h2/client/struct.SendRequest.html" title="struct h2::client::SendRequest">SendRequest</a><<a class="struct" href="../../bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>>, <a class="struct" href="../../h2/client/struct.Connection.html" title="struct h2::client::Connection">Connection</a><T, <a class="struct" href="../../bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="struct" href="../../h2/struct.Error.html" title="struct h2::Error">Error</a>> <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 client 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> / <a href="struct.SendRequest.html"><code>SendRequest</code></a>
|
||||
tuple 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/client/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">send_request</span>, <span class="ident">connection</span>) <span class="op">=</span> <span class="ident">client</span>::<span class="ident">handshake</span>(<span class="ident">my_io</span>).<span class="kw">await</span><span class="question-mark">?</span>;
|
||||
<span class="comment">// The HTTP/2.0 handshake has completed, now start polling</span>
|
||||
<span class="comment">// `connection` and use `send_request` to send requests to the</span>
|
||||
<span class="comment">// server.</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>
|
||||
@@ -0,0 +1,118 @@
|
||||
<!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="Client implementation of the HTTP/2.0 protocol."><meta name="keywords" content="rust, rustlang, rust-lang, client"><title>h2::client - 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='../../h2/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module client</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class="location"><a href="../index.html">h2</a></p><div id="sidebar-vars" data-name="client" 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">h2</a>::<wbr><a class="mod" href="">client</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/client.rs.html#1-1521" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Client implementation of the HTTP/2.0 protocol.</p>
|
||||
<h1 id="getting-started" class="section-header"><a href="#getting-started">Getting started</a></h1>
|
||||
<p>Running an HTTP/2.0 client requires the caller to establish the underlying
|
||||
connection as well as get the connection to a state that is ready to begin
|
||||
the HTTP/2.0 handshake. See <a href="../index.html#handshake">here</a> for more
|
||||
details.</p>
|
||||
<p>This could be as basic as using Tokio’s <a href="https://docs.rs/tokio-core/0.1/tokio_core/net/struct.TcpStream.html"><code>TcpStream</code></a> to connect to a remote
|
||||
host, but usually it means using either ALPN or HTTP/1.1 protocol upgrades.</p>
|
||||
<p>Once a connection is obtained, it is passed to <a href="fn.handshake.html"><code>handshake</code></a>, which will
|
||||
begin the <a href="http://httpwg.org/specs/rfc7540.html#ConnectionHeader">HTTP/2.0 handshake</a>. This returns a future that completes once
|
||||
the handshake process is performed and HTTP/2.0 streams may be initialized.</p>
|
||||
<p><a href="fn.handshake.html"><code>handshake</code></a> uses default configuration values. There are a number of
|
||||
settings that can be changed by using <a href="struct.Builder.html"><code>Builder</code></a> instead.</p>
|
||||
<p>Once the handshake future completes, the caller is provided with a
|
||||
<a href="struct.Connection.html"><code>Connection</code></a> instance and a <a href="struct.SendRequest.html"><code>SendRequest</code></a> instance. The <a href="struct.Connection.html"><code>Connection</code></a>
|
||||
instance is used to drive the connection (see <a href="#managing-the-connection">Managing the connection</a>).
|
||||
The <a href="struct.SendRequest.html"><code>SendRequest</code></a> instance is used to initialize new streams (see <a href="#making-requests">Making
|
||||
requests</a>).</p>
|
||||
<h1 id="making-requests" class="section-header"><a href="#making-requests">Making requests</a></h1>
|
||||
<p>Requests are made using the <a href="struct.SendRequest.html"><code>SendRequest</code></a> handle provided by the handshake
|
||||
future. Once a request is submitted, an HTTP/2.0 stream is initialized and
|
||||
the request is sent to the server.</p>
|
||||
<p>A request body and request trailers are sent using <a href="struct.SendRequest.html"><code>SendRequest</code></a> and the
|
||||
server’s response is returned once the <a href="struct.ResponseFuture.html"><code>ResponseFuture</code></a> future completes.
|
||||
Both the <a href="../struct.SendStream.html"><code>SendStream</code></a> and <a href="struct.ResponseFuture.html"><code>ResponseFuture</code></a> instances are returned by
|
||||
<a href="struct.SendRequest.html#method.send_request"><code>SendRequest::send_request</code></a> and are tied to the HTTP/2.0 stream
|
||||
initialized by the sent request.</p>
|
||||
<p>The <a href="struct.SendRequest.html#method.poll_ready"><code>SendRequest::poll_ready</code></a> function returns <code>Ready</code> when a new HTTP/2.0
|
||||
stream can be created, i.e. as long as the current number of active streams
|
||||
is below <a href="http://httpwg.org/specs/rfc7540.html#SettingValues"><code>MAX_CONCURRENT_STREAMS</code></a>. If a new stream cannot be created, the
|
||||
caller will be notified once an existing stream closes, freeing capacity for
|
||||
the caller. The caller should use <a href="struct.SendRequest.html#method.poll_ready"><code>SendRequest::poll_ready</code></a> to check for
|
||||
capacity before sending a request to the server.</p>
|
||||
<p><a href="struct.SendRequest.html"><code>SendRequest</code></a> enforces the <a href="http://httpwg.org/specs/rfc7540.html#SettingValues"><code>MAX_CONCURRENT_STREAMS</code></a> setting. The user
|
||||
must not send a request if <code>poll_ready</code> does not return <code>Ready</code>. Attempting
|
||||
to do so will result in an <a href="../struct.Error.html"><code>Error</code></a> being returned.</p>
|
||||
<h1 id="managing-the-connection" class="section-header"><a href="#managing-the-connection">Managing the connection</a></h1>
|
||||
<p>The <a href="struct.Connection.html"><code>Connection</code></a> instance is used to manage connection state. The caller
|
||||
is required to call <a href="struct.Connection.html#method.poll"><code>Connection::poll</code></a> in order to advance state.
|
||||
<a href="struct.SendRequest.html#method.send_request"><code>SendRequest::send_request</code></a> and other functions have no effect unless
|
||||
<a href="struct.Connection.html#method.poll"><code>Connection::poll</code></a> is called.</p>
|
||||
<p>The <a href="struct.Connection.html"><code>Connection</code></a> instance should only be dropped once <a href="struct.Connection.html#method.poll"><code>Connection::poll</code></a>
|
||||
returns <code>Ready</code>. At this point, the underlying socket has been closed and no
|
||||
further work needs to be done.</p>
|
||||
<p>The easiest way to ensure that the <a href="struct.Connection.html"><code>Connection</code></a> instance gets polled is to
|
||||
submit the <a href="struct.Connection.html"><code>Connection</code></a> instance to an <a href="https://docs.rs/futures/0.1/futures/future/trait.Executor.html">executor</a>. The executor will then
|
||||
manage polling the connection until the connection is complete.
|
||||
Alternatively, the caller can call <code>poll</code> manually.</p>
|
||||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
|
||||
<span class="kw">use</span> <span class="ident">h2</span>::<span class="ident">client</span>;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">http</span>::{<span class="ident">Request</span>, <span class="ident">Method</span>};
|
||||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">error</span>::<span class="ident">Error</span>;
|
||||
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">TcpStream</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||||
<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">Error</span><span class="op">></span><span class="op">></span> {
|
||||
<span class="comment">// Establish TCP connection to the server.</span>
|
||||
<span class="kw">let</span> <span class="ident">tcp</span> <span class="op">=</span> <span class="ident">TcpStream</span>::<span class="ident">connect</span>(<span class="string">"127.0.0.1:5928"</span>).<span class="kw">await</span><span class="question-mark">?</span>;
|
||||
<span class="kw">let</span> (<span class="ident">h2</span>, <span class="ident">connection</span>) <span class="op">=</span> <span class="ident">client</span>::<span class="ident">handshake</span>(<span class="ident">tcp</span>).<span class="kw">await</span><span class="question-mark">?</span>;
|
||||
<span class="ident">tokio</span>::<span class="ident">spawn</span>(<span class="kw">async</span> <span class="kw">move</span> {
|
||||
<span class="ident">connection</span>.<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
});
|
||||
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">h2</span> <span class="op">=</span> <span class="ident">h2</span>.<span class="ident">ready</span>().<span class="kw">await</span><span class="question-mark">?</span>;
|
||||
<span class="comment">// Prepare the HTTP request to send to the server.</span>
|
||||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">builder</span>()
|
||||
.<span class="ident">method</span>(<span class="ident">Method</span>::<span class="ident">GET</span>)
|
||||
.<span class="ident">uri</span>(<span class="string">"https://www.example.com/"</span>)
|
||||
.<span class="ident">body</span>(())
|
||||
.<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="comment">// Send the request. The second tuple item allows the caller</span>
|
||||
<span class="comment">// to stream a request body.</span>
|
||||
<span class="kw">let</span> (<span class="ident">response</span>, <span class="kw">_</span>) <span class="op">=</span> <span class="ident">h2</span>.<span class="ident">send_request</span>(<span class="ident">request</span>, <span class="bool-val">true</span>).<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="kw">let</span> (<span class="ident">head</span>, <span class="kw-2">mut</span> <span class="ident">body</span>) <span class="op">=</span> <span class="ident">response</span>.<span class="kw">await</span><span class="question-mark">?</span>.<span class="ident">into_parts</span>();
|
||||
|
||||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Received response: {:?}"</span>, <span class="ident">head</span>);
|
||||
|
||||
<span class="comment">// The `flow_control` handle allows the caller to manage</span>
|
||||
<span class="comment">// flow control.</span>
|
||||
<span class="comment">//</span>
|
||||
<span class="comment">// Whenever data is received, the caller is responsible for</span>
|
||||
<span class="comment">// releasing capacity back to the server once it has freed</span>
|
||||
<span class="comment">// the data from memory.</span>
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">flow_control</span> <span class="op">=</span> <span class="ident">body</span>.<span class="ident">flow_control</span>().<span class="ident">clone</span>();
|
||||
|
||||
<span class="kw">while</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">chunk</span>) <span class="op">=</span> <span class="ident">body</span>.<span class="ident">data</span>().<span class="kw">await</span> {
|
||||
<span class="kw">let</span> <span class="ident">chunk</span> <span class="op">=</span> <span class="ident">chunk</span><span class="question-mark">?</span>;
|
||||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"RX: {:?}"</span>, <span class="ident">chunk</span>);
|
||||
|
||||
<span class="comment">// Let the server send more data.</span>
|
||||
<span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">flow_control</span>.<span class="ident">release_capacity</span>(<span class="ident">chunk</span>.<span class="ident">len</span>());
|
||||
}
|
||||
|
||||
<span class="prelude-val">Ok</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.Builder.html" title="h2::client::Builder struct">Builder</a></td><td class="docblock-short"><p>Builds client connections with custom configuration values.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Connection.html" title="h2::client::Connection struct">Connection</a></td><td class="docblock-short"><p>Manages all state associated with an HTTP/2.0 client connection.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PushPromise.html" title="h2::client::PushPromise struct">PushPromise</a></td><td class="docblock-short"><p>A pushed response and corresponding request headers</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PushPromises.html" title="h2::client::PushPromises struct">PushPromises</a></td><td class="docblock-short"><p>A stream of pushed responses and corresponding promised requests</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PushedResponseFuture.html" title="h2::client::PushedResponseFuture struct">PushedResponseFuture</a></td><td class="docblock-short"><p>A future of a pushed HTTP response.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ReadySendRequest.html" title="h2::client::ReadySendRequest struct">ReadySendRequest</a></td><td class="docblock-short"><p>Returns a <code>SendRequest</code> instance once it is ready to send at least one
|
||||
request.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResponseFuture.html" title="h2::client::ResponseFuture struct">ResponseFuture</a></td><td class="docblock-short"><p>A future of an HTTP response.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SendRequest.html" title="h2::client::SendRequest struct">SendRequest</a></td><td class="docblock-short"><p>Initializes new HTTP/2.0 streams on a connection by sending a request.</p>
|
||||
</td></tr></table><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2>
|
||||
<table><tr class="module-item"><td><a class="fn" href="fn.handshake.html" title="h2::client::handshake fn">handshake</a></td><td class="docblock-short"><p>Creates a new configured HTTP/2.0 client with default configuration
|
||||
values backed by <code>io</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="h2"></div>
|
||||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
||||
@@ -0,0 +1 @@
|
||||
initSidebarItems({"fn":[["handshake","Creates a new configured HTTP/2.0 client with default configuration values backed by `io`."]],"struct":[["Builder","Builds client connections with custom configuration values."],["Connection","Manages all state associated with an HTTP/2.0 client connection."],["PushPromise","A pushed response and corresponding request headers"],["PushPromises","A stream of pushed responses and corresponding promised requests"],["PushedResponseFuture","A future of a pushed HTTP response."],["ReadySendRequest","Returns a `SendRequest` instance once it is ready to send at least one request."],["ResponseFuture","A future of an HTTP response."],["SendRequest","Initializes new HTTP/2.0 streams on a connection by sending a request."]]});
|
||||
@@ -0,0 +1,230 @@
|
||||
<!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="Builds client connections with custom configuration values."><meta name="keywords" content="rust, rustlang, rust-lang, Builder"><title>h2::client::Builder - 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 struct"><!--[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><p class="location">Struct Builder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.enable_push">enable_push</a><a href="#method.handshake">handshake</a><a href="#method.initial_connection_window_size">initial_connection_window_size</a><a href="#method.initial_max_send_streams">initial_max_send_streams</a><a href="#method.initial_window_size">initial_window_size</a><a href="#method.max_concurrent_reset_streams">max_concurrent_reset_streams</a><a href="#method.max_concurrent_streams">max_concurrent_streams</a><a href="#method.max_frame_size">max_frame_size</a><a href="#method.max_header_list_size">max_header_list_size</a><a href="#method.new">new</a><a href="#method.reset_stream_duration">reset_stream_duration</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">h2</a>::<wbr><a href="index.html">client</a></p><div id="sidebar-vars" data-name="Builder" data-ty="struct" 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">Struct <a href="../index.html">h2</a>::<wbr><a href="index.html">client</a>::<wbr><a class="struct" href="">Builder</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/client.rs.html#309-331" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct Builder { /* fields omitted */ }</pre></div><div class="docblock"><p>Builds client connections with custom configuration values.</p>
|
||||
<p>Methods can be chained in order to set the configuration values.</p>
|
||||
<p>The client is constructed by calling <a href="struct.Builder.html#method.handshake"><code>handshake</code></a> and passing the I/O
|
||||
handle that will back the HTTP/2.0 server.</p>
|
||||
<p>New instances of <code>Builder</code> are obtained via <a href="struct.Builder.html#method.new"><code>Builder::new</code></a>.</p>
|
||||
<p>See function level documentation for details on the various client
|
||||
configuration settings.</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="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>((<span class="ident">SendRequest</span><span class="op"><</span><span class="ident">Bytes</span><span class="op">></span>, <span class="ident">Connection</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">Bytes</span><span class="op">></span>)), <span class="ident">h2</span>::<span class="ident">Error</span><span class="op">></span>
|
||||
<span class="comment">// `client_fut` is a future representing the completion of the HTTP/2.0</span>
|
||||
<span class="comment">// handshake.</span>
|
||||
<span class="kw">let</span> <span class="ident">client_fut</span> <span class="op">=</span> <span class="ident">Builder</span>::<span class="ident">new</span>()
|
||||
.<span class="ident">initial_window_size</span>(<span class="number">1_000_000</span>)
|
||||
.<span class="ident">max_concurrent_streams</span>(<span class="number">1000</span>)
|
||||
.<span class="ident">handshake</span>(<span class="ident">my_io</span>);</pre></div>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../../h2/client/struct.Builder.html" title="struct h2::client::Builder">Builder</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#588-1071" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>() -> <a class="struct" href="../../h2/client/struct.Builder.html" title="struct h2::client::Builder">Builder</a></code><a class="srclink" href="../../src/h2/client.rs.html#615-624" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a new client builder instance initialized with default
|
||||
configuration values.</p>
|
||||
<p>Configuration methods can be chained on the return value.</p>
|
||||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// `client_fut` is a future representing the completion of the HTTP/2.0</span>
|
||||
<span class="comment">// handshake.</span>
|
||||
<span class="kw">let</span> <span class="ident">client_fut</span> <span class="op">=</span> <span class="ident">Builder</span>::<span class="ident">new</span>()
|
||||
.<span class="ident">initial_window_size</span>(<span class="number">1_000_000</span>)
|
||||
.<span class="ident">max_concurrent_streams</span>(<span class="number">1000</span>)
|
||||
.<span class="ident">handshake</span>(<span class="ident">my_io</span>);</pre></div>
|
||||
</div><h4 id="method.initial_window_size" class="method"><code>pub fn <a href="#method.initial_window_size" class="fnname">initial_window_size</a>(&mut self, size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../src/h2/client.rs.html#656-659" title="goto source code">[src]</a></h4><div class="docblock"><p>Indicates the initial window size (in octets) for stream-level
|
||||
flow control for received data.</p>
|
||||
<p>The initial window of a stream is used as part of flow control. For more
|
||||
details, see <a href="../struct.FlowControl.html"><code>FlowControl</code></a>.</p>
|
||||
<p>The default value is 65,535.</p>
|
||||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// `client_fut` is a future representing the completion of the HTTP/2.0</span>
|
||||
<span class="comment">// handshake.</span>
|
||||
<span class="kw">let</span> <span class="ident">client_fut</span> <span class="op">=</span> <span class="ident">Builder</span>::<span class="ident">new</span>()
|
||||
.<span class="ident">initial_window_size</span>(<span class="number">1_000_000</span>)
|
||||
.<span class="ident">handshake</span>(<span class="ident">my_io</span>);</pre></div>
|
||||
</div><h4 id="method.initial_connection_window_size" class="method"><code>pub fn <a href="#method.initial_connection_window_size" class="fnname">initial_connection_window_size</a>(&mut self, size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../src/h2/client.rs.html#691-694" title="goto source code">[src]</a></h4><div class="docblock"><p>Indicates the initial window size (in octets) for connection-level flow control
|
||||
for received data.</p>
|
||||
<p>The initial window of a connection is used as part of flow control. For more details,
|
||||
see <a href="../struct.FlowControl.html"><code>FlowControl</code></a>.</p>
|
||||
<p>The default value is 65,535.</p>
|
||||
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// `client_fut` is a future representing the completion of the HTTP/2.0</span>
|
||||
<span class="comment">// handshake.</span>
|
||||
<span class="kw">let</span> <span class="ident">client_fut</span> <span class="op">=</span> <span class="ident">Builder</span>::<span class="ident">new</span>()
|
||||
.<span class="ident">initial_connection_window_size</span>(<span class="number">1_000_000</span>)
|
||||
.<span class="ident">handshake</span>(<span class="ident">my_io</span>);</pre></div>
|
||||
</div><h4 id="method.max_frame_size" class="method"><code>pub fn <a href="#method.max_frame_size" class="fnname">max_frame_size</a>(&mut self, max: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../src/h2/client.rs.html#730-733" title="goto source code">[src]</a></h4><div class="docblock"><p>Indicates the size (in octets) of the largest HTTP/2.0 frame payload that the
|
||||
configured client is able to accept.</p>
|
||||
<p>The sender may send data frames that are <strong>smaller</strong> than this value,
|
||||
but any data larger than <code>max</code> will be broken up into multiple <code>DATA</code>
|
||||
frames.</p>
|
||||
<p>The value <strong>must</strong> be between 16,384 and 16,777,215. The default value is 16,384.</p>
|
||||
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// `client_fut` is a future representing the completion of the HTTP/2.0</span>
|
||||
<span class="comment">// handshake.</span>
|
||||
<span class="kw">let</span> <span class="ident">client_fut</span> <span class="op">=</span> <span class="ident">Builder</span>::<span class="ident">new</span>()
|
||||
.<span class="ident">max_frame_size</span>(<span class="number">1_000_000</span>)
|
||||
.<span class="ident">handshake</span>(<span class="ident">my_io</span>);</pre></div>
|
||||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||||
<p>This function panics if <code>max</code> is not within the legal range specified
|
||||
above.</p>
|
||||
</div><h4 id="method.max_header_list_size" class="method"><code>pub fn <a href="#method.max_header_list_size" class="fnname">max_header_list_size</a>(&mut self, max: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../src/h2/client.rs.html#765-768" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the max size of received header frames.</p>
|
||||
<p>This advisory setting informs a peer of the maximum size of header list
|
||||
that the sender is prepared to accept, in octets. The value is based on
|
||||
the uncompressed size of header fields, including the length of the name
|
||||
and value in octets plus an overhead of 32 octets for each header field.</p>
|
||||
<p>This setting is also used to limit the maximum amount of data that is
|
||||
buffered to decode HEADERS frames.</p>
|
||||
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// `client_fut` is a future representing the completion of the HTTP/2.0</span>
|
||||
<span class="comment">// handshake.</span>
|
||||
<span class="kw">let</span> <span class="ident">client_fut</span> <span class="op">=</span> <span class="ident">Builder</span>::<span class="ident">new</span>()
|
||||
.<span class="ident">max_header_list_size</span>(<span class="number">16</span> <span class="op">*</span> <span class="number">1024</span>)
|
||||
.<span class="ident">handshake</span>(<span class="ident">my_io</span>);</pre></div>
|
||||
</div><h4 id="method.max_concurrent_streams" class="method"><code>pub fn <a href="#method.max_concurrent_streams" class="fnname">max_concurrent_streams</a>(&mut self, max: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../src/h2/client.rs.html#814-817" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the maximum number of concurrent streams.</p>
|
||||
<p>The maximum concurrent streams setting only controls the maximum number
|
||||
of streams that can be initiated by the remote peer. In other words,
|
||||
when this setting is set to 100, this does not limit the number of
|
||||
concurrent streams that can be created by the caller.</p>
|
||||
<p>It is recommended that this value be no smaller than 100, so as to not
|
||||
unnecessarily limit parallelism. However, any value is legal, including
|
||||
0. If <code>max</code> is set to 0, then the remote will not be permitted to
|
||||
initiate streams.</p>
|
||||
<p>Note that streams in the reserved state, i.e., push promises that have
|
||||
been reserved but the stream has not started, do not count against this
|
||||
setting.</p>
|
||||
<p>Also note that if the remote <em>does</em> exceed the value set here, it is not
|
||||
a protocol level error. Instead, the <code>h2</code> library will immediately reset
|
||||
the stream.</p>
|
||||
<p>See <a href="https://http2.github.io/http2-spec/#rfc.section.5.1.2">Section 5.1.2</a> in the HTTP/2.0 spec for more details.</p>
|
||||
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// `client_fut` is a future representing the completion of the HTTP/2.0</span>
|
||||
<span class="comment">// handshake.</span>
|
||||
<span class="kw">let</span> <span class="ident">client_fut</span> <span class="op">=</span> <span class="ident">Builder</span>::<span class="ident">new</span>()
|
||||
.<span class="ident">max_concurrent_streams</span>(<span class="number">1000</span>)
|
||||
.<span class="ident">handshake</span>(<span class="ident">my_io</span>);</pre></div>
|
||||
</div><h4 id="method.initial_max_send_streams" class="method"><code>pub fn <a href="#method.initial_max_send_streams" class="fnname">initial_max_send_streams</a>(&mut self, initial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../src/h2/client.rs.html#855-858" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the initial maximum of locally initiated (send) streams.</p>
|
||||
<p>The initial settings will be overwritten by the remote peer when
|
||||
the Settings frame is received. The new value will be set to the
|
||||
<code>max_concurrent_streams()</code> from the frame.</p>
|
||||
<p>This setting prevents the caller from exceeding this number of
|
||||
streams that are counted towards the concurrency limit.</p>
|
||||
<p>Sending streams past the limit returned by the peer will be treated
|
||||
as a stream error of type PROTOCOL_ERROR or REFUSED_STREAM.</p>
|
||||
<p>See <a href="https://http2.github.io/http2-spec/#rfc.section.5.1.2">Section 5.1.2</a> in the HTTP/2.0 spec for more details.</p>
|
||||
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// `client_fut` is a future representing the completion of the HTTP/2.0</span>
|
||||
<span class="comment">// handshake.</span>
|
||||
<span class="kw">let</span> <span class="ident">client_fut</span> <span class="op">=</span> <span class="ident">Builder</span>::<span class="ident">new</span>()
|
||||
.<span class="ident">initial_max_send_streams</span>(<span class="number">1000</span>)
|
||||
.<span class="ident">handshake</span>(<span class="ident">my_io</span>);</pre></div>
|
||||
</div><h4 id="method.max_concurrent_reset_streams" class="method"><code>pub fn <a href="#method.max_concurrent_reset_streams" class="fnname">max_concurrent_reset_streams</a>(&mut self, max: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../src/h2/client.rs.html#900-903" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the maximum number of concurrent locally reset streams.</p>
|
||||
<p>When a stream is explicitly reset, the HTTP/2.0 specification requires
|
||||
that any further frames received for that stream must be ignored for
|
||||
“some time”.</p>
|
||||
<p>In order to satisfy the specification, internal state must be maintained
|
||||
to implement the behavior. This state grows linearly with the number of
|
||||
streams that are locally reset.</p>
|
||||
<p>The <code>max_concurrent_reset_streams</code> setting configures sets an upper
|
||||
bound on the amount of state that is maintained. When this max value is
|
||||
reached, the oldest reset stream is purged from memory.</p>
|
||||
<p>Once the stream has been fully purged from memory, any additional frames
|
||||
received for that stream will result in a connection level protocol
|
||||
error, forcing the connection to terminate.</p>
|
||||
<p>The default value is 10.</p>
|
||||
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// `client_fut` is a future representing the completion of the HTTP/2.0</span>
|
||||
<span class="comment">// handshake.</span>
|
||||
<span class="kw">let</span> <span class="ident">client_fut</span> <span class="op">=</span> <span class="ident">Builder</span>::<span class="ident">new</span>()
|
||||
.<span class="ident">max_concurrent_reset_streams</span>(<span class="number">1000</span>)
|
||||
.<span class="ident">handshake</span>(<span class="ident">my_io</span>);</pre></div>
|
||||
</div><h4 id="method.reset_stream_duration" class="method"><code>pub fn <a href="#method.reset_stream_duration" class="fnname">reset_stream_duration</a>(&mut self, dur: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../src/h2/client.rs.html#946-949" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the duration to remember locally reset streams.</p>
|
||||
<p>When a stream is explicitly reset, the HTTP/2.0 specification requires
|
||||
that any further frames received for that stream must be ignored for
|
||||
“some time”.</p>
|
||||
<p>In order to satisfy the specification, internal state must be maintained
|
||||
to implement the behavior. This state grows linearly with the number of
|
||||
streams that are locally reset.</p>
|
||||
<p>The <code>reset_stream_duration</code> setting configures the max amount of time
|
||||
this state will be maintained in memory. Once the duration elapses, the
|
||||
stream state is purged from memory.</p>
|
||||
<p>Once the stream has been fully purged from memory, any additional frames
|
||||
received for that stream will result in a connection level protocol
|
||||
error, forcing the connection to terminate.</p>
|
||||
<p>The default value is 30 seconds.</p>
|
||||
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// `client_fut` is a future representing the completion of the HTTP/2.0</span>
|
||||
<span class="comment">// handshake.</span>
|
||||
<span class="kw">let</span> <span class="ident">client_fut</span> <span class="op">=</span> <span class="ident">Builder</span>::<span class="ident">new</span>()
|
||||
.<span class="ident">reset_stream_duration</span>(<span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">10</span>))
|
||||
.<span class="ident">handshake</span>(<span class="ident">my_io</span>);</pre></div>
|
||||
</div><h4 id="method.enable_push" class="method"><code>pub fn <a href="#method.enable_push" class="fnname">enable_push</a>(&mut self, enabled: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../src/h2/client.rs.html#984-987" title="goto source code">[src]</a></h4><div class="docblock"><p>Enables or disables server push promises.</p>
|
||||
<p>This value is included in the initial SETTINGS handshake. When set, the
|
||||
server MUST NOT send a push promise. Setting this value to value to
|
||||
false in the initial SETTINGS handshake guarantees that the remote server
|
||||
will never send a push promise.</p>
|
||||
<p>This setting can be changed during the life of a single HTTP/2.0
|
||||
connection by sending another settings frame updating the value.</p>
|
||||
<p>Default value: <code>true</code>.</p>
|
||||
<h1 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// `client_fut` is a future representing the completion of the HTTP/2.0</span>
|
||||
<span class="comment">// handshake.</span>
|
||||
<span class="kw">let</span> <span class="ident">client_fut</span> <span class="op">=</span> <span class="ident">Builder</span>::<span class="ident">new</span>()
|
||||
.<span class="ident">enable_push</span>(<span class="bool-val">false</span>)
|
||||
.<span class="ident">handshake</span>(<span class="ident">my_io</span>);</pre></div>
|
||||
</div><h4 id="method.handshake" class="method"><code>pub fn <a href="#method.handshake" class="fnname">handshake</a><T, B>(<br> &self, <br> io: T<br>) -> impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../../h2/client/struct.SendRequest.html" title="struct h2::client::SendRequest">SendRequest</a><B>, <a class="struct" href="../../h2/client/struct.Connection.html" title="struct h2::client::Connection">Connection</a><T, B><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="struct" href="../../h2/struct.Error.html" title="struct h2::Error">Error</a>>> <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></code><a class="srclink" href="../../src/h2/client.rs.html#1061-1070" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new configured HTTP/2.0 client 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>. The handshake is completed once both the connection
|
||||
preface and the initial settings frame is sent by the client.</p>
|
||||
<p>The handshake future does not wait for the initial settings frame from the
|
||||
server.</p>
|
||||
<p>Returns a future which resolves to the <a href="struct.Connection.html"><code>Connection</code></a> / <a href="struct.SendRequest.html"><code>SendRequest</code></a>
|
||||
tuple once the HTTP/2.0 handshake has been completed.</p>
|
||||
<p>This function also allows the caller to configure the send payload data
|
||||
type. See <a href="../index.html#outbound-data-type.">Outbound data type</a> for more details.</p>
|
||||
<h1 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h1>
|
||||
<p>Basic usage:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>((<span class="ident">SendRequest</span><span class="op"><</span><span class="ident">Bytes</span><span class="op">></span>, <span class="ident">Connection</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">Bytes</span><span class="op">></span>)), <span class="ident">h2</span>::<span class="ident">Error</span><span class="op">></span>
|
||||
<span class="comment">// `client_fut` is a future representing the completion of the HTTP/2.0</span>
|
||||
<span class="comment">// handshake.</span>
|
||||
<span class="kw">let</span> <span class="ident">client_fut</span> <span class="op">=</span> <span class="ident">Builder</span>::<span class="ident">new</span>()
|
||||
.<span class="ident">handshake</span>(<span class="ident">my_io</span>);</pre></div>
|
||||
<p>Configures the send-payload data type. In this case, the outbound data
|
||||
type will be <code>&'static [u8]</code>.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// `client_fut` is a future representing the completion of the HTTP/2.0</span>
|
||||
<span class="comment">// handshake.</span>
|
||||
<span class="kw">let</span> <span class="ident">client_fut</span> <span class="op">=</span> <span class="ident">Builder</span>::<span class="ident">new</span>()
|
||||
.<span class="ident">handshake</span>::<span class="op"><</span><span class="kw">_</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> [<span class="ident">u8</span>]<span class="op">></span>(<span class="ident">my_io</span>);</pre></div>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Clone" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../h2/client/struct.Builder.html" title="struct h2::client::Builder">Builder</a></code><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#308" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.clone" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="../../h2/client/struct.Builder.html" title="struct h2::client::Builder">Builder</a></code><a class="srclink" href="../../src/h2/client.rs.html#308" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
</div><h4 id="method.clone_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#128" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||||
</div></div><h3 id="impl-Debug" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../h2/client/struct.Builder.html" title="struct h2::client::Builder">Builder</a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#308" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../src/h2/client.rs.html#308" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id="impl-Default" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../../h2/client/struct.Builder.html" title="struct h2::client::Builder">Builder</a></code><a href="#impl-Default" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#1073-1077" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.default" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> <a class="struct" href="../../h2/client/struct.Builder.html" title="struct h2::client::Builder">Builder</a></code><a class="srclink" href="../../src/h2/client.rs.html#1074-1076" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../h2/client/struct.Builder.html" title="struct h2::client::Builder">Builder</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../h2/client/struct.Builder.html" title="struct h2::client::Builder">Builder</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../h2/client/struct.Builder.html" title="struct h2::client::Builder">Builder</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../h2/client/struct.Builder.html" title="struct h2::client::Builder">Builder</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../h2/client/struct.Builder.html" title="struct h2::client::Builder">Builder</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-Instrument" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</code><a href="#impl-Instrument" class="anchor"></a><a class="srclink" href="../../src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.instrument" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#38" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
|
||||
</div><h4 id="method.in_current_span" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#74" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-ToOwned" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href="#impl-ToOwned" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-93" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Owned" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||||
</div><h4 id="method.to_owned" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#86" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||||
</div><h4 id="method.clone_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#90" title="goto source code">[src]</a></h4><div class="item-info hidden"><div class="stab unstable"><details><summary><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
||||
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></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>
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,24 @@
|
||||
<!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="A pushed response and corresponding request headers"><meta name="keywords" content="rust, rustlang, rust-lang, PushPromise"><title>h2::client::PushPromise - 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 struct"><!--[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><p class="location">Struct PushPromise</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.into_parts">into_parts</a><a href="#method.request">request</a><a href="#method.request_mut">request_mut</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">h2</a>::<wbr><a href="index.html">client</a></p><div id="sidebar-vars" data-name="PushPromise" data-ty="struct" 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">Struct <a href="../index.html">h2</a>::<wbr><a href="index.html">client</a>::<wbr><a class="struct" href="">PushPromise</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/client.rs.html#257-263" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct PushPromise { /* fields omitted */ }</pre></div><div class="docblock"><p>A pushed response and corresponding request headers</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../../h2/client/struct.PushPromise.html" title="struct h2::client::PushPromise">PushPromise</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#1374-1390" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.request" class="method"><code>pub fn <a href="#method.request" class="fnname">request</a>(&self) -> &<a class="struct" href="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/h2/client.rs.html#1376-1378" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a reference to the push promise’s request headers.</p>
|
||||
</div><h4 id="method.request_mut" class="method"><code>pub fn <a href="#method.request_mut" class="fnname">request_mut</a>(&mut self) -> &mut <a class="struct" href="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/h2/client.rs.html#1381-1383" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a mutable reference to the push promise’s request headers.</p>
|
||||
</div><h4 id="method.into_parts" class="method"><code>pub fn <a href="#method.into_parts" class="fnname">into_parts</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>, <a class="struct" href="../../h2/client/struct.PushedResponseFuture.html" title="struct h2::client::PushedResponseFuture">PushedResponseFuture</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class="srclink" href="../../src/h2/client.rs.html#1387-1389" title="goto source code">[src]</a></h4><div class="docblock"><p>Consumes <code>self</code>, returning the push promise’s request headers and
|
||||
response future.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Debug" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../h2/client/struct.PushPromise.html" title="struct h2::client::PushPromise">PushPromise</a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#256" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../src/h2/client.rs.html#256" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../h2/client/struct.PushPromise.html" title="struct h2::client::PushPromise">PushPromise</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../h2/client/struct.PushPromise.html" title="struct h2::client::PushPromise">PushPromise</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../h2/client/struct.PushPromise.html" title="struct h2::client::PushPromise">PushPromise</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../h2/client/struct.PushPromise.html" title="struct h2::client::PushPromise">PushPromise</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../h2/client/struct.PushPromise.html" title="struct h2::client::PushPromise">PushPromise</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-Instrument" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</code><a href="#impl-Instrument" class="anchor"></a><a class="srclink" href="../../src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.instrument" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#38" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
|
||||
</div><h4 id="method.in_current_span" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#74" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></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>
|
||||
@@ -0,0 +1,21 @@
|
||||
<!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="A stream of pushed responses and corresponding promised requests"><meta name="keywords" content="rust, rustlang, rust-lang, PushPromises"><title>h2::client::PushPromises - 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 struct"><!--[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><p class="location">Struct PushPromises</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.push_promise">push_promise</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">h2</a>::<wbr><a href="index.html">client</a></p><div id="sidebar-vars" data-name="PushPromises" data-ty="struct" 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">Struct <a href="../index.html">h2</a>::<wbr><a href="index.html">client</a>::<wbr><a class="struct" href="">PushPromises</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/client.rs.html#268-270" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct"><span class="docblock attributes top-attr">#[must_use = "streams do nothing unless polled"]</span>pub struct PushPromises { /* fields omitted */ }</pre></div><div class="docblock"><p>A stream of pushed responses and corresponding promised requests</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../../h2/client/struct.PushPromises.html" title="struct h2::client::PushPromises">PushPromises</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#1335-1361" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.push_promise" class="method"><code>pub async fn <a href="#method.push_promise" class="fnname">push_promise</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</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/client/struct.PushPromise.html" title="struct h2::client::PushPromise">PushPromise</a>, <a class="struct" href="../../h2/struct.Error.html" title="struct h2::Error">Error</a>>></code><a class="srclink" href="../../src/h2/client.rs.html#1337-1339" title="goto source code">[src]</a></h4><div class="docblock"><p>Get the next <code>PushPromise</code>.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Debug" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../h2/client/struct.PushPromises.html" title="struct h2::client::PushPromises">PushPromises</a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#266" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../src/h2/client.rs.html#266" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../h2/client/struct.PushPromises.html" title="struct h2::client::PushPromises">PushPromises</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../h2/client/struct.PushPromises.html" title="struct h2::client::PushPromises">PushPromises</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../h2/client/struct.PushPromises.html" title="struct h2::client::PushPromises">PushPromises</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../h2/client/struct.PushPromises.html" title="struct h2::client::PushPromises">PushPromises</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../h2/client/struct.PushPromises.html" title="struct h2::client::PushPromises">PushPromises</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-Instrument" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</code><a href="#impl-Instrument" class="anchor"></a><a class="srclink" href="../../src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.instrument" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#38" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
|
||||
</div><h4 id="method.in_current_span" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#74" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></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>
|
||||
@@ -0,0 +1,88 @@
|
||||
<!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="A future of a pushed HTTP response."><meta name="keywords" content="rust, rustlang, rust-lang, PushedResponseFuture"><title>h2::client::PushedResponseFuture - 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 struct"><!--[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><p class="location">Struct PushedResponseFuture</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.stream_id">stream_id</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Future">Future</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-FutureExt">FutureExt</a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-IntoFuture">IntoFuture</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryFuture">TryFuture</a><a href="#impl-TryFutureExt">TryFutureExt</a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">h2</a>::<wbr><a href="index.html">client</a></p><div id="sidebar-vars" data-name="PushedResponseFuture" data-ty="struct" 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">Struct <a href="../index.html">h2</a>::<wbr><a href="index.html">client</a>::<wbr><a class="struct" href="">PushedResponseFuture</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/client.rs.html#251-253" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct"><span class="docblock attributes top-attr">#[must_use = "futures do nothing unless polled"]</span>pub struct PushedResponseFuture { /* fields omitted */ }</pre></div><div class="docblock"><p>A future of a pushed HTTP response.</p>
|
||||
<p>We have to differentiate between pushed and non pushed because of the spec
|
||||
<a href="https://httpwg.org/specs/rfc7540.html#PUSH_PROMISE">https://httpwg.org/specs/rfc7540.html#PUSH_PROMISE</a></p>
|
||||
<blockquote>
|
||||
<p>PUSH_PROMISE frames MUST only be sent on a peer-initiated stream
|
||||
that is in either the “open” or “half-closed (remote)” state.</p>
|
||||
</blockquote>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../../h2/client/struct.PushedResponseFuture.html" title="struct h2::client::PushedResponseFuture">PushedResponseFuture</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#1402-1411" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.stream_id" class="method"><code>pub fn <a href="#method.stream_id" class="fnname">stream_id</a>(&self) -> <a class="struct" href="../../h2/struct.StreamId.html" title="struct h2::StreamId">StreamId</a></code><a class="srclink" href="../../src/h2/client.rs.html#1408-1410" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns the stream ID of the response stream.</p>
|
||||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||||
<p>If the lock on the stream store has been poisoned.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Debug" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../h2/client/struct.PushedResponseFuture.html" title="struct h2::client::PushedResponseFuture">PushedResponseFuture</a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#249" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../src/h2/client.rs.html#249" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id="impl-Future" class="impl"><code class="in-band">impl <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/client/struct.PushedResponseFuture.html" title="struct h2::client::PushedResponseFuture">PushedResponseFuture</a></code><a href="#impl-Future" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#1394-1400" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output" class="type"><code>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="../../http/response/struct.Response.html" title="struct http::response::Response">Response</a><<a class="struct" href="../../h2/struct.RecvStream.html" title="struct h2::RecvStream">RecvStream</a>>, <a class="struct" href="../../h2/struct.Error.html" title="struct h2::Error">Error</a>></code></h4><div class='docblock'><p>The type of value produced on completion.</p>
|
||||
</div><h4 id="method.poll" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#tymethod.poll" class="fnname">poll</a>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>></code><a class="srclink" href="../../src/h2/client.rs.html#1397-1399" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Attempt to resolve the future to a final value, registering
|
||||
the current task for wakeup if the value is not yet available. <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#tymethod.poll">Read more</a></p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../h2/client/struct.PushedResponseFuture.html" title="struct h2::client::PushedResponseFuture">PushedResponseFuture</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../h2/client/struct.PushedResponseFuture.html" title="struct h2::client::PushedResponseFuture">PushedResponseFuture</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../h2/client/struct.PushedResponseFuture.html" title="struct h2::client::PushedResponseFuture">PushedResponseFuture</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../h2/client/struct.PushedResponseFuture.html" title="struct h2::client::PushedResponseFuture">PushedResponseFuture</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../h2/client/struct.PushedResponseFuture.html" title="struct h2::client::PushedResponseFuture">PushedResponseFuture</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-FutureExt" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../futures_util/future/future/trait.FutureExt.html" title="trait futures_util::future::future::FutureExt">FutureExt</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-FutureExt" class="anchor"></a><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#119" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.map" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.map" class="fnname">map</a><U, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/future/struct.Map.html" title="struct futures_util::future::future::Map">Map</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>) -> U, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#146-149" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Map this future’s output to a different type, returning a new future of
|
||||
the resulting type. <a href="../../futures_util/future/future/trait.FutureExt.html#method.map">Read more</a></p>
|
||||
</div><h4 id="method.map_into" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.map_into" class="fnname">map_into</a><U>(self) -> <a class="struct" href="../../futures_util/future/future/struct.MapInto.html" title="struct futures_util::future::future::MapInto">MapInto</a><Self, U> <span class="where fmt-newline">where<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#159-162" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Map this future’s output to a different type, returning a new future of
|
||||
the resulting type. <a href="../../futures_util/future/future/trait.FutureExt.html#method.map_into">Read more</a></p>
|
||||
</div><h4 id="method.then" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.then" class="fnname">then</a><Fut, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/future/struct.Then.html" title="struct futures_util::future::future::Then">Then</a><Self, Fut, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>) -> Fut,<br> Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#191-195" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Chain on a computation for when a future finished, passing the result of
|
||||
the future to the provided closure <code>f</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.then">Read more</a></p>
|
||||
</div><h4 id="method.left_future" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.left_future" class="fnname">left_future</a><B>(self) -> <a class="enum" href="../../futures_util/future/either/enum.Either.html" title="enum futures_util::future::either::Either">Either</a><Self, B> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#222-225" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Wrap this future in an <code>Either</code> future, making it the left-hand variant
|
||||
of that <code>Either</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.left_future">Read more</a></p>
|
||||
</div><h4 id="method.right_future" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.right_future" class="fnname">right_future</a><A>(self) -> <a class="enum" href="../../futures_util/future/either/enum.Either.html" title="enum futures_util::future::either::Either">Either</a><A, Self> <span class="where fmt-newline">where<br> 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><Output = Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#252-255" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Wrap this future in an <code>Either</code> future, making it the right-hand variant
|
||||
of that <code>Either</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.right_future">Read more</a></p>
|
||||
</div><h4 id="method.into_stream" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.into_stream" class="fnname">into_stream</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.IntoStream.html" title="struct futures_util::future::future::IntoStream">IntoStream</a><Self></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#278-280" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Convert this future into a single element stream. <a href="../../futures_util/future/future/trait.FutureExt.html#method.into_stream">Read more</a></p>
|
||||
</div><h4 id="method.flatten" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.flatten" class="fnname">flatten</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.Flatten.html" title="struct futures_util::future::future::Flatten">Flatten</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</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>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#307-310" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Flatten the execution of this future when the output of this
|
||||
future is itself another future. <a href="../../futures_util/future/future/trait.FutureExt.html#method.flatten">Read more</a></p>
|
||||
</div><h4 id="method.flatten_stream" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.flatten_stream" class="fnname">flatten_stream</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.FlattenStream.html" title="struct futures_util::future::future::FlattenStream">FlattenStream</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>: <a class="trait" href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream">Stream</a>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#341-344" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Flatten the execution of this future when the successful result of this
|
||||
future is a stream. <a href="../../futures_util/future/future/trait.FutureExt.html#method.flatten_stream">Read more</a></p>
|
||||
</div><h4 id="method.fuse" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.fuse" class="fnname">fuse</a>(self) -> <a class="struct" href="../../futures_util/future/future/fuse/struct.Fuse.html" title="struct futures_util::future::future::fuse::Fuse">Fuse</a><Self></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#365-367" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Fuse a future such that <code>poll</code> will never again be called once it has
|
||||
completed. This method can be used to turn any <code>Future</code> into a
|
||||
<code>FusedFuture</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.fuse">Read more</a></p>
|
||||
</div><h4 id="method.inspect" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.inspect" class="fnname">inspect</a><F>(self, f: F) -> <a class="struct" href="../../futures_util/future/future/struct.Inspect.html" title="struct futures_util::future::future::Inspect">Inspect</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>), </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#391-394" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Do something with the output of a future before passing it on. <a href="../../futures_util/future/future/trait.FutureExt.html#method.inspect">Read more</a></p>
|
||||
</div><h4 id="method.unit_error" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.unit_error" class="fnname">unit_error</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.UnitError.html" title="struct futures_util::future::future::UnitError">UnitError</a><Self></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#541-543" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Turns a <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html"><code>Future<Output = T></code></a> into a
|
||||
<a href="../../futures_core/future/trait.TryFuture.html"><code>TryFuture<Ok = T, Error = ()</code>></a>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.unit_error">Read more</a></p>
|
||||
</div><h4 id="method.never_error" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.never_error" class="fnname">never_error</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.NeverError.html" title="struct futures_util::future::future::NeverError">NeverError</a><Self></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#550-552" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Turns a <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html"><code>Future<Output = T></code></a> into a
|
||||
<a href="../../futures_core/future/trait.TryFuture.html"><code>TryFuture<Ok = T, Error = Never</code>></a>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.never_error">Read more</a></p>
|
||||
</div><h4 id="method.poll_unpin" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.poll_unpin" class="fnname">poll_unpin</a>(&mut self, cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#558-560" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>A convenience for calling <code>Future::poll</code> on <code>Unpin</code> future types.</p>
|
||||
</div><h4 id="method.now_or_never" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.now_or_never" class="fnname">now_or_never</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#596-598" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Evaluates and consumes the future, returning the resulting output if
|
||||
the future is ready after the first call to <code>Future::poll</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.now_or_never">Read more</a></p>
|
||||
</div></div><h3 id="impl-Instrument" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</code><a href="#impl-Instrument" class="anchor"></a><a class="srclink" href="../../src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.instrument" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#38" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
|
||||
</div><h4 id="method.in_current_span" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#74" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-IntoFuture" class="impl"><code class="in-band">impl<F> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html" title="trait core::future::into_future::IntoFuture">IntoFuture</a> for F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>, </span></code><a href="#impl-IntoFuture" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/future/into_future.rs.html#20-27" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#associatedtype.Output" class="type">Output</a> = <F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a></code></h4><div class="item-info"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>into_future</code>)</div></div><div class='docblock'><p>The output that the future will produce on completion.</p>
|
||||
</div><h4 id="associatedtype.Future" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#associatedtype.Future" class="type">Future</a> = F</code></h4><div class="item-info"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>into_future</code>)</div></div><div class='docblock'><p>Which kind of future are we turning this into?</p>
|
||||
</div><h4 id="method.into_future" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#tymethod.into_future" class="fnname">into_future</a>(self) -> <F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html" title="trait core::future::into_future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#associatedtype.Future" title="type core::future::into_future::IntoFuture::Future">Future</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/future/into_future.rs.html#24" title="goto source code">[src]</a></h4><div class="item-info hidden"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>into_future</code>)</div></div><div class='docblock hidden'><p>Creates a future from a value.</p>
|
||||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryFuture" class="impl"><code class="in-band">impl<F, T, E> <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a> for F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, E>> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-TryFuture" class="anchor"></a><a class="srclink" href="../../src/futures_core/future.rs.html#76-86" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Ok" class="type"><code>type <a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" class="type">Ok</a> = T</code></h4><div class='docblock'><p>The type of successful values yielded by this future</p>
|
||||
</div><h4 id="associatedtype.Error-2" class="type"><code>type <a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" class="type">Error</a> = E</code></h4><div class='docblock'><p>The type of failures yielded by this future</p>
|
||||
</div><h4 id="method.try_poll" class="method hidden"><code>pub fn <a href="../../futures_core/future/trait.TryFuture.html#tymethod.try_poll" class="fnname">try_poll</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>F>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>></code><a class="srclink" href="../../src/futures_core/future.rs.html#83" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Poll this <code>TryFuture</code> as if it were a <code>Future</code>. <a href="../../futures_core/future/trait.TryFuture.html#tymethod.try_poll">Read more</a></p>
|
||||
</div></div><h3 id="impl-TryFutureExt" class="impl"><code class="in-band">impl<Fut> <a class="trait" href="../../futures_util/future/try_future/trait.TryFutureExt.html" title="trait futures_util::future::try_future::TryFutureExt">TryFutureExt</a> for Fut <span class="where fmt-newline">where<br> Fut: <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-TryFutureExt" class="anchor"></a><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#134" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.map_ok" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_ok" class="fnname">map_ok</a><T, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.MapOk.html" title="struct futures_util::future::try_future::MapOk">MapOk</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>) -> T, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#217-220" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s success value to a different value. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_ok">Read more</a></p>
|
||||
</div><h4 id="method.map_ok_or_else" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_ok_or_else" class="fnname">map_ok_or_else</a><T, E, F>(self, e: E, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.MapOkOrElse.html" title="struct futures_util::future::try_future::MapOkOrElse">MapOkOrElse</a><Self, F, E> <span class="where fmt-newline">where<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>) -> T,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>) -> T, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#257-261" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s success value to a different value, and permits for error handling resulting in the same type. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_ok_or_else">Read more</a></p>
|
||||
</div><h4 id="method.map_err" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_err" class="fnname">map_err</a><E, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.MapErr.html" title="struct futures_util::future::try_future::MapErr">MapErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>) -> E, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#305-308" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s error value to a different value. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_err">Read more</a></p>
|
||||
</div><h4 id="method.err_into" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.err_into" class="fnname">err_into</a><E>(self) -> <a class="struct" href="../../futures_util/future/try_future/struct.ErrInto.html" title="struct futures_util::future::try_future::ErrInto">ErrInto</a><Self, E> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><E>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#335-338" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s <a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error"><code>Error</code></a> to a new error type
|
||||
using the <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"><code>Into</code></a> trait. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.err_into">Read more</a></p>
|
||||
</div><h4 id="method.ok_into" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.ok_into" class="fnname">ok_into</a><U>(self) -> <a class="struct" href="../../futures_util/future/try_future/struct.OkInto.html" title="struct futures_util::future::try_future::OkInto">OkInto</a><Self, U> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#345-348" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s <a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok"><code>Ok</code></a> to a new type
|
||||
using the <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"><code>Into</code></a> trait. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.ok_into">Read more</a></p>
|
||||
</div><h4 id="method.and_then" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.and_then" class="fnname">and_then</a><Fut, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.AndThen.html" title="struct futures_util::future::try_future::AndThen">AndThen</a><Self, Fut, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>) -> Fut,<br> Fut: <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a><Error = Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#389-393" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Executes another future after this one resolves successfully. The
|
||||
success value is passed to a closure to create this subsequent future. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.and_then">Read more</a></p>
|
||||
</div><h4 id="method.or_else" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.or_else" class="fnname">or_else</a><Fut, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.OrElse.html" title="struct futures_util::future::try_future::OrElse">OrElse</a><Self, Fut, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>) -> Fut,<br> Fut: <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a><Ok = Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#434-438" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Executes another future if this one resolves to an error. The
|
||||
error value is passed to a closure to create this subsequent future. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.or_else">Read more</a></p>
|
||||
</div><h4 id="method.inspect_ok" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.inspect_ok" class="fnname">inspect_ok</a><F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.InspectOk.html" title="struct futures_util::future::try_future::InspectOk">InspectOk</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>), </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#461-464" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Do something with the success value of a future before passing it on. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.inspect_ok">Read more</a></p>
|
||||
</div><h4 id="method.inspect_err" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.inspect_err" class="fnname">inspect_err</a><F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.InspectErr.html" title="struct futures_util::future::try_future::InspectErr">InspectErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>), </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#487-490" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Do something with the error value of a future before passing it on. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.inspect_err">Read more</a></p>
|
||||
</div><h4 id="method.try_flatten" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_flatten" class="fnname">try_flatten</a>(self) -> <a class="struct" href="../../futures_util/future/try_future/struct.TryFlatten.html" title="struct futures_util::future::try_future::TryFlatten">TryFlatten</a><Self, Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>: <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a>,<br> <Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a> as <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a>>::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a> == Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#499-502" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Flatten the execution of this future when the successful result of this
|
||||
future is another future. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_flatten">Read more</a></p>
|
||||
</div><h4 id="method.try_flatten_stream" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_flatten_stream" class="fnname">try_flatten_stream</a>(self) -> <a class="struct" href="../../futures_util/future/try_future/struct.TryFlattenStream.html" title="struct futures_util::future::try_future::TryFlattenStream">TryFlattenStream</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>: <a class="trait" href="../../futures_core/stream/trait.TryStream.html" title="trait futures_core::stream::TryStream">TryStream</a>,<br> <Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a> as <a class="trait" href="../../futures_core/stream/trait.TryStream.html" title="trait futures_core::stream::TryStream">TryStream</a>>::<a class="type" href="../../futures_core/stream/trait.TryStream.html#associatedtype.Error" title="type futures_core::stream::TryStream::Error">Error</a> == Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#532-535" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Flatten the execution of this future when the successful result of this
|
||||
future is a stream. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_flatten_stream">Read more</a></p>
|
||||
</div><h4 id="method.unwrap_or_else" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.unwrap_or_else" class="fnname">unwrap_or_else</a><F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.UnwrapOrElse.html" title="struct futures_util::future::try_future::UnwrapOrElse">UnwrapOrElse</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>) -> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#564-567" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Unwraps this future’s output, producing a future with this future’s
|
||||
<a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok"><code>Ok</code></a> type as its
|
||||
<a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output"><code>Output</code></a> type. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.unwrap_or_else">Read more</a></p>
|
||||
</div><h4 id="method.into_future-1" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.into_future" class="fnname">into_future</a>(self) -> <a class="struct" href="../../futures_util/future/try_future/into_future/struct.IntoFuture.html" title="struct futures_util::future::try_future::into_future::IntoFuture">IntoFuture</a><Self></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#604-606" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Wraps a <a href="../../futures_core/future/trait.TryFuture.html" title="TryFuture"><code>TryFuture</code></a> into a type that implements
|
||||
<a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html"><code>Future</code></a>. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.into_future">Read more</a></p>
|
||||
</div><h4 id="method.try_poll_unpin" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_poll_unpin" class="fnname">try_poll_unpin</a>(<br> &mut self, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>, Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#613-615" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>A convenience method for calling <a href="../../futures_core/future/trait.TryFuture.html#tymethod.try_poll" title="TryFuture::try_poll"><code>TryFuture::try_poll</code></a> on <a href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="Unpin"><code>Unpin</code></a>
|
||||
future types. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_poll_unpin">Read more</a></p>
|
||||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></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>
|
||||
@@ -0,0 +1,80 @@
|
||||
<!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="Returns a `SendRequest` instance once it is ready to send at least one request."><meta name="keywords" content="rust, rustlang, rust-lang, ReadySendRequest"><title>h2::client::ReadySendRequest - 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 struct"><!--[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><p class="location">Struct ReadySendRequest</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Future">Future</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-FutureExt">FutureExt</a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-IntoFuture">IntoFuture</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryFuture">TryFuture</a><a href="#impl-TryFutureExt">TryFutureExt</a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">h2</a>::<wbr><a href="index.html">client</a></p><div id="sidebar-vars" data-name="ReadySendRequest" data-ty="struct" 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">Struct <a href="../index.html">h2</a>::<wbr><a href="index.html">client</a>::<wbr><a class="struct" href="">ReadySendRequest</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/client.rs.html#183-185" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct ReadySendRequest<B: <a class="trait" href="../../bytes/buf/buf_impl/trait.Buf.html" title="trait bytes::buf::buf_impl::Buf">Buf</a>> { /* fields omitted */ }</pre></div><div class="docblock"><p>Returns a <code>SendRequest</code> instance once it is ready to send at least one
|
||||
request.</p>
|
||||
</div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Debug" class="impl"><code class="in-band">impl<B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../h2/client/struct.ReadySendRequest.html" title="struct h2::client::ReadySendRequest">ReadySendRequest</a><B></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#182" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../src/h2/client.rs.html#182" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id="impl-Future" class="impl"><code class="in-band">impl<B> <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/client/struct.ReadySendRequest.html" title="struct h2::client::ReadySendRequest">ReadySendRequest</a><B> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../bytes/buf/buf_impl/trait.Buf.html" title="trait bytes::buf::buf_impl::Buf">Buf</a> + 'static, </span></code><a href="#impl-Future" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#568-584" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output" class="type"><code>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/client/struct.SendRequest.html" title="struct h2::client::SendRequest">SendRequest</a><B>, <a class="struct" href="../../h2/struct.Error.html" title="struct h2::Error">Error</a>></code></h4><div class='docblock'><p>The type of value produced on completion.</p>
|
||||
</div><h4 id="method.poll" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#tymethod.poll" class="fnname">poll</a>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>></code><a class="srclink" href="../../src/h2/client.rs.html#574-583" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Attempt to resolve the future to a final value, registering
|
||||
the current task for wakeup if the value is not yet available. <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#tymethod.poll">Read more</a></p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../h2/client/struct.ReadySendRequest.html" title="struct h2::client::ReadySendRequest">ReadySendRequest</a><B></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../h2/client/struct.ReadySendRequest.html" title="struct h2::client::ReadySendRequest">ReadySendRequest</a><B> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../h2/client/struct.ReadySendRequest.html" title="struct h2::client::ReadySendRequest">ReadySendRequest</a><B> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../h2/client/struct.ReadySendRequest.html" title="struct h2::client::ReadySendRequest">ReadySendRequest</a><B></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../h2/client/struct.ReadySendRequest.html" title="struct h2::client::ReadySendRequest">ReadySendRequest</a><B></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-FutureExt" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../futures_util/future/future/trait.FutureExt.html" title="trait futures_util::future::future::FutureExt">FutureExt</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-FutureExt" class="anchor"></a><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#119" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.map" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.map" class="fnname">map</a><U, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/future/struct.Map.html" title="struct futures_util::future::future::Map">Map</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>) -> U, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#146-149" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Map this future’s output to a different type, returning a new future of
|
||||
the resulting type. <a href="../../futures_util/future/future/trait.FutureExt.html#method.map">Read more</a></p>
|
||||
</div><h4 id="method.map_into" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.map_into" class="fnname">map_into</a><U>(self) -> <a class="struct" href="../../futures_util/future/future/struct.MapInto.html" title="struct futures_util::future::future::MapInto">MapInto</a><Self, U> <span class="where fmt-newline">where<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#159-162" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Map this future’s output to a different type, returning a new future of
|
||||
the resulting type. <a href="../../futures_util/future/future/trait.FutureExt.html#method.map_into">Read more</a></p>
|
||||
</div><h4 id="method.then" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.then" class="fnname">then</a><Fut, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/future/struct.Then.html" title="struct futures_util::future::future::Then">Then</a><Self, Fut, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>) -> Fut,<br> Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#191-195" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Chain on a computation for when a future finished, passing the result of
|
||||
the future to the provided closure <code>f</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.then">Read more</a></p>
|
||||
</div><h4 id="method.left_future" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.left_future" class="fnname">left_future</a><B>(self) -> <a class="enum" href="../../futures_util/future/either/enum.Either.html" title="enum futures_util::future::either::Either">Either</a><Self, B> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#222-225" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Wrap this future in an <code>Either</code> future, making it the left-hand variant
|
||||
of that <code>Either</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.left_future">Read more</a></p>
|
||||
</div><h4 id="method.right_future" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.right_future" class="fnname">right_future</a><A>(self) -> <a class="enum" href="../../futures_util/future/either/enum.Either.html" title="enum futures_util::future::either::Either">Either</a><A, Self> <span class="where fmt-newline">where<br> 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><Output = Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#252-255" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Wrap this future in an <code>Either</code> future, making it the right-hand variant
|
||||
of that <code>Either</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.right_future">Read more</a></p>
|
||||
</div><h4 id="method.into_stream" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.into_stream" class="fnname">into_stream</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.IntoStream.html" title="struct futures_util::future::future::IntoStream">IntoStream</a><Self></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#278-280" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Convert this future into a single element stream. <a href="../../futures_util/future/future/trait.FutureExt.html#method.into_stream">Read more</a></p>
|
||||
</div><h4 id="method.flatten" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.flatten" class="fnname">flatten</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.Flatten.html" title="struct futures_util::future::future::Flatten">Flatten</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</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>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#307-310" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Flatten the execution of this future when the output of this
|
||||
future is itself another future. <a href="../../futures_util/future/future/trait.FutureExt.html#method.flatten">Read more</a></p>
|
||||
</div><h4 id="method.flatten_stream" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.flatten_stream" class="fnname">flatten_stream</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.FlattenStream.html" title="struct futures_util::future::future::FlattenStream">FlattenStream</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>: <a class="trait" href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream">Stream</a>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#341-344" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Flatten the execution of this future when the successful result of this
|
||||
future is a stream. <a href="../../futures_util/future/future/trait.FutureExt.html#method.flatten_stream">Read more</a></p>
|
||||
</div><h4 id="method.fuse" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.fuse" class="fnname">fuse</a>(self) -> <a class="struct" href="../../futures_util/future/future/fuse/struct.Fuse.html" title="struct futures_util::future::future::fuse::Fuse">Fuse</a><Self></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#365-367" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Fuse a future such that <code>poll</code> will never again be called once it has
|
||||
completed. This method can be used to turn any <code>Future</code> into a
|
||||
<code>FusedFuture</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.fuse">Read more</a></p>
|
||||
</div><h4 id="method.inspect" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.inspect" class="fnname">inspect</a><F>(self, f: F) -> <a class="struct" href="../../futures_util/future/future/struct.Inspect.html" title="struct futures_util::future::future::Inspect">Inspect</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>), </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#391-394" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Do something with the output of a future before passing it on. <a href="../../futures_util/future/future/trait.FutureExt.html#method.inspect">Read more</a></p>
|
||||
</div><h4 id="method.unit_error" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.unit_error" class="fnname">unit_error</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.UnitError.html" title="struct futures_util::future::future::UnitError">UnitError</a><Self></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#541-543" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Turns a <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html"><code>Future<Output = T></code></a> into a
|
||||
<a href="../../futures_core/future/trait.TryFuture.html"><code>TryFuture<Ok = T, Error = ()</code>></a>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.unit_error">Read more</a></p>
|
||||
</div><h4 id="method.never_error" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.never_error" class="fnname">never_error</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.NeverError.html" title="struct futures_util::future::future::NeverError">NeverError</a><Self></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#550-552" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Turns a <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html"><code>Future<Output = T></code></a> into a
|
||||
<a href="../../futures_core/future/trait.TryFuture.html"><code>TryFuture<Ok = T, Error = Never</code>></a>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.never_error">Read more</a></p>
|
||||
</div><h4 id="method.poll_unpin" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.poll_unpin" class="fnname">poll_unpin</a>(&mut self, cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#558-560" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>A convenience for calling <code>Future::poll</code> on <code>Unpin</code> future types.</p>
|
||||
</div><h4 id="method.now_or_never" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.now_or_never" class="fnname">now_or_never</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#596-598" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Evaluates and consumes the future, returning the resulting output if
|
||||
the future is ready after the first call to <code>Future::poll</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.now_or_never">Read more</a></p>
|
||||
</div></div><h3 id="impl-Instrument" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</code><a href="#impl-Instrument" class="anchor"></a><a class="srclink" href="../../src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.instrument" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#38" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
|
||||
</div><h4 id="method.in_current_span" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#74" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-IntoFuture" class="impl"><code class="in-band">impl<F> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html" title="trait core::future::into_future::IntoFuture">IntoFuture</a> for F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>, </span></code><a href="#impl-IntoFuture" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/future/into_future.rs.html#20-27" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#associatedtype.Output" class="type">Output</a> = <F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a></code></h4><div class="item-info"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>into_future</code>)</div></div><div class='docblock'><p>The output that the future will produce on completion.</p>
|
||||
</div><h4 id="associatedtype.Future" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#associatedtype.Future" class="type">Future</a> = F</code></h4><div class="item-info"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>into_future</code>)</div></div><div class='docblock'><p>Which kind of future are we turning this into?</p>
|
||||
</div><h4 id="method.into_future" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#tymethod.into_future" class="fnname">into_future</a>(self) -> <F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html" title="trait core::future::into_future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#associatedtype.Future" title="type core::future::into_future::IntoFuture::Future">Future</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/future/into_future.rs.html#24" title="goto source code">[src]</a></h4><div class="item-info hidden"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>into_future</code>)</div></div><div class='docblock hidden'><p>Creates a future from a value.</p>
|
||||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryFuture" class="impl"><code class="in-band">impl<F, T, E> <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a> for F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, E>> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-TryFuture" class="anchor"></a><a class="srclink" href="../../src/futures_core/future.rs.html#76-86" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Ok" class="type"><code>type <a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" class="type">Ok</a> = T</code></h4><div class='docblock'><p>The type of successful values yielded by this future</p>
|
||||
</div><h4 id="associatedtype.Error-2" class="type"><code>type <a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" class="type">Error</a> = E</code></h4><div class='docblock'><p>The type of failures yielded by this future</p>
|
||||
</div><h4 id="method.try_poll" class="method hidden"><code>pub fn <a href="../../futures_core/future/trait.TryFuture.html#tymethod.try_poll" class="fnname">try_poll</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>F>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>></code><a class="srclink" href="../../src/futures_core/future.rs.html#83" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Poll this <code>TryFuture</code> as if it were a <code>Future</code>. <a href="../../futures_core/future/trait.TryFuture.html#tymethod.try_poll">Read more</a></p>
|
||||
</div></div><h3 id="impl-TryFutureExt" class="impl"><code class="in-band">impl<Fut> <a class="trait" href="../../futures_util/future/try_future/trait.TryFutureExt.html" title="trait futures_util::future::try_future::TryFutureExt">TryFutureExt</a> for Fut <span class="where fmt-newline">where<br> Fut: <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-TryFutureExt" class="anchor"></a><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#134" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.map_ok" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_ok" class="fnname">map_ok</a><T, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.MapOk.html" title="struct futures_util::future::try_future::MapOk">MapOk</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>) -> T, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#217-220" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s success value to a different value. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_ok">Read more</a></p>
|
||||
</div><h4 id="method.map_ok_or_else" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_ok_or_else" class="fnname">map_ok_or_else</a><T, E, F>(self, e: E, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.MapOkOrElse.html" title="struct futures_util::future::try_future::MapOkOrElse">MapOkOrElse</a><Self, F, E> <span class="where fmt-newline">where<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>) -> T,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>) -> T, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#257-261" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s success value to a different value, and permits for error handling resulting in the same type. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_ok_or_else">Read more</a></p>
|
||||
</div><h4 id="method.map_err" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_err" class="fnname">map_err</a><E, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.MapErr.html" title="struct futures_util::future::try_future::MapErr">MapErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>) -> E, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#305-308" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s error value to a different value. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_err">Read more</a></p>
|
||||
</div><h4 id="method.err_into" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.err_into" class="fnname">err_into</a><E>(self) -> <a class="struct" href="../../futures_util/future/try_future/struct.ErrInto.html" title="struct futures_util::future::try_future::ErrInto">ErrInto</a><Self, E> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><E>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#335-338" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s <a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error"><code>Error</code></a> to a new error type
|
||||
using the <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"><code>Into</code></a> trait. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.err_into">Read more</a></p>
|
||||
</div><h4 id="method.ok_into" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.ok_into" class="fnname">ok_into</a><U>(self) -> <a class="struct" href="../../futures_util/future/try_future/struct.OkInto.html" title="struct futures_util::future::try_future::OkInto">OkInto</a><Self, U> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#345-348" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s <a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok"><code>Ok</code></a> to a new type
|
||||
using the <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"><code>Into</code></a> trait. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.ok_into">Read more</a></p>
|
||||
</div><h4 id="method.and_then" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.and_then" class="fnname">and_then</a><Fut, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.AndThen.html" title="struct futures_util::future::try_future::AndThen">AndThen</a><Self, Fut, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>) -> Fut,<br> Fut: <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a><Error = Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#389-393" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Executes another future after this one resolves successfully. The
|
||||
success value is passed to a closure to create this subsequent future. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.and_then">Read more</a></p>
|
||||
</div><h4 id="method.or_else" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.or_else" class="fnname">or_else</a><Fut, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.OrElse.html" title="struct futures_util::future::try_future::OrElse">OrElse</a><Self, Fut, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>) -> Fut,<br> Fut: <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a><Ok = Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#434-438" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Executes another future if this one resolves to an error. The
|
||||
error value is passed to a closure to create this subsequent future. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.or_else">Read more</a></p>
|
||||
</div><h4 id="method.inspect_ok" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.inspect_ok" class="fnname">inspect_ok</a><F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.InspectOk.html" title="struct futures_util::future::try_future::InspectOk">InspectOk</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>), </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#461-464" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Do something with the success value of a future before passing it on. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.inspect_ok">Read more</a></p>
|
||||
</div><h4 id="method.inspect_err" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.inspect_err" class="fnname">inspect_err</a><F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.InspectErr.html" title="struct futures_util::future::try_future::InspectErr">InspectErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>), </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#487-490" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Do something with the error value of a future before passing it on. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.inspect_err">Read more</a></p>
|
||||
</div><h4 id="method.try_flatten" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_flatten" class="fnname">try_flatten</a>(self) -> <a class="struct" href="../../futures_util/future/try_future/struct.TryFlatten.html" title="struct futures_util::future::try_future::TryFlatten">TryFlatten</a><Self, Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>: <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a>,<br> <Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a> as <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a>>::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a> == Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#499-502" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Flatten the execution of this future when the successful result of this
|
||||
future is another future. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_flatten">Read more</a></p>
|
||||
</div><h4 id="method.try_flatten_stream" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_flatten_stream" class="fnname">try_flatten_stream</a>(self) -> <a class="struct" href="../../futures_util/future/try_future/struct.TryFlattenStream.html" title="struct futures_util::future::try_future::TryFlattenStream">TryFlattenStream</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>: <a class="trait" href="../../futures_core/stream/trait.TryStream.html" title="trait futures_core::stream::TryStream">TryStream</a>,<br> <Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a> as <a class="trait" href="../../futures_core/stream/trait.TryStream.html" title="trait futures_core::stream::TryStream">TryStream</a>>::<a class="type" href="../../futures_core/stream/trait.TryStream.html#associatedtype.Error" title="type futures_core::stream::TryStream::Error">Error</a> == Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#532-535" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Flatten the execution of this future when the successful result of this
|
||||
future is a stream. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_flatten_stream">Read more</a></p>
|
||||
</div><h4 id="method.unwrap_or_else" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.unwrap_or_else" class="fnname">unwrap_or_else</a><F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.UnwrapOrElse.html" title="struct futures_util::future::try_future::UnwrapOrElse">UnwrapOrElse</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>) -> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#564-567" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Unwraps this future’s output, producing a future with this future’s
|
||||
<a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok"><code>Ok</code></a> type as its
|
||||
<a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output"><code>Output</code></a> type. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.unwrap_or_else">Read more</a></p>
|
||||
</div><h4 id="method.into_future-1" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.into_future" class="fnname">into_future</a>(self) -> <a class="struct" href="../../futures_util/future/try_future/into_future/struct.IntoFuture.html" title="struct futures_util::future::try_future::into_future::IntoFuture">IntoFuture</a><Self></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#604-606" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Wraps a <a href="../../futures_core/future/trait.TryFuture.html" title="TryFuture"><code>TryFuture</code></a> into a type that implements
|
||||
<a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html"><code>Future</code></a>. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.into_future">Read more</a></p>
|
||||
</div><h4 id="method.try_poll_unpin" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_poll_unpin" class="fnname">try_poll_unpin</a>(<br> &mut self, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>, Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#613-615" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>A convenience method for calling <a href="../../futures_core/future/trait.TryFuture.html#tymethod.try_poll" title="TryFuture::try_poll"><code>TryFuture::try_poll</code></a> on <a href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="Unpin"><code>Unpin</code></a>
|
||||
future types. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_poll_unpin">Read more</a></p>
|
||||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></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>
|
||||
@@ -0,0 +1,86 @@
|
||||
<!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="A future of an HTTP response."><meta name="keywords" content="rust, rustlang, rust-lang, ResponseFuture"><title>h2::client::ResponseFuture - 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 struct"><!--[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><p class="location">Struct ResponseFuture</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.push_promises">push_promises</a><a href="#method.stream_id">stream_id</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Future">Future</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-FutureExt">FutureExt</a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-IntoFuture">IntoFuture</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryFuture">TryFuture</a><a href="#impl-TryFutureExt">TryFutureExt</a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">h2</a>::<wbr><a href="index.html">client</a></p><div id="sidebar-vars" data-name="ResponseFuture" data-ty="struct" 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">Struct <a href="../index.html">h2</a>::<wbr><a href="index.html">client</a>::<wbr><a class="struct" href="">ResponseFuture</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/client.rs.html#238-241" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct"><span class="docblock attributes top-attr">#[must_use = "futures do nothing unless polled"]</span>pub struct ResponseFuture { /* fields omitted */ }</pre></div><div class="docblock"><p>A future of an HTTP response.</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../../h2/client/struct.ResponseFuture.html" title="struct h2::client::ResponseFuture">ResponseFuture</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#1307-1331" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.stream_id" class="method"><code>pub fn <a href="#method.stream_id" class="fnname">stream_id</a>(&self) -> <a class="struct" href="../../h2/struct.StreamId.html" title="struct h2::StreamId">StreamId</a></code><a class="srclink" href="../../src/h2/client.rs.html#1313-1315" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns the stream ID of the response stream.</p>
|
||||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||||
<p>If the lock on the stream store has been poisoned.</p>
|
||||
</div><h4 id="method.push_promises" class="method"><code>pub fn <a href="#method.push_promises" class="fnname">push_promises</a>(&mut self) -> <a class="struct" href="../../h2/client/struct.PushPromises.html" title="struct h2::client::PushPromises">PushPromises</a></code><a class="srclink" href="../../src/h2/client.rs.html#1322-1330" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a stream of PushPromises</p>
|
||||
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
|
||||
<p>If this method has been called before
|
||||
or the stream was itself was pushed</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Debug" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../h2/client/struct.ResponseFuture.html" title="struct h2::client::ResponseFuture">ResponseFuture</a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#236" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../src/h2/client.rs.html#236" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id="impl-Future" class="impl"><code class="in-band">impl <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/client/struct.ResponseFuture.html" title="struct h2::client::ResponseFuture">ResponseFuture</a></code><a href="#impl-Future" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#1296-1305" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output" class="type"><code>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="../../http/response/struct.Response.html" title="struct http::response::Response">Response</a><<a class="struct" href="../../h2/struct.RecvStream.html" title="struct h2::RecvStream">RecvStream</a>>, <a class="struct" href="../../h2/struct.Error.html" title="struct h2::Error">Error</a>></code></h4><div class='docblock'><p>The type of value produced on completion.</p>
|
||||
</div><h4 id="method.poll" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#tymethod.poll" class="fnname">poll</a>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>></code><a class="srclink" href="../../src/h2/client.rs.html#1299-1304" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Attempt to resolve the future to a final value, registering
|
||||
the current task for wakeup if the value is not yet available. <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#tymethod.poll">Read more</a></p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../h2/client/struct.ResponseFuture.html" title="struct h2::client::ResponseFuture">ResponseFuture</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../h2/client/struct.ResponseFuture.html" title="struct h2::client::ResponseFuture">ResponseFuture</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../h2/client/struct.ResponseFuture.html" title="struct h2::client::ResponseFuture">ResponseFuture</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../h2/client/struct.ResponseFuture.html" title="struct h2::client::ResponseFuture">ResponseFuture</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../h2/client/struct.ResponseFuture.html" title="struct h2::client::ResponseFuture">ResponseFuture</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-FutureExt" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../futures_util/future/future/trait.FutureExt.html" title="trait futures_util::future::future::FutureExt">FutureExt</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-FutureExt" class="anchor"></a><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#119" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.map" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.map" class="fnname">map</a><U, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/future/struct.Map.html" title="struct futures_util::future::future::Map">Map</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>) -> U, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#146-149" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Map this future’s output to a different type, returning a new future of
|
||||
the resulting type. <a href="../../futures_util/future/future/trait.FutureExt.html#method.map">Read more</a></p>
|
||||
</div><h4 id="method.map_into" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.map_into" class="fnname">map_into</a><U>(self) -> <a class="struct" href="../../futures_util/future/future/struct.MapInto.html" title="struct futures_util::future::future::MapInto">MapInto</a><Self, U> <span class="where fmt-newline">where<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#159-162" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Map this future’s output to a different type, returning a new future of
|
||||
the resulting type. <a href="../../futures_util/future/future/trait.FutureExt.html#method.map_into">Read more</a></p>
|
||||
</div><h4 id="method.then" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.then" class="fnname">then</a><Fut, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/future/struct.Then.html" title="struct futures_util::future::future::Then">Then</a><Self, Fut, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>) -> Fut,<br> Fut: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#191-195" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Chain on a computation for when a future finished, passing the result of
|
||||
the future to the provided closure <code>f</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.then">Read more</a></p>
|
||||
</div><h4 id="method.left_future" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.left_future" class="fnname">left_future</a><B>(self) -> <a class="enum" href="../../futures_util/future/either/enum.Either.html" title="enum futures_util::future::either::Either">Either</a><Self, B> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#222-225" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Wrap this future in an <code>Either</code> future, making it the left-hand variant
|
||||
of that <code>Either</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.left_future">Read more</a></p>
|
||||
</div><h4 id="method.right_future" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.right_future" class="fnname">right_future</a><A>(self) -> <a class="enum" href="../../futures_util/future/either/enum.Either.html" title="enum futures_util::future::either::Either">Either</a><A, Self> <span class="where fmt-newline">where<br> 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><Output = Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#252-255" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Wrap this future in an <code>Either</code> future, making it the right-hand variant
|
||||
of that <code>Either</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.right_future">Read more</a></p>
|
||||
</div><h4 id="method.into_stream" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.into_stream" class="fnname">into_stream</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.IntoStream.html" title="struct futures_util::future::future::IntoStream">IntoStream</a><Self></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#278-280" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Convert this future into a single element stream. <a href="../../futures_util/future/future/trait.FutureExt.html#method.into_stream">Read more</a></p>
|
||||
</div><h4 id="method.flatten" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.flatten" class="fnname">flatten</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.Flatten.html" title="struct futures_util::future::future::Flatten">Flatten</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</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>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#307-310" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Flatten the execution of this future when the output of this
|
||||
future is itself another future. <a href="../../futures_util/future/future/trait.FutureExt.html#method.flatten">Read more</a></p>
|
||||
</div><h4 id="method.flatten_stream" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.flatten_stream" class="fnname">flatten_stream</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.FlattenStream.html" title="struct futures_util::future::future::FlattenStream">FlattenStream</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>: <a class="trait" href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream">Stream</a>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#341-344" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Flatten the execution of this future when the successful result of this
|
||||
future is a stream. <a href="../../futures_util/future/future/trait.FutureExt.html#method.flatten_stream">Read more</a></p>
|
||||
</div><h4 id="method.fuse" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.fuse" class="fnname">fuse</a>(self) -> <a class="struct" href="../../futures_util/future/future/fuse/struct.Fuse.html" title="struct futures_util::future::future::fuse::Fuse">Fuse</a><Self></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#365-367" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Fuse a future such that <code>poll</code> will never again be called once it has
|
||||
completed. This method can be used to turn any <code>Future</code> into a
|
||||
<code>FusedFuture</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.fuse">Read more</a></p>
|
||||
</div><h4 id="method.inspect" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.inspect" class="fnname">inspect</a><F>(self, f: F) -> <a class="struct" href="../../futures_util/future/future/struct.Inspect.html" title="struct futures_util::future::future::Inspect">Inspect</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>), </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#391-394" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Do something with the output of a future before passing it on. <a href="../../futures_util/future/future/trait.FutureExt.html#method.inspect">Read more</a></p>
|
||||
</div><h4 id="method.unit_error" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.unit_error" class="fnname">unit_error</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.UnitError.html" title="struct futures_util::future::future::UnitError">UnitError</a><Self></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#541-543" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Turns a <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html"><code>Future<Output = T></code></a> into a
|
||||
<a href="../../futures_core/future/trait.TryFuture.html"><code>TryFuture<Ok = T, Error = ()</code>></a>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.unit_error">Read more</a></p>
|
||||
</div><h4 id="method.never_error" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.never_error" class="fnname">never_error</a>(self) -> <a class="struct" href="../../futures_util/future/future/struct.NeverError.html" title="struct futures_util::future::future::NeverError">NeverError</a><Self></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#550-552" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Turns a <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html"><code>Future<Output = T></code></a> into a
|
||||
<a href="../../futures_core/future/trait.TryFuture.html"><code>TryFuture<Ok = T, Error = Never</code>></a>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.never_error">Read more</a></p>
|
||||
</div><h4 id="method.poll_unpin" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.poll_unpin" class="fnname">poll_unpin</a>(&mut self, cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#558-560" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>A convenience for calling <code>Future::poll</code> on <code>Unpin</code> future types.</p>
|
||||
</div><h4 id="method.now_or_never" class="method hidden"><code>pub fn <a href="../../futures_util/future/future/trait.FutureExt.html#method.now_or_never" class="fnname">now_or_never</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>></code><a class="srclink" href="../../src/futures_util/future/future/mod.rs.html#596-598" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Evaluates and consumes the future, returning the resulting output if
|
||||
the future is ready after the first call to <code>Future::poll</code>. <a href="../../futures_util/future/future/trait.FutureExt.html#method.now_or_never">Read more</a></p>
|
||||
</div></div><h3 id="impl-Instrument" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</code><a href="#impl-Instrument" class="anchor"></a><a class="srclink" href="../../src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.instrument" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#38" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
|
||||
</div><h4 id="method.in_current_span" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#74" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-IntoFuture" class="impl"><code class="in-band">impl<F> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html" title="trait core::future::into_future::IntoFuture">IntoFuture</a> for F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>, </span></code><a href="#impl-IntoFuture" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/future/into_future.rs.html#20-27" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#associatedtype.Output" class="type">Output</a> = <F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a></code></h4><div class="item-info"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>into_future</code>)</div></div><div class='docblock'><p>The output that the future will produce on completion.</p>
|
||||
</div><h4 id="associatedtype.Future" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#associatedtype.Future" class="type">Future</a> = F</code></h4><div class="item-info"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>into_future</code>)</div></div><div class='docblock'><p>Which kind of future are we turning this into?</p>
|
||||
</div><h4 id="method.into_future" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#tymethod.into_future" class="fnname">into_future</a>(self) -> <F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html" title="trait core::future::into_future::IntoFuture">IntoFuture</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#associatedtype.Future" title="type core::future::into_future::IntoFuture::Future">Future</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/future/into_future.rs.html#24" title="goto source code">[src]</a></h4><div class="item-info hidden"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>into_future</code>)</div></div><div class='docblock hidden'><p>Creates a future from a value.</p>
|
||||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryFuture" class="impl"><code class="in-band">impl<F, T, E> <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a> for F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, E>> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-TryFuture" class="anchor"></a><a class="srclink" href="../../src/futures_core/future.rs.html#76-86" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Ok" class="type"><code>type <a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" class="type">Ok</a> = T</code></h4><div class='docblock'><p>The type of successful values yielded by this future</p>
|
||||
</div><h4 id="associatedtype.Error-2" class="type"><code>type <a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" class="type">Error</a> = E</code></h4><div class='docblock'><p>The type of failures yielded by this future</p>
|
||||
</div><h4 id="method.try_poll" class="method hidden"><code>pub fn <a href="../../futures_core/future/trait.TryFuture.html#tymethod.try_poll" class="fnname">try_poll</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>F>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>></code><a class="srclink" href="../../src/futures_core/future.rs.html#83" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Poll this <code>TryFuture</code> as if it were a <code>Future</code>. <a href="../../futures_core/future/trait.TryFuture.html#tymethod.try_poll">Read more</a></p>
|
||||
</div></div><h3 id="impl-TryFutureExt" class="impl"><code class="in-band">impl<Fut> <a class="trait" href="../../futures_util/future/try_future/trait.TryFutureExt.html" title="trait futures_util::future::try_future::TryFutureExt">TryFutureExt</a> for Fut <span class="where fmt-newline">where<br> Fut: <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-TryFutureExt" class="anchor"></a><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#134" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.map_ok" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_ok" class="fnname">map_ok</a><T, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.MapOk.html" title="struct futures_util::future::try_future::MapOk">MapOk</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>) -> T, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#217-220" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s success value to a different value. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_ok">Read more</a></p>
|
||||
</div><h4 id="method.map_ok_or_else" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_ok_or_else" class="fnname">map_ok_or_else</a><T, E, F>(self, e: E, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.MapOkOrElse.html" title="struct futures_util::future::try_future::MapOkOrElse">MapOkOrElse</a><Self, F, E> <span class="where fmt-newline">where<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>) -> T,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>) -> T, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#257-261" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s success value to a different value, and permits for error handling resulting in the same type. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_ok_or_else">Read more</a></p>
|
||||
</div><h4 id="method.map_err" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_err" class="fnname">map_err</a><E, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.MapErr.html" title="struct futures_util::future::try_future::MapErr">MapErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>) -> E, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#305-308" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s error value to a different value. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.map_err">Read more</a></p>
|
||||
</div><h4 id="method.err_into" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.err_into" class="fnname">err_into</a><E>(self) -> <a class="struct" href="../../futures_util/future/try_future/struct.ErrInto.html" title="struct futures_util::future::try_future::ErrInto">ErrInto</a><Self, E> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><E>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#335-338" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s <a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error"><code>Error</code></a> to a new error type
|
||||
using the <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"><code>Into</code></a> trait. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.err_into">Read more</a></p>
|
||||
</div><h4 id="method.ok_into" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.ok_into" class="fnname">ok_into</a><U>(self) -> <a class="struct" href="../../futures_util/future/try_future/struct.OkInto.html" title="struct futures_util::future::try_future::OkInto">OkInto</a><Self, U> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#345-348" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this future’s <a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok"><code>Ok</code></a> to a new type
|
||||
using the <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"><code>Into</code></a> trait. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.ok_into">Read more</a></p>
|
||||
</div><h4 id="method.and_then" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.and_then" class="fnname">and_then</a><Fut, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.AndThen.html" title="struct futures_util::future::try_future::AndThen">AndThen</a><Self, Fut, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>) -> Fut,<br> Fut: <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a><Error = Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#389-393" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Executes another future after this one resolves successfully. The
|
||||
success value is passed to a closure to create this subsequent future. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.and_then">Read more</a></p>
|
||||
</div><h4 id="method.or_else" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.or_else" class="fnname">or_else</a><Fut, F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.OrElse.html" title="struct futures_util::future::try_future::OrElse">OrElse</a><Self, Fut, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>) -> Fut,<br> Fut: <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a><Ok = Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#434-438" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Executes another future if this one resolves to an error. The
|
||||
error value is passed to a closure to create this subsequent future. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.or_else">Read more</a></p>
|
||||
</div><h4 id="method.inspect_ok" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.inspect_ok" class="fnname">inspect_ok</a><F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.InspectOk.html" title="struct futures_util::future::try_future::InspectOk">InspectOk</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>), </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#461-464" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Do something with the success value of a future before passing it on. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.inspect_ok">Read more</a></p>
|
||||
</div><h4 id="method.inspect_err" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.inspect_err" class="fnname">inspect_err</a><F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.InspectErr.html" title="struct futures_util::future::try_future::InspectErr">InspectErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>), </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#487-490" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Do something with the error value of a future before passing it on. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.inspect_err">Read more</a></p>
|
||||
</div><h4 id="method.try_flatten" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_flatten" class="fnname">try_flatten</a>(self) -> <a class="struct" href="../../futures_util/future/try_future/struct.TryFlatten.html" title="struct futures_util::future::try_future::TryFlatten">TryFlatten</a><Self, Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>: <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a>,<br> <Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a> as <a class="trait" href="../../futures_core/future/trait.TryFuture.html" title="trait futures_core::future::TryFuture">TryFuture</a>>::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a> == Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#499-502" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Flatten the execution of this future when the successful result of this
|
||||
future is another future. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_flatten">Read more</a></p>
|
||||
</div><h4 id="method.try_flatten_stream" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_flatten_stream" class="fnname">try_flatten_stream</a>(self) -> <a class="struct" href="../../futures_util/future/try_future/struct.TryFlattenStream.html" title="struct futures_util::future::try_future::TryFlattenStream">TryFlattenStream</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>: <a class="trait" href="../../futures_core/stream/trait.TryStream.html" title="trait futures_core::stream::TryStream">TryStream</a>,<br> <Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a> as <a class="trait" href="../../futures_core/stream/trait.TryStream.html" title="trait futures_core::stream::TryStream">TryStream</a>>::<a class="type" href="../../futures_core/stream/trait.TryStream.html#associatedtype.Error" title="type futures_core::stream::TryStream::Error">Error</a> == Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#532-535" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Flatten the execution of this future when the successful result of this
|
||||
future is a stream. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_flatten_stream">Read more</a></p>
|
||||
</div><h4 id="method.unwrap_or_else" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.unwrap_or_else" class="fnname">unwrap_or_else</a><F>(self, f: F) -> <a class="struct" href="../../futures_util/future/try_future/struct.UnwrapOrElse.html" title="struct futures_util::future::try_future::UnwrapOrElse">UnwrapOrElse</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>) -> Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#564-567" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Unwraps this future’s output, producing a future with this future’s
|
||||
<a href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok"><code>Ok</code></a> type as its
|
||||
<a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output"><code>Output</code></a> type. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.unwrap_or_else">Read more</a></p>
|
||||
</div><h4 id="method.into_future-1" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.into_future" class="fnname">into_future</a>(self) -> <a class="struct" href="../../futures_util/future/try_future/into_future/struct.IntoFuture.html" title="struct futures_util::future::try_future::into_future::IntoFuture">IntoFuture</a><Self></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#604-606" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Wraps a <a href="../../futures_core/future/trait.TryFuture.html" title="TryFuture"><code>TryFuture</code></a> into a type that implements
|
||||
<a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html"><code>Future</code></a>. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.into_future">Read more</a></p>
|
||||
</div><h4 id="method.try_poll_unpin" class="method hidden"><code>pub fn <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_poll_unpin" class="fnname">try_poll_unpin</a>(<br> &mut self, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Ok" title="type futures_core::future::TryFuture::Ok">Ok</a>, Self::<a class="type" href="../../futures_core/future/trait.TryFuture.html#associatedtype.Error" title="type futures_core::future::TryFuture::Error">Error</a>>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a class="srclink" href="../../src/futures_util/future/try_future/mod.rs.html#613-615" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>A convenience method for calling <a href="../../futures_core/future/trait.TryFuture.html#tymethod.try_poll" title="TryFuture::try_poll"><code>TryFuture::try_poll</code></a> on <a href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="Unpin"><code>Unpin</code></a>
|
||||
future types. <a href="../../futures_util/future/try_future/trait.TryFutureExt.html#method.try_poll_unpin">Read more</a></p>
|
||||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></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>
|
||||
@@ -0,0 +1,133 @@
|
||||
<!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="Initializes new HTTP/2.0 streams on a connection by sending a request."><meta name="keywords" content="rust, rustlang, rust-lang, SendRequest"><title>h2::client::SendRequest - 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 struct"><!--[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><p class="location">Struct SendRequest</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.poll_ready">poll_ready</a><a href="#method.ready">ready</a><a href="#method.send_request">send_request</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">h2</a>::<wbr><a href="index.html">client</a></p><div id="sidebar-vars" data-name="SendRequest" data-ty="struct" 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">Struct <a href="../index.html">h2</a>::<wbr><a href="index.html">client</a>::<wbr><a class="struct" href="">SendRequest</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/client.rs.html#175-178" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct SendRequest<B: <a class="trait" href="../../bytes/buf/buf_impl/trait.Buf.html" title="trait bytes::buf::buf_impl::Buf">Buf</a>> { /* fields omitted */ }</pre></div><div class="docblock"><p>Initializes new HTTP/2.0 streams on a connection by sending a request.</p>
|
||||
<p>This type does no work itself. Instead, it is a handle to the inner
|
||||
connection state held by <a href="struct.Connection.html"><code>Connection</code></a>. If the associated connection
|
||||
instance is dropped, all <code>SendRequest</code> functions will return <a href="../struct.Error.html"><code>Error</code></a>.</p>
|
||||
<p><a href="../../h2/client/struct.SendRequest.html" title="SendRequest"><code>SendRequest</code></a> instances are able to move to and operate on separate tasks
|
||||
/ threads than their associated <a href="struct.Connection.html"><code>Connection</code></a> instance. Internally, there
|
||||
is a buffer used to stage requests before they get written to the
|
||||
connection. There is no guarantee that requests get written to the
|
||||
connection in FIFO order as HTTP/2.0 prioritization logic can play a role.</p>
|
||||
<p><a href="../../h2/client/struct.SendRequest.html" title="SendRequest"><code>SendRequest</code></a> implements <a href="https://doc.rust-lang.org/std/clone/trait.Clone.html"><code>Clone</code></a>, enabling the creation of many
|
||||
instances that are backed by a single connection.</p>
|
||||
<p>See <a href="index.html">module</a> level documentation for more details.</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<B> <a class="struct" href="../../h2/client/struct.SendRequest.html" title="struct h2::client::SendRequest">SendRequest</a><B> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../bytes/buf/buf_impl/trait.Buf.html" title="trait bytes::buf::buf_impl::Buf">Buf</a> + 'static, </span></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#338-520" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.poll_ready" class="method"><code>pub fn <a href="#method.poll_ready" class="fnname">poll_ready</a>(&mut self, cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../h2/struct.Error.html" title="struct h2::Error">Error</a>>></code><a class="srclink" href="../../src/h2/client.rs.html#352-356" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns <code>Ready</code> when the connection can initialize a new HTTP/2.0
|
||||
stream.</p>
|
||||
<p>This function must return <code>Ready</code> before <code>send_request</code> is called. When
|
||||
<code>Poll::Pending</code> is returned, the task will be notified once the readiness
|
||||
state changes.</p>
|
||||
<p>See <a href="index.html">module</a> level docs for more details.</p>
|
||||
</div><h4 id="method.ready" class="method"><code>pub fn <a href="#method.ready" class="fnname">ready</a>(self) -> <a class="struct" href="../../h2/client/struct.ReadySendRequest.html" title="struct h2::client::ReadySendRequest">ReadySendRequest</a><B><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/client/struct.ReadySendRequest.html" title="struct h2::client::ReadySendRequest">ReadySendRequest</a><B></h3><code class="content"><span class="where fmt-newline">impl<B> <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/client/struct.ReadySendRequest.html" title="struct h2::client::ReadySendRequest">ReadySendRequest</a><B> <span class="where fmt-newline">where<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/client/struct.SendRequest.html" title="struct h2::client::SendRequest">SendRequest</a><B>, <a class="struct" href="../../h2/struct.Error.html" title="struct h2::Error">Error</a>>;</span></code></span></div></span></span></code><a class="srclink" href="../../src/h2/client.rs.html#386-388" title="goto source code">[src]</a></h4><div class="docblock"><p>Consumes <code>self</code>, returning a future that returns <code>self</code> back once it is
|
||||
ready to send a request.</p>
|
||||
<p>This function should be called before calling <code>send_request</code>.</p>
|
||||
<p>This is a functional combinator for <a href="#method.poll_ready"><code>poll_ready</code></a>. The returned future
|
||||
will call <code>SendStream::poll_ready</code> until <code>Ready</code>, then returns <code>self</code> to
|
||||
the caller.</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="comment">// First, wait until the `send_request` handle is ready to send a new</span>
|
||||
<span class="comment">// request</span>
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">send_request</span> <span class="op">=</span> <span class="ident">send_request</span>.<span class="ident">ready</span>().<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="comment">// Use `send_request` here.</span></pre></div>
|
||||
<p>See <a href="index.html">module</a> level docs for more details.</p>
|
||||
</div><h4 id="method.send_request" class="method"><code>pub fn <a href="#method.send_request" class="fnname">send_request</a>(<br> &mut self, <br> request: <a class="struct" href="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>, <br> end_of_stream: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../../h2/client/struct.ResponseFuture.html" title="struct h2::client::ResponseFuture">ResponseFuture</a>, <a class="struct" href="../../h2/struct.SendStream.html" title="struct h2::SendStream">SendStream</a><B><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="struct" href="../../h2/struct.Error.html" title="struct h2::Error">Error</a>></code><a class="srclink" href="../../src/h2/client.rs.html#497-519" title="goto source code">[src]</a></h4><div class="docblock"><p>Sends a HTTP/2.0 request to the server.</p>
|
||||
<p><code>send_request</code> initializes a new HTTP/2.0 stream on the associated
|
||||
connection, then sends the given request using this new stream. Only the
|
||||
request head is sent.</p>
|
||||
<p>On success, a <a href="struct.ResponseFuture.html"><code>ResponseFuture</code></a> instance and <a href="../struct.SendStream.html"><code>SendStream</code></a> instance
|
||||
are returned. The <a href="struct.ResponseFuture.html"><code>ResponseFuture</code></a> instance is used to get the
|
||||
server’s response and the <a href="../struct.SendStream.html"><code>SendStream</code></a> instance is used to send a
|
||||
request body or trailers to the server over the same HTTP/2.0 stream.</p>
|
||||
<p>To send a request body or trailers, set <code>end_of_stream</code> to <code>false</code>.
|
||||
Then, use the returned <a href="../struct.SendStream.html"><code>SendStream</code></a> instance to stream request body
|
||||
chunks or send trailers. If <code>end_of_stream</code> is <strong>not</strong> set to <code>false</code>
|
||||
then attempting to call <a href="../struct.SendStream.html#method.send_data"><code>SendStream::send_data</code></a> or
|
||||
<a href="../struct.SendStream.html#method.send_trailers"><code>SendStream::send_trailers</code></a> will result in an error.</p>
|
||||
<p>If no request body or trailers are to be sent, set <code>end_of_stream</code> to
|
||||
<code>true</code> and drop the returned <a href="../struct.SendStream.html"><code>SendStream</code></a> instance.</p>
|
||||
<h1 id="a-note-on-http-versions" class="section-header"><a href="#a-note-on-http-versions">A note on HTTP versions</a></h1>
|
||||
<p>The provided <code>Request</code> will be encoded differently depending on the
|
||||
value of its version field. If the version is set to 2.0, then the
|
||||
request is encoded as per the specification recommends.</p>
|
||||
<p>If the version is set to a lower value, then the request is encoded to
|
||||
preserve the characteristics of HTTP 1.1 and lower. Specifically, host
|
||||
headers are permitted and the <code>:authority</code> pseudo header is not
|
||||
included.</p>
|
||||
<p>The caller should always set the request’s version field to 2.0 unless
|
||||
specifically transmitting an HTTP 1.1 request over 2.0.</p>
|
||||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||||
<p>Sending a request with no body</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// First, wait until the `send_request` handle is ready to send a new</span>
|
||||
<span class="comment">// request</span>
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">send_request</span> <span class="op">=</span> <span class="ident">send_request</span>.<span class="ident">ready</span>().<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="comment">// Prepare the HTTP request to send to the server.</span>
|
||||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">get</span>(<span class="string">"https://www.example.com/"</span>)
|
||||
.<span class="ident">body</span>(())
|
||||
.<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="comment">// Send the request to the server. Since we are not sending a</span>
|
||||
<span class="comment">// body or trailers, we can drop the `SendStream` instance.</span>
|
||||
<span class="kw">let</span> (<span class="ident">response</span>, <span class="kw">_</span>) <span class="op">=</span> <span class="ident">send_request</span>.<span class="ident">send_request</span>(<span class="ident">request</span>, <span class="bool-val">true</span>).<span class="ident">unwrap</span>();
|
||||
<span class="kw">let</span> <span class="ident">response</span> <span class="op">=</span> <span class="ident">response</span>.<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="comment">// Process the response</span></pre></div>
|
||||
<p>Sending a request with a body and trailers</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="comment">// First, wait until the `send_request` handle is ready to send a new</span>
|
||||
<span class="comment">// request</span>
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">send_request</span> <span class="op">=</span> <span class="ident">send_request</span>.<span class="ident">ready</span>().<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="comment">// Prepare the HTTP request to send to the server.</span>
|
||||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">get</span>(<span class="string">"https://www.example.com/"</span>)
|
||||
.<span class="ident">body</span>(())
|
||||
.<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="comment">// Send the request to the server. If we are not sending a</span>
|
||||
<span class="comment">// body or trailers, we can drop the `SendStream` instance.</span>
|
||||
<span class="kw">let</span> (<span class="ident">response</span>, <span class="kw-2">mut</span> <span class="ident">send_stream</span>) <span class="op">=</span> <span class="ident">send_request</span>
|
||||
.<span class="ident">send_request</span>(<span class="ident">request</span>, <span class="bool-val">false</span>).<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="comment">// At this point, one option would be to wait for send capacity.</span>
|
||||
<span class="comment">// Doing so would allow us to not hold data in memory that</span>
|
||||
<span class="comment">// cannot be sent. However, this is not a requirement, so this</span>
|
||||
<span class="comment">// example will skip that step. See `SendStream` documentation</span>
|
||||
<span class="comment">// for more details.</span>
|
||||
<span class="ident">send_stream</span>.<span class="ident">send_data</span>(<span class="string">b"hello"</span>, <span class="bool-val">false</span>).<span class="ident">unwrap</span>();
|
||||
<span class="ident">send_stream</span>.<span class="ident">send_data</span>(<span class="string">b"world"</span>, <span class="bool-val">false</span>).<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="comment">// Send the trailers.</span>
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">trailers</span> <span class="op">=</span> <span class="ident">HeaderMap</span>::<span class="ident">new</span>();
|
||||
<span class="ident">trailers</span>.<span class="ident">insert</span>(
|
||||
<span class="ident">header</span>::<span class="ident">HeaderName</span>::<span class="ident">from_bytes</span>(<span class="string">b"my-trailer"</span>).<span class="ident">unwrap</span>(),
|
||||
<span class="ident">header</span>::<span class="ident">HeaderValue</span>::<span class="ident">from_bytes</span>(<span class="string">b"hello"</span>).<span class="ident">unwrap</span>());
|
||||
|
||||
<span class="ident">send_stream</span>.<span class="ident">send_trailers</span>(<span class="ident">trailers</span>).<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="kw">let</span> <span class="ident">response</span> <span class="op">=</span> <span class="ident">response</span>.<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="comment">// Process the response</span></pre></div>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Clone" class="impl"><code class="in-band">impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../h2/client/struct.SendRequest.html" title="struct h2::client::SendRequest">SendRequest</a><B> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../bytes/buf/buf_impl/trait.Buf.html" title="trait bytes::buf::buf_impl::Buf">Buf</a>, </span></code><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#531-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.clone" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> Self</code><a class="srclink" href="../../src/h2/client.rs.html#535-540" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
</div><h4 id="method.clone_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#128" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||||
</div></div><h3 id="impl-Debug" class="impl"><code class="in-band">impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../h2/client/struct.SendRequest.html" title="struct h2::client::SendRequest">SendRequest</a><B> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../bytes/buf/buf_impl/trait.Buf.html" title="trait bytes::buf::buf_impl::Buf">Buf</a>, </span></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/h2/client.rs.html#522-529" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../src/h2/client.rs.html#526-528" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../h2/client/struct.SendRequest.html" title="struct h2::client::SendRequest">SendRequest</a><B></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../h2/client/struct.SendRequest.html" title="struct h2::client::SendRequest">SendRequest</a><B> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../h2/client/struct.SendRequest.html" title="struct h2::client::SendRequest">SendRequest</a><B> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../h2/client/struct.SendRequest.html" title="struct h2::client::SendRequest">SendRequest</a><B></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../h2/client/struct.SendRequest.html" title="struct h2::client::SendRequest">SendRequest</a><B></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-Instrument" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</code><a href="#impl-Instrument" class="anchor"></a><a class="srclink" href="../../src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.instrument" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#38" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
|
||||
</div><h4 id="method.in_current_span" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#74" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-ToOwned" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href="#impl-ToOwned" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-93" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Owned" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||||
</div><h4 id="method.to_owned" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#86" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||||
</div><h4 id="method.clone_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#90" title="goto source code">[src]</a></h4><div class="item-info hidden"><div class="stab unstable"><details><summary><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
||||
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||||
</div></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>
|
||||
Reference in New Issue
Block a user