mirror of
https://github.com/actix/actix-web.git
synced 2024-06-12 10:19:36 +00:00
100 lines
45 KiB
HTML
100 lines
45 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="An HTTP Client request builder"><title>ClientRequest in actix_test - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="actix_test" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (bdbbb6c6a 2024-05-26)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc struct"><!--[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" title="show sidebar"></button><a class="logo-container" href="../actix_test/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../actix_test/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../actix_test/index.html">actix_test</a><span class="version">0.1.3</span></h2></div><h2 class="location"><a href="#">ClientRequest</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.address">address</a></li><li><a href="#method.append_header">append_header</a></li><li><a href="#method.basic_auth">basic_auth</a></li><li><a href="#method.bearer_auth">bearer_auth</a></li><li><a href="#method.camel_case">camel_case</a></li><li><a href="#method.content_length">content_length</a></li><li><a href="#method.content_type">content_type</a></li><li><a href="#method.cookie">cookie</a></li><li><a href="#method.force_close">force_close</a></li><li><a href="#method.freeze">freeze</a></li><li><a href="#method.get_method">get_method</a></li><li><a href="#method.get_peer_addr">get_peer_addr</a></li><li><a href="#method.get_uri">get_uri</a></li><li><a href="#method.get_version">get_version</a></li><li><a href="#method.headers">headers</a></li><li><a href="#method.headers_mut">headers_mut</a></li><li><a href="#method.insert_header">insert_header</a></li><li><a href="#method.insert_header_if_none">insert_header_if_none</a></li><li><a href="#method.method">method</a></li><li><a href="#method.no_decompress">no_decompress</a></li><li><a href="#method.query">query</a></li><li><a href="#method.send">send</a></li><li><a href="#method.send_body">send_body</a></li><li><a href="#method.send_form">send_form</a></li><li><a href="#method.send_json">send_json</a></li><li><a href="#method.send_stream">send_stream</a></li><li><a href="#method.timeout">timeout</a></li><li><a href="#method.uri">uri</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-ClientRequest">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-ClientRequest">!Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-ClientRequest">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-ClientRequest">!Send</a></li><li><a href="#impl-Sync-for-ClientRequest">!Sync</a></li><li><a href="#impl-UnwindSafe-for-ClientRequest">!UnwindSafe</a></li><li><a href="#impl-Unpin-for-ClientRequest">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T">From<T></a></li><li><a href="#impl-Instrument-for-T">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-T">Into<U></a></li><li><a href="#impl-Same-for-T">Same</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto<U></a></li><li><a href="#impl-VZip%3CV%3E-for-T">VZip<V></a></li><li><a href="#impl-WithSubscriber-for-T">WithSubscriber</a></li></ul></section><h2><a href="index.html">In crate actix_test</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="index.html">actix_test</a>::<wbr><a class="struct" href="#">ClientRequest</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct ClientRequest { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An HTTP Client request builder</p>
|
||
<p>This type can be used to construct an instance of <code>ClientRequest</code> through a
|
||
builder-like pattern.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>response = awc::Client::new()
|
||
.get(<span class="string">"http://www.rust-lang.org"</span>) <span class="comment">// <- Create request builder
|
||
</span>.insert_header((<span class="string">"User-Agent"</span>, <span class="string">"Actix-web"</span>))
|
||
.send() <span class="comment">// <- Send HTTP request
|
||
</span>.<span class="kw">await</span>;
|
||
|
||
response.and_then(|response| { <span class="comment">// <- server HTTP response
|
||
</span><span class="macro">println!</span>(<span class="string">"Response: {:?}"</span>, response);
|
||
<span class="prelude-val">Ok</span>(())
|
||
});</code></pre></div>
|
||
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-ClientRequest" class="impl"><a href="#impl-ClientRequest" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.uri" class="method"><h4 class="code-header">pub fn <a href="#method.uri" class="fn">uri</a><U>(self, uri: U) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a><div class="where">where
|
||
<a class="struct" href="https://docs.rs/http/0.2.11/http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>,
|
||
<<a class="struct" href="https://docs.rs/http/0.2.11/http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://docs.rs/http/0.2.11/http/error/struct.Error.html" title="struct http::error::Error">Error</a>>,</div></h4></section></summary><div class="docblock"><p>Set HTTP URI of request.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_uri" class="method"><h4 class="code-header">pub fn <a href="#method.get_uri" class="fn">get_uri</a>(&self) -> &<a class="struct" href="https://docs.rs/http/0.2.11/http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a></h4></section></summary><div class="docblock"><p>Get HTTP URI of request.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.address" class="method"><h4 class="code-header">pub fn <a href="#method.address" class="fn">address</a>(self, addr: <a class="enum" href="https://doc.rust-lang.org/nightly/core/net/socket_addr/enum.SocketAddr.html" title="enum core::net::socket_addr::SocketAddr">SocketAddr</a>) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h4></section></summary><div class="docblock"><p>Set socket address of the server.</p>
|
||
<p>This address is used for connection. If address is not
|
||
provided url’s host name get resolved.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.method" class="method"><h4 class="code-header">pub fn <a href="#method.method" class="fn">method</a>(self, method: <a class="struct" href="https://docs.rs/http/0.2.11/http/method/struct.Method.html" title="struct http::method::Method">Method</a>) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h4></section></summary><div class="docblock"><p>Set HTTP method of this request.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_method" class="method"><h4 class="code-header">pub fn <a href="#method.get_method" class="fn">get_method</a>(&self) -> &<a class="struct" href="https://docs.rs/http/0.2.11/http/method/struct.Method.html" title="struct http::method::Method">Method</a></h4></section></summary><div class="docblock"><p>Get HTTP method of this request</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_version" class="method"><h4 class="code-header">pub fn <a href="#method.get_version" class="fn">get_version</a>(&self) -> &<a class="struct" href="https://docs.rs/http/0.2.11/http/version/struct.Version.html" title="struct http::version::Version">Version</a></h4></section></summary><div class="docblock"><p>Get HTTP version of this request.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_peer_addr" class="method"><h4 class="code-header">pub fn <a href="#method.get_peer_addr" class="fn">get_peer_addr</a>(&self) -> &<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/net/socket_addr/enum.SocketAddr.html" title="enum core::net::socket_addr::SocketAddr">SocketAddr</a>></h4></section></summary><div class="docblock"><p>Get peer address of this request.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.headers" class="method"><h4 class="code-header">pub fn <a href="#method.headers" class="fn">headers</a>(&self) -> &HeaderMap</h4></section></summary><div class="docblock"><p>Returns request’s headers.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.headers_mut" class="method"><h4 class="code-header">pub fn <a href="#method.headers_mut" class="fn">headers_mut</a>(&mut self) -> &mut HeaderMap</h4></section></summary><div class="docblock"><p>Returns request’s mutable headers.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert_header" class="method"><h4 class="code-header">pub fn <a href="#method.insert_header" class="fn">insert_header</a>(self, header: impl TryIntoHeaderPair) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h4></section></summary><div class="docblock"><p>Insert a header, replacing any that were set with an equivalent field name.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert_header_if_none" class="method"><h4 class="code-header">pub fn <a href="#method.insert_header_if_none" class="fn">insert_header_if_none</a>(
|
||
self,
|
||
header: impl TryIntoHeaderPair
|
||
) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h4></section></summary><div class="docblock"><p>Insert a header only if it is not yet set.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.append_header" class="method"><h4 class="code-header">pub fn <a href="#method.append_header" class="fn">append_header</a>(self, header: impl TryIntoHeaderPair) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h4></section></summary><div class="docblock"><p>Append a header, keeping any that were set with an equivalent field name.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>awc::{http::header, Client};
|
||
|
||
Client::new()
|
||
.get(<span class="string">"http://www.rust-lang.org"</span>)
|
||
.insert_header((<span class="string">"X-TEST"</span>, <span class="string">"value"</span>))
|
||
.insert_header((header::CONTENT_TYPE, mime::APPLICATION_JSON));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.camel_case" class="method"><h4 class="code-header">pub fn <a href="#method.camel_case" class="fn">camel_case</a>(self) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h4></section></summary><div class="docblock"><p>Send headers in <code>Camel-Case</code> form.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.force_close" class="method"><h4 class="code-header">pub fn <a href="#method.force_close" class="fn">force_close</a>(self) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h4></section></summary><div class="docblock"><p>Force close connection instead of returning it back to connections pool.
|
||
This setting affect only HTTP/1 connections.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.content_type" class="method"><h4 class="code-header">pub fn <a href="#method.content_type" class="fn">content_type</a><V>(self, value: V) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a><div class="where">where
|
||
<a class="struct" href="https://docs.rs/http/0.2.11/http/header/value/struct.HeaderValue.html" title="struct http::header::value::HeaderValue">HeaderValue</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><V>,
|
||
<<a class="struct" href="https://docs.rs/http/0.2.11/http/header/value/struct.HeaderValue.html" title="struct http::header::value::HeaderValue">HeaderValue</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><V>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://docs.rs/http/0.2.11/http/error/struct.Error.html" title="struct http::error::Error">Error</a>>,</div></h4></section></summary><div class="docblock"><p>Set request’s content type</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.content_length" class="method"><h4 class="code-header">pub fn <a href="#method.content_length" class="fn">content_length</a>(self, len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h4></section></summary><div class="docblock"><p>Set content length</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.basic_auth" class="method"><h4 class="code-header">pub fn <a href="#method.basic_auth" class="fn">basic_auth</a>(
|
||
self,
|
||
username: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>,
|
||
password: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>
|
||
) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h4></section></summary><div class="docblock"><p>Set HTTP basic authorization header.</p>
|
||
<p>If no password is needed, just provide an empty string.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.bearer_auth" class="method"><h4 class="code-header">pub fn <a href="#method.bearer_auth" class="fn">bearer_auth</a>(self, token: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h4></section></summary><div class="docblock"><p>Set HTTP bearer authentication header</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.cookie" class="method"><h4 class="code-header">pub fn <a href="#method.cookie" class="fn">cookie</a>(self, cookie: <a class="struct" href="https://docs.rs/cookie/0.16/cookie/struct.Cookie.html" title="struct cookie::Cookie">Cookie</a><'_>) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h4></section><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>cookies</code></strong> only.</div></span></summary><div class="docblock"><p>Set a cookie</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>awc::{cookie::Cookie, Client};
|
||
|
||
<span class="kw">let </span>res = Client::new().get(<span class="string">"https://httpbin.org/cookies"</span>)
|
||
.cookie(Cookie::new(<span class="string">"name"</span>, <span class="string">"value"</span>))
|
||
.send()
|
||
.<span class="kw">await</span>;
|
||
|
||
<span class="macro">println!</span>(<span class="string">"Response: {:?}"</span>, res);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.no_decompress" class="method"><h4 class="code-header">pub fn <a href="#method.no_decompress" class="fn">no_decompress</a>(self) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h4></section></summary><div class="docblock"><p>Disable automatic decompress of response’s body</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.timeout" class="method"><h4 class="code-header">pub fn <a href="#method.timeout" class="fn">timeout</a>(self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -> <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h4></section></summary><div class="docblock"><p>Set request timeout. Overrides client wide timeout setting.</p>
|
||
<p>Request timeout is the total time before a response must be received.
|
||
Default value is 5 seconds.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.query" class="method"><h4 class="code-header">pub fn <a href="#method.query" class="fn">query</a><T>(self, query: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&T</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a>, Error><div class="where">where
|
||
T: <a class="trait" href="https://docs.rs/serde/1.0.203/serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>,</div></h4></section></summary><div class="docblock"><p>Sets the query part of the request</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.freeze" class="method"><h4 class="code-header">pub fn <a href="#method.freeze" class="fn">freeze</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><FrozenClientRequest, FreezeRequestError></h4></section></summary><div class="docblock"><p>Freeze request builder and construct <code>FrozenClientRequest</code>,
|
||
which could be used for sending same request multiple times.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.send_body" class="method"><h4 class="code-header">pub fn <a href="#method.send_body" class="fn">send_body</a><B>(self, body: B) -> SendClientRequest<div class="where">where
|
||
B: MessageBody + 'static,</div></h4></section></summary><div class="docblock"><p>Complete request construction and send body.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.send_json" class="method"><h4 class="code-header">pub fn <a href="#method.send_json" class="fn">send_json</a><T>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&T</a>) -> SendClientRequest<div class="where">where
|
||
T: <a class="trait" href="https://docs.rs/serde/1.0.203/serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>,</div></h4></section></summary><div class="docblock"><p>Set a JSON body and generate <code>ClientRequest</code></p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.send_form" class="method"><h4 class="code-header">pub fn <a href="#method.send_form" class="fn">send_form</a><T>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&T</a>) -> SendClientRequest<div class="where">where
|
||
T: <a class="trait" href="https://docs.rs/serde/1.0.203/serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>,</div></h4></section></summary><div class="docblock"><p>Set a urlencoded body and generate <code>ClientRequest</code></p>
|
||
<p><code>ClientRequestBuilder</code> can not be used after this call.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.send_stream" class="method"><h4 class="code-header">pub fn <a href="#method.send_stream" class="fn">send_stream</a><S, E>(self, stream: S) -> SendClientRequest<div class="where">where
|
||
S: Stream<Item = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Bytes, E>> + 'static,
|
||
E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/error/trait.Error.html" title="trait core::error::Error">Error</a>>> + 'static,</div></h4></section></summary><div class="docblock"><p>Set an streaming body and generate <code>ClientRequest</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.send" class="method"><h4 class="code-header">pub fn <a href="#method.send" class="fn">send</a>(self) -> SendClientRequest</h4></section></summary><div class="docblock"><p>Set an empty body and generate <code>ClientRequest</code>.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-ClientRequest" class="impl"><a href="#impl-Debug-for-ClientRequest" class="anchor">§</a><h3 class="code-header">impl <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="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></h4></section></summary><div class='docblock'>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></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-ClientRequest" class="impl"><a href="#impl-Freeze-for-ClientRequest" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h3></section><section id="impl-RefUnwindSafe-for-ClientRequest" class="impl"><a href="#impl-RefUnwindSafe-for-ClientRequest" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h3></section><section id="impl-Send-for-ClientRequest" class="impl"><a href="#impl-Send-for-ClientRequest" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h3></section><section id="impl-Sync-for-ClientRequest" class="impl"><a href="#impl-Sync-for-ClientRequest" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h3></section><section id="impl-Unpin-for-ClientRequest" class="impl"><a href="#impl-Unpin-for-ClientRequest" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h3></section><section id="impl-UnwindSafe-for-ClientRequest" class="impl"><a href="#impl-UnwindSafe-for-ClientRequest" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.ClientRequest.html" title="struct actix_test::ClientRequest">ClientRequest</a></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Instrument-for-T" class="impl"><a href="#impl-Instrument-for-T" class="anchor">§</a><h3 class="code-header">impl<T> Instrument for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl"><a href="#method.instrument" class="anchor">§</a><h4 class="code-header">fn <a class="fn">instrument</a>(self, span: Span) -> Instrumented<Self></h4></section></summary><div class='docblock'>Instruments this type with the provided [<code>Span</code>], returning an
|
||
<code>Instrumented</code> wrapper. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl"><a href="#method.in_current_span" class="anchor">§</a><h4 class="code-header">fn <a class="fn">in_current_span</a>(self) -> Instrumented<Self></h4></section></summary><div class='docblock'>Instruments this type with the <a href="super::Span::current()">current</a> <a href="crate::Span"><code>Span</code></a>, returning an
|
||
<code>Instrumented</code> wrapper. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Same-for-T" class="impl"><a class="src rightside" href="https://docs.rs/typenum/1.17.0/src/typenum/type_operators.rs.html#34">source</a><a href="#impl-Same-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://docs.rs/typenum/1.17.0/typenum/type_operators/trait.Same.html" title="trait typenum::type_operators::Same">Same</a> for T</h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl"><a href="#associatedtype.Output" class="anchor">§</a><h4 class="code-header">type <a href="https://docs.rs/typenum/1.17.0/typenum/type_operators/trait.Same.html#associatedtype.Output" class="associatedtype">Output</a> = T</h4></section></summary><div class='docblock'>Should always be <code>Self</code></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-T" class="impl"><a href="#impl-VZip%3CV%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<V, T> VZip<V> for T<div class="where">where
|
||
V: MultiLane<T>,</div></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl"><a href="#method.vzip" class="anchor">§</a><h4 class="code-header">fn <a class="fn">vzip</a>(self) -> V</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-WithSubscriber-for-T" class="impl"><a href="#impl-WithSubscriber-for-T" class="anchor">§</a><h3 class="code-header">impl<T> WithSubscriber for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.with_subscriber" class="method trait-impl"><a href="#method.with_subscriber" class="anchor">§</a><h4 class="code-header">fn <a class="fn">with_subscriber</a><S>(self, subscriber: S) -> WithDispatch<Self><div class="where">where
|
||
S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><Dispatch>,</div></h4></section></summary><div class='docblock'>Attaches the provided <a href="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
|
||
[<code>WithDispatch</code>] wrapper. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl"><a href="#method.with_current_subscriber" class="anchor">§</a><h4 class="code-header">fn <a class="fn">with_current_subscriber</a>(self) -> WithDispatch<Self></h4></section></summary><div class='docblock'>Attaches the current <a href="crate::dispatcher#setting-the-default-subscriber">default</a> <a href="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
|
||
[<code>WithDispatch</code>] wrapper. <a>Read more</a></div></details></div></details></div></section></div></main></body></html> |