| <!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="A builder to construct the properties of a `Request`."><meta name="keywords" content="rust, rustlang, rust-lang, RequestBuilder"><title>RequestBuilder in reqwest - 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="sidebar-items.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 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">☰</button><a class="sidebar-logo" href="../reqwest/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="../reqwest/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">RequestBuilder</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.basic_auth">basic_auth</a></li><li><a href="#method.bearer_auth">bearer_auth</a></li><li><a href="#method.body">body</a></li><li><a href="#method.build">build</a></li><li><a href="#method.build_split">build_split</a></li><li><a href="#method.fetch_mode_no_cors">fetch_mode_no_cors</a></li><li><a href="#method.form">form</a></li><li><a href="#method.from_parts">from_parts</a></li><li><a href="#method.header">header</a></li><li><a href="#method.headers">headers</a></li><li><a href="#method.json">json</a></li><li><a href="#method.query">query</a></li><li><a href="#method.send">send</a></li><li><a href="#method.timeout">timeout</a></li><li><a href="#method.try_clone">try_clone</a></li><li><a href="#method.version">version</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-RequestBuilder">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-RequestBuilder">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-RequestBuilder">Send</a></li><li><a href="#impl-Sync-for-RequestBuilder">Sync</a></li><li><a href="#impl-Unpin-for-RequestBuilder">Unpin</a></li><li><a href="#impl-UnwindSafe-for-RequestBuilder">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-RequestBuilder">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-RequestBuilder">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-RequestBuilder">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-RequestBuilder">From<T></a></li><li><a href="#impl-Instrument-for-RequestBuilder">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-RequestBuilder">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-RequestBuilder">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-RequestBuilder">TryInto<U></a></li><li><a href="#impl-WithSubscriber-for-RequestBuilder">WithSubscriber</a></li></ul></section><h2><a href="index.html">In reqwest</a></h2></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">Struct <a href="index.html">reqwest</a>::<wbr><a class="struct" href="#">RequestBuilder</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/reqwest/async_impl/request.rs.html#35-38">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct RequestBuilder { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A builder to construct the properties of a <code>Request</code>.</p> |
| <p>To construct a <code>RequestBuilder</code>, refer to the <code>Client</code> documentation.</p> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-RequestBuilder" class="impl has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#163-543">source</a><a href="#impl-RequestBuilder" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_parts" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#181-186">source</a><h4 class="code-header">pub fn <a href="#method.from_parts" class="fnname">from_parts</a>(client: <a class="struct" href="struct.Client.html" title="struct reqwest::Client">Client</a>, request: <a class="struct" href="struct.Request.html" title="struct reqwest::Request">Request</a>) -> <a class="struct" href="struct.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h4></section></summary><div class="docblock"><p>Assemble a builder starting from an existing <code>Client</code> and a <code>Request</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.header" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#189-197">source</a><h4 class="code-header">pub fn <a href="#method.header" class="fnname">header</a><K, V>(self, key: K, value: V) -> <a class="struct" href="struct.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a><span class="where fmt-newline">where<br> <a class="struct" href="header/struct.HeaderName.html" title="struct reqwest::header::HeaderName">HeaderName</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><K>,<br> <<a class="struct" href="header/struct.HeaderName.html" title="struct reqwest::header::HeaderName">HeaderName</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><K>>::<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="../http/error/struct.Error.html" title="struct http::error::Error">Error</a>>,<br> <a class="struct" href="header/struct.HeaderValue.html" title="struct reqwest::header::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>,<br> <<a class="struct" href="header/struct.HeaderValue.html" title="struct reqwest::header::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="../http/error/struct.Error.html" title="struct http::error::Error">Error</a>>,</span></h4></section></summary><div class="docblock"><p>Add a <code>Header</code> to this Request.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.headers" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#234-239">source</a><h4 class="code-header">pub fn <a href="#method.headers" class="fnname">headers</a>(self, headers: <a class="struct" href="header/struct.HeaderMap.html" title="struct reqwest::header::HeaderMap">HeaderMap</a>) -> <a class="struct" href="struct.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h4></section></summary><div class="docblock"><p>Add a set of Headers to the existing ones on this Request.</p> |
| <p>The headers will be merged in to any already set.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.basic_auth" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#255-262">source</a><h4 class="code-header">pub fn <a href="#method.basic_auth" class="fnname">basic_auth</a><U, P>(self, username: U, password: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><P>) -> <a class="struct" href="struct.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a><span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>,<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>,</span></h4></section></summary><div class="docblock"><p>Enable HTTP basic authentication.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code> |
| <span class="kw">let </span>client = reqwest::Client::new(); |
| <span class="kw">let </span>resp = client.delete(<span class="string">"http://httpbin.org/delete"</span>) |
| .basic_auth(<span class="string">"admin"</span>, <span class="prelude-val">Some</span>(<span class="string">"good password"</span>)) |
| .send() |
| .<span class="kw">await</span><span class="question-mark">?</span>;</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.bearer_auth" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#265-271">source</a><h4 class="code-header">pub fn <a href="#method.bearer_auth" class="fnname">bearer_auth</a><T>(self, token: T) -> <a class="struct" href="struct.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a><span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>,</span></h4></section></summary><div class="docblock"><p>Enable HTTP bearer authentication.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.body" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#274-279">source</a><h4 class="code-header">pub fn <a href="#method.body" class="fnname">body</a><T: <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="struct.Body.html" title="struct reqwest::Body">Body</a>>>(self, body: T) -> <a class="struct" href="struct.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h4></section></summary><div class="docblock"><p>Set the request body.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.timeout" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#286-291">source</a><h4 class="code-header">pub fn <a href="#method.timeout" class="fnname">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.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h4></section></summary><div class="docblock"><p>Enables a request timeout.</p> |
| <p>The timeout is applied from when the request starts connecting until the |
| response body has finished. It affects only this request and overrides |
| the timeout configured using <code>ClientBuilder::timeout()</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.query" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#349-369">source</a><h4 class="code-header">pub fn <a href="#method.query" class="fnname">query</a><T: <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(self, query: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="struct" href="struct.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h4></section></summary><div class="docblock"><p>Modify the query string of the URL.</p> |
| <p>Modifies the URL of this request, adding the parameters provided. |
| This method appends and does not overwrite. This means that it can |
| be called multiple times and that existing query parameters are not |
| overwritten if the same key is used. The key will simply show up |
| twice in the query string. |
| Calling <code>.query(&[("foo", "a"), ("foo", "b")])</code> gives <code>"foo=a&foo=b"</code>.</p> |
| <h5 id="note"><a href="#note">Note</a></h5> |
| <p>This method does not support serializing a single key-value |
| pair. Instead of using <code>.query(("key", "val"))</code>, use a sequence, such |
| as <code>.query(&[("key", "val")])</code>. It’s also possible to serialize structs |
| and maps into a key-value pair.</p> |
| <h5 id="errors"><a href="#errors">Errors</a></h5> |
| <p>This method will fail if the object you provide cannot be serialized |
| into a query string.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.version" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#372-377">source</a><h4 class="code-header">pub fn <a href="#method.version" class="fnname">version</a>(self, version: <a class="struct" href="struct.Version.html" title="struct reqwest::Version">Version</a>) -> <a class="struct" href="struct.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h4></section></summary><div class="docblock"><p>Set HTTP version</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.form" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#406-424">source</a><h4 class="code-header">pub fn <a href="#method.form" class="fnname">form</a><T: <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(self, form: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="struct" href="struct.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h4></section></summary><div class="docblock"><p>Send a form body.</p> |
| <p>Sets the body to the url encoded serialization of the passed value, |
| and also sets the <code>Content-Type: application/x-www-form-urlencoded</code> |
| header.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>params = HashMap::new(); |
| params.insert(<span class="string">"lang"</span>, <span class="string">"rust"</span>); |
| |
| <span class="kw">let </span>client = reqwest::Client::new(); |
| <span class="kw">let </span>res = client.post(<span class="string">"http://httpbin.org"</span>) |
| .form(<span class="kw-2">&</span>params) |
| .send() |
| .<span class="kw">await</span><span class="question-mark">?</span>;</code></pre></div> |
| <h5 id="errors-1"><a href="#errors-1">Errors</a></h5> |
| <p>This method fails if the passed value cannot be serialized into |
| url encoded format</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.json" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#438-456">source</a><h4 class="code-header">pub fn <a href="#method.json" class="fnname">json</a><T: <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(self, json: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="struct" href="struct.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h4></section></summary><div class="docblock"><p>Send a JSON body.</p> |
| <h5 id="optional"><a href="#optional">Optional</a></h5> |
| <p>This requires the optional <code>json</code> feature enabled.</p> |
| <h5 id="errors-2"><a href="#errors-2">Errors</a></h5> |
| <p>Serialization can fail if <code>T</code>’s implementation of <code>Serialize</code> decides to |
| fail, or if <code>T</code> contains a map with non-string keys.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fetch_mode_no_cors" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#467-469">source</a><h4 class="code-header">pub fn <a href="#method.fetch_mode_no_cors" class="fnname">fetch_mode_no_cors</a>(self) -> <a class="struct" href="struct.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h4></section></summary><div class="docblock"><p>Disable CORS on fetching the request.</p> |
| <h5 id="wasm"><a href="#wasm">WASM</a></h5> |
| <p>This option is only effective with WebAssembly target.</p> |
| <p>The <a href="https://developer.mozilla.org/en-US/docs/Web/API/Request/mode">request mode</a> will be set to ‘no-cors’.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.build" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#473-475">source</a><h4 class="code-header">pub fn <a href="#method.build" class="fnname">build</a>(self) -> <a class="type" href="type.Result.html" title="type reqwest::Result">Result</a><<a class="struct" href="struct.Request.html" title="struct reqwest::Request">Request</a>></h4></section></summary><div class="docblock"><p>Build a <code>Request</code>, which can be inspected, modified and executed with |
| <code>Client::execute()</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.build_split" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#482-484">source</a><h4 class="code-header">pub fn <a href="#method.build_split" class="fnname">build_split</a>(self) -> (<a class="struct" href="struct.Client.html" title="struct reqwest::Client">Client</a>, <a class="type" href="type.Result.html" title="type reqwest::Result">Result</a><<a class="struct" href="struct.Request.html" title="struct reqwest::Request">Request</a>>)</h4></section></summary><div class="docblock"><p>Build a <code>Request</code>, which can be inspected, modified and executed with |
| <code>Client::execute()</code>.</p> |
| <p>This is similar to <a href="struct.RequestBuilder.html#method.build" title="RequestBuilder::build()"><code>RequestBuilder::build()</code></a>, but also returns the |
| embedded <code>Client</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.send" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#507-512">source</a><h4 class="code-header">pub fn <a href="#method.send" class="fnname">send</a>(self) -> impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <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.Response.html" title="struct reqwest::Response">Response</a>, <a class="struct" href="struct.Error.html" title="struct reqwest::Error">Error</a>>></h4></section></summary><div class="docblock"><p>Constructs the Request and sends it to the target URL, returning a |
| future Response.</p> |
| <h5 id="errors-3"><a href="#errors-3">Errors</a></h5> |
| <p>This method fails if there was an error while sending request, |
| redirect loop was detected or redirect limit was exhausted.</p> |
| <h5 id="example"><a href="#example">Example</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>response = reqwest::Client::new() |
| .get(<span class="string">"https://hyper.rs"</span>) |
| .send() |
| .<span class="kw">await</span><span class="question-mark">?</span>;</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_clone" class="method has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#533-542">source</a><h4 class="code-header">pub fn <a href="#method.try_clone" class="fnname">try_clone</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="struct" href="struct.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a>></h4></section></summary><div class="docblock"><p>Attempt to clone the RequestBuilder.</p> |
| <p><code>None</code> is returned if the RequestBuilder can not be cloned, |
| i.e. if the request body is a stream.</p> |
| <h5 id="examples"><a href="#examples">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>client = reqwest::Client::new(); |
| <span class="kw">let </span>builder = client.post(<span class="string">"http://httpbin.org/post"</span>) |
| .body(<span class="string">"from a &str!"</span>); |
| <span class="kw">let </span>clone = builder.try_clone(); |
| <span class="macro">assert!</span>(clone.is_some());</code></pre></div> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-RequestBuilder" class="impl has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#551-559">source</a><a href="#impl-Debug-for-RequestBuilder" 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.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/reqwest/async_impl/request.rs.html#552-558">source</a><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="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></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="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-RequestBuilder" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-RequestBuilder" 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.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h3></section><section id="impl-Send-for-RequestBuilder" class="impl has-srclink"><a href="#impl-Send-for-RequestBuilder" 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.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h3></section><section id="impl-Sync-for-RequestBuilder" class="impl has-srclink"><a href="#impl-Sync-for-RequestBuilder" 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.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h3></section><section id="impl-Unpin-for-RequestBuilder" class="impl has-srclink"><a href="#impl-Unpin-for-RequestBuilder" 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.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h3></section><section id="impl-UnwindSafe-for-RequestBuilder" class="impl has-srclink"><a href="#impl-UnwindSafe-for-RequestBuilder" 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.RequestBuilder.html" title="struct reqwest::RequestBuilder">RequestBuilder</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-RequestBuilder" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#200">source</a><a href="#impl-Any-for-RequestBuilder" 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<span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#201">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="fnname">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="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-RequestBuilder" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211">source</a><a href="#impl-Borrow%3CT%3E-for-RequestBuilder" 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<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213">source</a></span><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="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</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="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-RequestBuilder" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220">source</a><a href="#impl-BorrowMut%3CT%3E-for-RequestBuilder" 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<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221">source</a></span><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="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</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="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-RequestBuilder" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#733">source</a><a href="#impl-From%3CT%3E-for-RequestBuilder" 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="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#736">source</a></span><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="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Instrument-for-RequestBuilder" class="impl has-srclink"><a class="srclink rightside" href="../src/tracing/instrument.rs.html#276">source</a><a href="#impl-Instrument-for-RequestBuilder" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/tracing/instrument.rs.html#82">source</a><a href="#method.instrument" class="anchor"></a><h4 class="code-header">fn <a href="../tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><div class='docblock'>Instruments this type with the provided <a href="../tracing/span/struct.Span.html" title="Span"><code>Span</code></a>, returning an |
| <code>Instrumented</code> wrapper. <a href="../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/tracing/instrument.rs.html#121">source</a><a href="#method.in_current_span" class="anchor"></a><h4 class="code-header">fn <a href="../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><div class='docblock'>Instruments this type with the <a href="../tracing/span/struct.Span.html#method.current">current</a> <a href="../tracing/span/struct.Span.html"><code>Span</code></a>, returning an |
| <code>Instrumented</code> wrapper. <a href="../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-RequestBuilder" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-RequestBuilder" 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<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#725">source</a></span><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="fnname">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="From">From</a><T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-RequestBuilder" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-RequestBuilder" 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<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><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="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#781">source</a></span><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="fnname">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="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-RequestBuilder" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#760">source</a><a href="#impl-TryInto%3CU%3E-for-RequestBuilder" 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<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><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="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a></span><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="fnname">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="rustdoc-toggle implementors-toggle"><summary><section id="impl-WithSubscriber-for-RequestBuilder" class="impl has-srclink"><a class="srclink rightside" href="../src/tracing/instrument.rs.html#334">source</a><a href="#impl-WithSubscriber-for-RequestBuilder" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../tracing/instrument/trait.WithSubscriber.html" title="trait tracing::instrument::WithSubscriber">WithSubscriber</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_subscriber" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/tracing/instrument.rs.html#169-171">source</a><a href="#method.with_subscriber" class="anchor"></a><h4 class="code-header">fn <a href="../tracing/instrument/trait.WithSubscriber.html#method.with_subscriber" class="fnname">with_subscriber</a><S>(self, subscriber: S) -> <a class="struct" href="../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self><span class="where fmt-newline">where<br> S: <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="../tracing_core/dispatcher/struct.Dispatch.html" title="struct tracing_core::dispatcher::Dispatch">Dispatch</a>>,</span></h4></section></summary><div class='docblock'>Attaches the provided <a href="../tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a |
| <a href="../tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="../tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/tracing/instrument.rs.html#221">source</a><a href="#method.with_current_subscriber" class="anchor"></a><h4 class="code-header">fn <a href="../tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber" class="fnname">with_current_subscriber</a>(self) -> <a class="struct" href="../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><div class='docblock'>Attaches the current <a href="../tracing/dispatcher/index.html#setting-the-default-subscriber">default</a> <a href="../tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a |
| <a href="../tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="../tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber">Read more</a></div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="reqwest" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
