172 lines
19 KiB
HTML
172 lines
19 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` struct in crate `hyper`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Client">
|
|||
|
|
|
|||
|
|
<title>hyper::client::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="../../dark.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
|
|||
|
|
<script src="../../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</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>
|
|||
|
|
|
|||
|
|
<p class='location'>Struct Client</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.configure">configure</a><a href="#method.get">get</a><a href="#method.request">request</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Service">Service</a><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='../index.html'>hyper</a>::<wbr><a href='index.html'>client</a></p><script>window.sidebarCurrent = {name: 'Client', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="theme-picker">
|
|||
|
|
<button id="theme-picker" aria-label="Pick another theme!">
|
|||
|
|
<img src="../../brush.svg" width="18" alt="Pick another theme!">
|
|||
|
|
</button>
|
|||
|
|
<div id="theme-choices"></div>
|
|||
|
|
</div>
|
|||
|
|
<script src="../../theme.js"></script>
|
|||
|
|
<nav class="sub">
|
|||
|
|
<form class="search-form js-only">
|
|||
|
|
<div class="search-container">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>hyper</a>::<wbr><a href='index.html'>client</a>::<wbr><a class="struct" 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#44-51' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct Client<C, B = <a class="struct" href="../../hyper/struct.Body.html" title="struct hyper::Body">Body</a>> { /* fields omitted */ }</pre><div class='docblock'><p>A Client to make outgoing HTTP requests.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='methods' class='small-section-header'>
|
|||
|
|
Methods<a href='#methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../../hyper/client/struct.Client.html" title="struct hyper::client::Client">Client</a><<a class="struct" href="../../hyper/client/struct.HttpConnector.html" title="struct hyper::client::HttpConnector">HttpConnector</a>, <a class="struct" href="../../hyper/struct.Body.html" title="struct hyper::Body">Body</a>></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#53-59' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(handle: &<a class="struct" href="../../tokio_core/reactor/struct.Handle.html" title="struct tokio_core::reactor::Handle">Handle</a>) -> <a class="struct" href="../../hyper/client/struct.Client.html" title="struct hyper::client::Client">Client</a><<a class="struct" href="../../hyper/client/struct.HttpConnector.html" title="struct hyper::client::HttpConnector">HttpConnector</a>, <a class="struct" href="../../hyper/struct.Body.html" title="struct hyper::Body">Body</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#56-58' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Create a new Client with the default config.</p>
|
|||
|
|
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><code>impl <a class="struct" href="../../hyper/client/struct.Client.html" title="struct hyper::client::Client">Client</a><<a class="struct" href="../../hyper/client/struct.HttpConnector.html" title="struct hyper::client::HttpConnector">HttpConnector</a>, <a class="struct" href="../../hyper/struct.Body.html" title="struct hyper::Body">Body</a>></code><a href='#impl-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#61-83' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.configure' class="method"><span id='configure.v' class='invisible'><code>pub fn <a href='#method.configure' class='fnname'>configure</a>() -> <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a><<a class="struct" href="../../hyper/client/struct.UseDefaultConnector.html" title="struct hyper::client::UseDefaultConnector">UseDefaultConnector</a>, <a class="struct" href="../../hyper/struct.Body.html" title="struct hyper::Body">Body</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#80-82' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Configure a Client.</p>
|
|||
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">client</span> <span class="op">=</span> <span class="ident">hyper</span>::<span class="ident">Client</span>::<span class="ident">configure</span>()
|
|||
|
|
.<span class="ident">keep_alive</span>(<span class="bool-val">true</span>)
|
|||
|
|
.<span class="ident">build</span>(<span class="kw-2">&</span><span class="ident">handle</span>);</pre>
|
|||
|
|
</div></div><h3 id='impl-2' class='impl'><span class='in-band'><code>impl<C, B> <a class="struct" href="../../hyper/client/struct.Client.html" title="struct hyper::client::Client">Client</a><C, B> <span class="where fmt-newline">where<br> C: <a class="trait" href="../../hyper/client/trait.Connect.html" title="trait hyper::client::Connect">Connect</a>,<br> B: <a class="trait" href="../../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Error = <a class="enum" href="../../hyper/error/enum.Error.html" title="enum hyper::error::Error">Error</a>> + 'static,<br> B::<a class="type" href="../../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a href='#impl-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#111-297' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.get' class="method"><span id='get.v' class='invisible'><code>pub fn <a href='#method.get' class='fnname'>get</a>(&self, url: <a class="struct" href="../../hyper/struct.Uri.html" title="struct hyper::Uri">Uri</a>) -> <a class="struct" href="../../hyper/client/struct.FutureResponse.html" title="struct hyper::client::FutureResponse">FutureResponse</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#118-120' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Send a GET Request using this Client.</p>
|
|||
|
|
</div><h4 id='method.request' class="method"><span id='request.v' class='invisible'><code>pub fn <a href='#method.request' class='fnname'>request</a>(&self, req: <a class="struct" href="../../hyper/struct.Request.html" title="struct hyper::Request">Request</a><B>) -> <a class="struct" href="../../hyper/client/struct.FutureResponse.html" title="struct hyper::client::FutureResponse">FutureResponse</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#124-178' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Send a constructed Request using this Client.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-Service' class='impl'><span class='in-band'><code>impl<C, B> <a class="trait" href="../../hyper/server/trait.Service.html" title="trait hyper::server::Service">Service</a> for <a class="struct" href="../../hyper/client/struct.Client.html" title="struct hyper::client::Client">Client</a><C, B> <span class="where fmt-newline">where<br> C: <a class="trait" href="../../hyper/client/trait.Connect.html" title="trait hyper::client::Connect">Connect</a>,<br> B: <a class="trait" href="../../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Error = <a class="enum" href="../../hyper/error/enum.Error.html" title="enum hyper::error::Error">Error</a>> + 'static,<br> B::<a class="type" href="../../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a href='#impl-Service' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#299-312' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='associatedtype.Request' class="type"><span id='Request.t' class='invisible'><code>type <a href='../../hyper/server/trait.Service.html#associatedtype.Request' class="type">Request</a> = <a class="struct" href="../../hyper/struct.Request.html" title="struct hyper::Request">Request</a><B></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Requests handled by the service.</p>
|
|||
|
|
</div><h4 id='associatedtype.Response' class="type"><span id='Response.t' class='invisible'><code>type <a href='../../hyper/server/trait.Service.html#associatedtype.Response' class="type">Response</a> = <a class="struct" href="../../hyper/struct.Response.html" title="struct hyper::Response">Response</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Responses given by the service.</p>
|
|||
|
|
</div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='../../hyper/server/trait.Service.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="../../hyper/error/enum.Error.html" title="enum hyper::error::Error">Error</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Errors produced by the service.</p>
|
|||
|
|
</div><h4 id='associatedtype.Future' class="type"><span id='Future.t' class='invisible'><code>type <a href='../../hyper/server/trait.Service.html#associatedtype.Future' class="type">Future</a> = <a class="struct" href="../../hyper/client/struct.FutureResponse.html" title="struct hyper::client::FutureResponse">FutureResponse</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>The future response value.</p>
|
|||
|
|
</div><h4 id='method.call' class="method"><span id='call.v' class='invisible'><code>fn <a href='../../hyper/server/trait.Service.html#tymethod.call' class='fnname'>call</a>(&self, req: Self::<a class="type" href="../../hyper/server/trait.Service.html#associatedtype.Request" title="type hyper::server::Service::Request">Request</a>) -> Self::<a class="type" href="../../hyper/server/trait.Service.html#associatedtype.Future" title="type hyper::server::Service::Future">Future</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#309-311' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Process the request and return the response asynchronously.</p>
|
|||
|
|
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl<C, 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="../../hyper/client/struct.Client.html" title="struct hyper::client::Client">Client</a><C, B></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#314-325' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><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="../../hyper/client/struct.Client.html" title="struct hyper::client::Client">Client</a><C, B></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#315-324' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><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"><span id='clone_from.v' class='invisible'><code>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><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><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'><span class='in-band'><code>impl<C, 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="../../hyper/client/struct.Client.html" title="struct hyper::client::Client">Client</a><C, B></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#327-332' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#328-331' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><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></section>
|
|||
|
|
<section id='search' class="content hidden"></section>
|
|||
|
|
|
|||
|
|
<section class="footer"></section>
|
|||
|
|
|
|||
|
|
<aside id="help" class="hidden">
|
|||
|
|
<div>
|
|||
|
|
<h1 class="hidden">Help</h1>
|
|||
|
|
|
|||
|
|
<div class="shortcuts">
|
|||
|
|
<h2>Keyboard Shortcuts</h2>
|
|||
|
|
|
|||
|
|
<dl>
|
|||
|
|
<dt><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse all sections</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="infos">
|
|||
|
|
<h2>Search Tricks</h2>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Prefix searches with a type followed by a colon (e.g.
|
|||
|
|
<code>fn:</code>) to restrict the search to a given type.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Accepted types are: <code>fn</code>, <code>mod</code>,
|
|||
|
|
<code>struct</code>, <code>enum</code>,
|
|||
|
|
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
|||
|
|
and <code>const</code>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Search functions by type signature (e.g.
|
|||
|
|
<code>vec -> usize</code> or <code>* -> vec</code>)
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../../";
|
|||
|
|
window.currentCrate = "hyper";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../main.js"></script>
|
|||
|
|
<script defer src="../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|