mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 04:41:02 +01:00
55 lines
11 KiB
HTML
55 lines
11 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="Connectors used by the `Client`."><title>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 mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../hyper/index.html">hyper</a><span class="version">0.14.27</span></h2></div><h2 class="location"><a href="#">Module connect</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In hyper::client</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../hyper/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">hyper</a>::<wbr><a href="../index.html">client</a>::<wbr><a class="mod" href="#">connect</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#1-633">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Connectors used by the <code>Client</code>.</p>
|
||
<p>This module contains:</p>
|
||
<ul>
|
||
<li>A default <a href="struct.HttpConnector.html" title="struct hyper::client::connect::HttpConnector"><code>HttpConnector</code></a> that does DNS resolution and establishes
|
||
connections over TCP.</li>
|
||
<li>Types to build custom connectors.</li>
|
||
</ul>
|
||
<h2 id="connectors"><a href="#connectors">Connectors</a></h2>
|
||
<p>A “connector” is a <a href="../../service/trait.Service.html" title="trait hyper::service::Service"><code>Service</code></a> that takes a <a href="../../struct.Uri.html" title="struct hyper::Uri"><code>Uri</code></a> destination, and
|
||
its <code>Response</code> is some type implementing <a href="../../../tokio/io/async_read/trait.AsyncRead.html" title="trait tokio::io::async_read::AsyncRead"><code>AsyncRead</code></a>, <a href="../../../tokio/io/async_write/trait.AsyncWrite.html" title="trait tokio::io::async_write::AsyncWrite"><code>AsyncWrite</code></a>,
|
||
and <a href="trait.Connection.html" title="trait hyper::client::connect::Connection"><code>Connection</code></a>.</p>
|
||
<h3 id="custom-connectors"><a href="#custom-connectors">Custom Connectors</a></h3>
|
||
<p>A simple connector that ignores the <code>Uri</code> destination and always returns
|
||
a TCP connection to the same address could be written like this:</p>
|
||
|
||
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span>connector = tower::service_fn(|_dst| <span class="kw">async </span>{
|
||
tokio::net::TcpStream::connect(<span class="string">"127.0.0.1:1337"</span>)
|
||
})</code></pre></div>
|
||
<p>Or, fully written out:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::{future::Future, net::SocketAddr, pin::Pin, task::{<span class="self">self</span>, Poll}};
|
||
<span class="kw">use </span>hyper::{service::Service, Uri};
|
||
<span class="kw">use </span>tokio::net::TcpStream;
|
||
|
||
<span class="attr">#[derive(Clone)]
|
||
</span><span class="kw">struct </span>LocalConnector;
|
||
|
||
<span class="kw">impl </span>Service<Uri> <span class="kw">for </span>LocalConnector {
|
||
<span class="kw">type </span>Response = TcpStream;
|
||
<span class="kw">type </span>Error = std::io::Error;
|
||
<span class="comment">// We can't "name" an `async` generated future.
|
||
</span><span class="kw">type </span>Future = Pin<Box<
|
||
<span class="kw">dyn </span>Future<Output = <span class="prelude-ty">Result</span><<span class="self">Self</span>::Response, <span class="self">Self</span>::Error>> + Send
|
||
>>;
|
||
|
||
<span class="kw">fn </span>poll_ready(<span class="kw-2">&mut </span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>) -> Poll<<span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>> {
|
||
<span class="comment">// This connector is always ready, but others might not be.
|
||
</span>Poll::Ready(<span class="prelude-val">Ok</span>(()))
|
||
}
|
||
|
||
<span class="kw">fn </span>call(<span class="kw-2">&mut </span><span class="self">self</span>, <span class="kw">_</span>: Uri) -> <span class="self">Self</span>::Future {
|
||
Box::pin(TcpStream::connect(SocketAddr::from(([<span class="number">127</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">1</span>], <span class="number">1337</span>))))
|
||
}
|
||
}</code></pre></div>
|
||
<p>It’s worth noting that for <code>TcpStream</code>s, the <a href="struct.HttpConnector.html" title="struct hyper::client::connect::HttpConnector"><code>HttpConnector</code></a> is a
|
||
better starting place to extend from.</p>
|
||
<p>Using either of the above connector examples, it can be used with the
|
||
<code>Client</code> like this:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// let connector = ...
|
||
|
||
</span><span class="kw">let </span>client = hyper::Client::builder()
|
||
.build::<<span class="kw">_</span>, hyper::Body>(connector);</code></pre></div>
|
||
</div></details><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="dns/index.html" title="mod hyper::client::connect::dns">dns</a></div><div class="desc docblock-short">DNS Resolution used by the <code>HttpConnector</code>.</div></li></ul><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.CaptureConnection.html" title="struct hyper::client::connect::CaptureConnection">CaptureConnection</a></div><div class="desc docblock-short"><a href="struct.CaptureConnection.html" title="struct hyper::client::connect::CaptureConnection"><code>CaptureConnection</code></a> allows callers to capture <a href="struct.Connected.html" title="struct hyper::client::connect::Connected"><code>Connected</code></a> information</div></li><li><div class="item-name"><a class="struct" href="struct.Connected.html" title="struct hyper::client::connect::Connected">Connected</a></div><div class="desc docblock-short">Extra information about the connected transport.</div></li><li><div class="item-name"><a class="struct" href="struct.HttpConnector.html" title="struct hyper::client::connect::HttpConnector">HttpConnector</a></div><div class="desc docblock-short">A connector for the <code>http</code> scheme.</div></li><li><div class="item-name"><a class="struct" href="struct.HttpInfo.html" title="struct hyper::client::connect::HttpInfo">HttpInfo</a></div><div class="desc docblock-short">Extra information about the transport when an HttpConnector is used.</div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Connect.html" title="trait hyper::client::connect::Connect">Connect</a></div><div class="desc docblock-short">Connect to a destination, returning an IO transport.</div></li><li><div class="item-name"><a class="trait" href="trait.Connection.html" title="trait hyper::client::connect::Connection">Connection</a></div><div class="desc docblock-short">Describes a type returned by a connector.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.capture_connection.html" title="fn hyper::client::connect::capture_connection">capture_connection</a></div><div class="desc docblock-short">Capture the connection for a given request</div></li></ul></section></div></main></body></html> |