mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 12:20:17 +01:00
41 lines
7.8 KiB
HTML
41 lines
7.8 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Capture the connection for a given request"><title>capture_connection in hyper::client::connect - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="hyper" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../hyper/index.html">hyper</a><span class="version">0.14.27</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In hyper::client::connect</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../hyper/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../../index.html">hyper</a>::<wbr><a href="../index.html">client</a>::<wbr><a href="index.html">connect</a>::<wbr><a class="fn" href="#">capture_connection</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../src/hyper/client/connect/mod.rs.html#209-213">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn capture_connection<B>(request: &mut <a class="struct" href="../../struct.Request.html" title="struct hyper::Request">Request</a><B>) -> <a class="struct" href="struct.CaptureConnection.html" title="struct hyper::client::connect::CaptureConnection">CaptureConnection</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Capture the connection for a given request</p>
|
||
<p>When making a request with Hyper, the underlying connection must implement the <a href="trait.Connection.html" title="trait hyper::client::connect::Connection"><code>Connection</code></a> trait.
|
||
<a href="fn.capture_connection.html" title="fn hyper::client::connect::capture_connection"><code>capture_connection</code></a> allows a caller to capture the returned <a href="struct.Connected.html" title="struct hyper::client::connect::Connected"><code>Connected</code></a> structure as soon
|
||
as the connection is established.</p>
|
||
<p><em>Note</em>: If establishing a connection fails, <a href="struct.CaptureConnection.html#method.connection_metadata" title="method hyper::client::connect::CaptureConnection::connection_metadata"><code>CaptureConnection::connection_metadata</code></a> will always return none.</p>
|
||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||
<p><strong>Synchronous access</strong>:
|
||
The <a href="struct.CaptureConnection.html#method.connection_metadata" title="method hyper::client::connect::CaptureConnection::connection_metadata"><code>CaptureConnection::connection_metadata</code></a> method allows callers to check if a connection has been
|
||
established. This is ideal for situations where you are certain the connection has already
|
||
been established (e.g. after the response future has already completed).</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hyper::client::connect::{capture_connection, CaptureConnection};
|
||
<span class="kw">let </span><span class="kw-2">mut </span>request = http::Request::builder()
|
||
.uri(<span class="string">"http://foo.com"</span>)
|
||
.body(())
|
||
.unwrap();
|
||
|
||
<span class="kw">let </span>captured_connection = capture_connection(<span class="kw-2">&mut </span>request);
|
||
<span class="comment">// some time later after the request has been sent...
|
||
</span><span class="kw">let </span>connection_info = captured_connection.connection_metadata();
|
||
<span class="macro">println!</span>(<span class="string">"we are connected! {:?}"</span>, connection_info.as_ref());</code></pre></div>
|
||
<p><strong>Asynchronous access</strong>:
|
||
The <a href="struct.CaptureConnection.html#method.wait_for_connection_metadata" title="method hyper::client::connect::CaptureConnection::wait_for_connection_metadata"><code>CaptureConnection::wait_for_connection_metadata</code></a> method returns a future resolves as soon as the
|
||
connection is available.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hyper::client::connect::{capture_connection, CaptureConnection};
|
||
<span class="kw">let </span><span class="kw-2">mut </span>request = http::Request::builder()
|
||
.uri(<span class="string">"http://foo.com"</span>)
|
||
.body(hyper::Body::empty())
|
||
.unwrap();
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>captured = capture_connection(<span class="kw-2">&mut </span>request);
|
||
tokio::task::spawn(<span class="kw">async move </span>{
|
||
<span class="kw">let </span>connection_info = captured.wait_for_connection_metadata().<span class="kw">await</span>;
|
||
<span class="macro">println!</span>(<span class="string">"we are connected! {:?}"</span>, connection_info.as_ref());
|
||
});
|
||
|
||
<span class="kw">let </span>client = hyper::Client::new();
|
||
client.request(request).<span class="kw">await</span>.expect(<span class="string">"request failed"</span>);</code></pre></div>
|
||
</div></details></section></div></main></body></html> |