mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 04:10:02 +01:00
53 lines
8.3 KiB
HTML
53 lines
8.3 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `client` mod in crate `hyper`."><meta name="keywords" content="rust, rustlang, rust-lang, client"><title>hyper::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='../../hyper/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="#modules">Modules</a></li><li><a href="#structs">Structs</a></li></ul></div><p class="location"><a href="../index.html">hyper</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">hyper</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/hyper/client/mod.rs.html#1-68" title="goto source code">[src]</a></span></h1><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="../../hyper/client/struct.Client.html"><code>Client</code></a> type.</li>
|
||
<li>The lower-level <a href="../../hyper/client/conn/index.html"><code>conn</code></a> module.</li>
|
||
</ul>
|
||
<h1 id="client" class="section-header"><a href="#client">Client</a></h1>
|
||
<p>The <a href="../../hyper/client/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="../../hyper/client/struct.Client.html#method.builder"><code>Client::builder</code></a>.</p>
|
||
<h2 id="example" class="section-header"><a href="#example">Example</a></h2>
|
||
<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">
|
||
<span class="kw">use</span> <span class="ident">hyper</span>::{<span class="ident">body</span>::<span class="ident">HttpBody</span> <span class="kw">as</span> <span class="kw">_</span>, <span class="ident">Client</span>, <span class="ident">Uri</span>};
|
||
|
||
<span class="kw">let</span> <span class="ident">client</span> <span class="op">=</span> <span class="ident">Client</span>::<span class="ident">new</span>();
|
||
|
||
<span class="comment">// Make a GET /ip to 'http://httpbin.org'</span>
|
||
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">client</span>.<span class="ident">get</span>(<span class="ident">Uri</span>::<span class="ident">from_static</span>(<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="macro">!</span>(<span class="string">"status: {}"</span>, <span class="ident">res</span>.<span class="ident">status</span>());
|
||
|
||
<span class="comment">// Concatenate the body stream into a single buffer...</span>
|
||
<span class="kw">let</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">hyper</span>::<span class="ident">body</span>::<span class="ident">to_bytes</span>(<span class="ident">res</span>).<span class="kw">await</span><span class="question-mark">?</span>;
|
||
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"body: {:?}"</span>, <span class="ident">buf</span>);</pre></div>
|
||
</div><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2>
|
||
<table><tr class="module-item"><td><a class="mod" href="conn/index.html" title="hyper::client::conn mod">conn</a></td><td class="docblock-short"><p>Lower-level client connection API.</p>
|
||
</td></tr><tr class="module-item"><td><a class="mod" href="connect/index.html" title="hyper::client::connect mod">connect</a></td><td class="docblock-short"><p>Connectors used by the <code>Client</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="mod" href="service/index.html" title="hyper::client::service mod">service</a></td><td class="docblock-short"><p>Utilities used to interact with the Tower ecosystem.</p>
|
||
</td></tr></table><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="hyper::client::Builder struct">Builder</a></td><td class="docblock-short"><p>A builder to configure a new <a href="../../hyper/client/struct.Client.html"><code>Client</code></a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Client.html" title="hyper::client::Client struct">Client</a></td><td class="docblock-short"><p>A Client to make outgoing HTTP requests.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.HttpConnector.html" title="hyper::client::HttpConnector struct">HttpConnector</a></td><td class="docblock-short"><p>A connector for the <code>http</code> scheme.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResponseFuture.html" title="hyper::client::ResponseFuture struct">ResponseFuture</a></td><td class="docblock-short"><p>A <code>Future</code> that will resolve to an HTTP Response.</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="hyper"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |