| <!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="HTTP Client"><meta name="keywords" content="rust, rustlang, rust-lang, client"><title>hyper::client - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.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><a class="sidebar-logo" href="../../hyper/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../hyper/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module client</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">hyper</a>::<wbr><a class="mod" href="#">client</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/hyper/client/mod.rs.html#1-68">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>HTTP Client</p> |
| <p>There are two levels of APIs provided for construct HTTP clients:</p> |
| <ul> |
| <li>The higher-level <a href="struct.Client.html"><code>Client</code></a> type.</li> |
| <li>The lower-level <a href="conn/index.html"><code>conn</code></a> module.</li> |
| </ul> |
| <h2 id="client"><a href="#client">Client</a></h2> |
| <p>The <a href="struct.Client.html"><code>Client</code></a> is the main way to send HTTP requests to a server. |
| The default <code>Client</code> provides these things on top of the lower-level API:</p> |
| <ul> |
| <li>A default <strong>connector</strong>, able to resolve hostnames and connect to |
| destinations over plain-text TCP.</li> |
| <li>A <strong>pool</strong> of existing connections, allowing better performance when |
| making multiple requests to the same hostname.</li> |
| <li>Automatic setting of the <code>Host</code> header, based on the request <code>Uri</code>.</li> |
| <li>Automatic request <strong>retries</strong> when a pooled connection is closed by the |
| server before any bytes have been written.</li> |
| </ul> |
| <p>Many of these features can configured, by making use of |
| <a href="struct.Client.html#method.builder"><code>Client::builder</code></a>.</p> |
| <h3 id="example"><a href="#example">Example</a></h3> |
| <p>For a small example program simply fetching a URL, take a look at the |
| <a href="https://github.com/hyperium/hyper/blob/master/examples/client.rs">full client example</a>.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hyper::{body::HttpBody <span class="kw">as _</span>, Client, Uri}; |
| |
| <span class="kw">let </span>client = Client::new(); |
| |
| <span class="comment">// Make a GET /ip to 'http://httpbin.org' |
| </span><span class="kw">let </span>res = client.get(Uri::from_static(<span class="string">"http://httpbin.org/ip"</span>)).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="comment">// And then, if the request gets a response... |
| </span><span class="macro">println!</span>(<span class="string">"status: {}"</span>, res.status()); |
| |
| <span class="comment">// Concatenate the body stream into a single buffer... |
| </span><span class="kw">let </span>buf = hyper::body::to_bytes(res).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="macro">println!</span>(<span class="string">"body: {:?}"</span>, buf);</code></pre></div> |
| </div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="conn/index.html" title="hyper::client::conn mod">conn</a></div><div class="item-right docblock-short">Lower-level client connection API.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="connect/index.html" title="hyper::client::connect mod">connect</a></div><div class="item-right docblock-short">Connectors used by the <code>Client</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="service/index.html" title="hyper::client::service mod">service</a></div><div class="item-right docblock-short">Utilities used to interact with the Tower ecosystem.</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Builder.html" title="hyper::client::Builder struct">Builder</a></div><div class="item-right docblock-short">A builder to configure a new <a href="struct.Client.html"><code>Client</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Client.html" title="hyper::client::Client struct">Client</a></div><div class="item-right docblock-short">A Client to make outgoing HTTP requests.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.HttpConnector.html" title="hyper::client::HttpConnector struct">HttpConnector</a></div><div class="item-right docblock-short">A connector for the <code>http</code> scheme.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ResponseFuture.html" title="hyper::client::ResponseFuture struct">ResponseFuture</a></div><div class="item-right docblock-short">A <code>Future</code> that will resolve to an HTTP Response.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="hyper" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
