mirror of
https://github.com/actix/actix-website
synced 2024-12-01 03:24:36 +01:00
161 lines
13 KiB
HTML
161 lines
13 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 `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, client"><title>actix_web::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="../../light.css" id="themeStyle"><script src="../../storage.js"></script></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><p class='location'>Module client</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>actix_web</a></p><script>window.sidebarCurrent = {name: 'client', ty: 'mod', 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"><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'>actix_web</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/actix_web/client/mod.rs.html#1-118' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Http client api</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">actix</span>, <span class="ident">client</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="ident">actix</span>::<span class="ident">run</span>(
|
||
<span class="op">||</span> <span class="ident">client</span>::<span class="ident">get</span>(<span class="string">"http://www.rust-lang.org"</span>) <span class="comment">// <- Create request builder</span>
|
||
.<span class="ident">header</span>(<span class="string">"User-Agent"</span>, <span class="string">"Actix-web"</span>)
|
||
.<span class="ident">finish</span>().<span class="ident">unwrap</span>()
|
||
.<span class="ident">send</span>() <span class="comment">// <- Send http request</span>
|
||
.<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> ())
|
||
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">response</span><span class="op">|</span> { <span class="comment">// <- server http response</span>
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Response: {:?}"</span>, <span class="ident">response</span>);
|
||
<span class="prelude-val">Ok</span>(())
|
||
})
|
||
);
|
||
}</pre>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.ClientConnector.html"
|
||
title='struct actix_web::client::ClientConnector'>ClientConnector</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>ClientConnector</code> type is responsible for transport layer of a
|
||
client connection.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.ClientConnectorStats.html"
|
||
title='struct actix_web::client::ClientConnectorStats'>ClientConnectorStats</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Client connector usage stats</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.ClientRequest.html"
|
||
title='struct actix_web::client::ClientRequest'>ClientRequest</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An HTTP Client Request</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.ClientRequestBuilder.html"
|
||
title='struct actix_web::client::ClientRequestBuilder'>ClientRequestBuilder</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An HTTP Client request builder</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.ClientResponse.html"
|
||
title='struct actix_web::client::ClientResponse'>ClientResponse</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An HTTP Client response</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Connect.html"
|
||
title='struct actix_web::client::Connect'>Connect</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>Connect</code> type represents a message that can be sent to
|
||
<code>ClientConnector</code> with a connection request.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Connection.html"
|
||
title='struct actix_web::client::Connection'>Connection</a></td>
|
||
<td class='docblock-short'>
|
||
<p>HTTP client connection</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Pause.html"
|
||
title='struct actix_web::client::Pause'>Pause</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Pause connection process for <code>ClientConnector</code></p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Resume.html"
|
||
title='struct actix_web::client::Resume'>Resume</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Resume connection process for <code>ClientConnector</code></p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.SendRequest.html"
|
||
title='struct actix_web::client::SendRequest'>SendRequest</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>SendRequest</code> is a <code>Future</code> which represents an asynchronous
|
||
request sending process.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.ClientConnectorError.html"
|
||
title='enum actix_web::client::ClientConnectorError'>ClientConnectorError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A set of errors that can occur while connecting to an HTTP host</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.SendRequestError.html"
|
||
title='enum actix_web::client::SendRequestError'>SendRequestError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A set of errors that can occur during request sending and response reading</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.delete.html"
|
||
title='fn actix_web::client::delete'>delete</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Create request builder for <code>DELETE</code> requests</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.get.html"
|
||
title='fn actix_web::client::get'>get</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Create request builder for <code>GET</code> requests</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.head.html"
|
||
title='fn actix_web::client::head'>head</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Create request builder for <code>HEAD</code> requests</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.post.html"
|
||
title='fn actix_web::client::post'>post</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Create request builder for <code>POST</code> requests</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.put.html"
|
||
title='fn actix_web::client::put'>put</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Create request builder for <code>PUT</code> requests</p>
|
||
|
||
</td>
|
||
</tr></table></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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "actix_web";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |