blob: b7d6586df1b9516d64dc3b3eb9065a29b0effdad [file] [log] [blame]
<!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 request builder"><meta name="keywords" content="rust, rustlang, rust-lang, Builder"><title>Builder in http::request - 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">&#9776;</button><a class="sidebar-logo" href="../../http/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="../../http/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Builder</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.body">body</a></li><li><a href="#method.extension">extension</a></li><li><a href="#method.extensions_mut">extensions_mut</a></li><li><a href="#method.extensions_ref">extensions_ref</a></li><li><a href="#method.header">header</a></li><li><a href="#method.headers_mut">headers_mut</a></li><li><a href="#method.headers_ref">headers_ref</a></li><li><a href="#method.method">method</a></li><li><a href="#method.method_ref">method_ref</a></li><li><a href="#method.new">new</a></li><li><a href="#method.uri">uri</a></li><li><a href="#method.uri_ref">uri_ref</a></li><li><a href="#method.version">version</a></li><li><a href="#method.version_ref">version_ref</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-Builder">Debug</a></li><li><a href="#impl-Default-for-Builder">Default</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Builder">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-Builder">Send</a></li><li><a href="#impl-Sync-for-Builder">Sync</a></li><li><a href="#impl-Unpin-for-Builder">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Builder">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Builder">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Builder">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Builder">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-Builder">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-Builder">Into&lt;U&gt;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Builder">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-Builder">TryInto&lt;U&gt;</a></li></ul></section><h2><a href="index.html">In http::request</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">http</a>::<wbr><a href="index.html">request</a>::<wbr><a class="struct" href="#">Builder</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/http/request.rs.html#190-192">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Builder { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An HTTP request builder</p>
<p>This type can be used to construct an instance or <code>Request</code>
through a builder-like pattern.</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-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#744-1072">source</a><a href="#impl-Builder" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#758-760">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -&gt; <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Creates a new default instance of <code>Builder</code> to construct a <code>Request</code>.</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>req = request::Builder::new()
.method(<span class="string">&quot;POST&quot;</span>)
.body(())
.unwrap();</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.method" class="method has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#779-789">source</a><h4 class="code-header">pub fn <a href="#method.method" class="fnname">method</a>&lt;T&gt;(self, method: T) -&gt; <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="../method/struct.Method.html" title="struct http::method::Method">Method</a>: TryFrom&lt;T&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;<a class="struct" href="../method/struct.Method.html" title="struct http::method::Method">Method</a> as TryFrom&lt;T&gt;&gt;::Error: Into&lt;<a class="struct" href="../struct.Error.html" title="struct http::Error">Error</a>&gt;,</span></h4></section></summary><div class="docblock"><p>Set the HTTP method for this request.</p>
<p>This function will configure the HTTP method of the <code>Request</code> that will
be returned from <code>Builder::build</code>.</p>
<p>By default this is <code>GET</code>.</p>
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let </span>req = Request::builder()
.method(<span class="string">&quot;POST&quot;</span>)
.body(())
.unwrap();</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.method_ref" class="method has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#806-808">source</a><h4 class="code-header">pub fn <a href="#method.method_ref" class="fnname">method_ref</a>(&amp;self) -&gt; Option&lt;&amp;<a class="struct" href="../method/struct.Method.html" title="struct http::method::Method">Method</a>&gt;</h4></section></summary><div class="docblock"><p>Get the HTTP Method for this request.</p>
<p>By default this is <code>GET</code>. If builder has error, returns None.</p>
<h5 id="examples-2"><a href="#examples-2">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let </span><span class="kw-2">mut </span>req = Request::builder();
<span class="macro">assert_eq!</span>(req.method_ref(),<span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>Method::GET));
req = req.method(<span class="string">&quot;POST&quot;</span>);
<span class="macro">assert_eq!</span>(req.method_ref(),<span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>Method::POST));</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.uri" class="method has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#827-836">source</a><h4 class="code-header">pub fn <a href="#method.uri" class="fnname">uri</a>&lt;T&gt;(self, uri: T) -&gt; <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="../uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>: TryFrom&lt;T&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;<a class="struct" href="../uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a> as TryFrom&lt;T&gt;&gt;::Error: Into&lt;<a class="struct" href="../struct.Error.html" title="struct http::Error">Error</a>&gt;,</span></h4></section></summary><div class="docblock"><p>Set the URI for this request.</p>
<p>This function will configure the URI of the <code>Request</code> that will
be returned from <code>Builder::build</code>.</p>
<p>By default this is <code>/</code>.</p>
<h5 id="examples-3"><a href="#examples-3">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let </span>req = Request::builder()
.uri(<span class="string">&quot;https://www.rust-lang.org/&quot;</span>)
.body(())
.unwrap();</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.uri_ref" class="method has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#853-855">source</a><h4 class="code-header">pub fn <a href="#method.uri_ref" class="fnname">uri_ref</a>(&amp;self) -&gt; Option&lt;&amp;<a class="struct" href="../uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>&gt;</h4></section></summary><div class="docblock"><p>Get the URI for this request</p>
<p>By default this is <code>/</code>.</p>
<h5 id="examples-4"><a href="#examples-4">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let </span><span class="kw-2">mut </span>req = Request::builder();
<span class="macro">assert_eq!</span>(req.uri_ref().unwrap(), <span class="string">&quot;/&quot; </span>);
req = req.uri(<span class="string">&quot;https://www.rust-lang.org/&quot;</span>);
<span class="macro">assert_eq!</span>(req.uri_ref().unwrap(), <span class="string">&quot;https://www.rust-lang.org/&quot; </span>);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.version" class="method has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#874-879">source</a><h4 class="code-header">pub fn <a href="#method.version" class="fnname">version</a>(self, version: <a class="struct" href="../version/struct.Version.html" title="struct http::version::Version">Version</a>) -&gt; <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Set the HTTP version for this request.</p>
<p>This function will configure the HTTP version of the <code>Request</code> that
will be returned from <code>Builder::build</code>.</p>
<p>By default this is HTTP/1.1</p>
<h5 id="examples-5"><a href="#examples-5">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let </span>req = Request::builder()
.version(Version::HTTP_2)
.body(())
.unwrap();</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.version_ref" class="method has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#896-898">source</a><h4 class="code-header">pub fn <a href="#method.version_ref" class="fnname">version_ref</a>(&amp;self) -&gt; Option&lt;&amp;<a class="struct" href="../version/struct.Version.html" title="struct http::version::Version">Version</a>&gt;</h4></section></summary><div class="docblock"><p>Get the HTTP version for this request</p>
<p>By default this is HTTP/1.1.</p>
<h5 id="examples-6"><a href="#examples-6">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let </span><span class="kw-2">mut </span>req = Request::builder();
<span class="macro">assert_eq!</span>(req.version_ref().unwrap(), <span class="kw-2">&amp;</span>Version::HTTP_11 );
req = req.version(Version::HTTP_2);
<span class="macro">assert_eq!</span>(req.version_ref().unwrap(), <span class="kw-2">&amp;</span>Version::HTTP_2 );</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.header" class="method has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#918-931">source</a><h4 class="code-header">pub fn <a href="#method.header" class="fnname">header</a>&lt;K, V&gt;(self, key: K, value: V) -&gt; <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="../header/struct.HeaderName.html" title="struct http::header::HeaderName">HeaderName</a>: TryFrom&lt;K&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;<a class="struct" href="../header/struct.HeaderName.html" title="struct http::header::HeaderName">HeaderName</a> as TryFrom&lt;K&gt;&gt;::Error: Into&lt;<a class="struct" href="../struct.Error.html" title="struct http::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="../header/struct.HeaderValue.html" title="struct http::header::HeaderValue">HeaderValue</a>: TryFrom&lt;V&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;<a class="struct" href="../header/struct.HeaderValue.html" title="struct http::header::HeaderValue">HeaderValue</a> as TryFrom&lt;V&gt;&gt;::Error: Into&lt;<a class="struct" href="../struct.Error.html" title="struct http::Error">Error</a>&gt;,</span></h4></section></summary><div class="docblock"><p>Appends a header to this request builder.</p>
<p>This function will append the provided key/value as a header to the
internal <code>HeaderMap</code> being constructed. Essentially this is equivalent
to calling <code>HeaderMap::append</code>.</p>
<h5 id="examples-7"><a href="#examples-7">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let </span>req = Request::builder()
.header(<span class="string">&quot;Accept&quot;</span>, <span class="string">&quot;text/html&quot;</span>)
.header(<span class="string">&quot;X-Custom-Foo&quot;</span>, <span class="string">&quot;bar&quot;</span>)
.body(())
.unwrap();</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.headers_ref" class="method has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#947-949">source</a><h4 class="code-header">pub fn <a href="#method.headers_ref" class="fnname">headers_ref</a>(&amp;self) -&gt; Option&lt;&amp;<a class="struct" href="../header/struct.HeaderMap.html" title="struct http::header::HeaderMap">HeaderMap</a>&lt;<a class="struct" href="../header/struct.HeaderValue.html" title="struct http::header::HeaderValue">HeaderValue</a>&gt;&gt;</h4></section></summary><div class="docblock"><p>Get header on this request builder.
when builder has error returns None</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>req = Request::builder()
.header(<span class="string">&quot;Accept&quot;</span>, <span class="string">&quot;text/html&quot;</span>)
.header(<span class="string">&quot;X-Custom-Foo&quot;</span>, <span class="string">&quot;bar&quot;</span>);
<span class="kw">let </span>headers = req.headers_ref().unwrap();
<span class="macro">assert_eq!</span>( headers[<span class="string">&quot;Accept&quot;</span>], <span class="string">&quot;text/html&quot; </span>);
<span class="macro">assert_eq!</span>( headers[<span class="string">&quot;X-Custom-Foo&quot;</span>], <span class="string">&quot;bar&quot; </span>);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.headers_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#969-971">source</a><h4 class="code-header">pub fn <a href="#method.headers_mut" class="fnname">headers_mut</a>(&amp;mut self) -&gt; Option&lt;&amp;mut <a class="struct" href="../header/struct.HeaderMap.html" title="struct http::header::HeaderMap">HeaderMap</a>&lt;<a class="struct" href="../header/struct.HeaderValue.html" title="struct http::header::HeaderValue">HeaderValue</a>&gt;&gt;</h4></section></summary><div class="docblock"><p>Get headers on this request builder.</p>
<p>When builder has error returns None.</p>
<h5 id="example-1"><a href="#example-1">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>req = Request::builder();
{
<span class="kw">let </span>headers = req.headers_mut().unwrap();
headers.insert(<span class="string">&quot;Accept&quot;</span>, HeaderValue::from_static(<span class="string">&quot;text/html&quot;</span>));
headers.insert(<span class="string">&quot;X-Custom-Foo&quot;</span>, HeaderValue::from_static(<span class="string">&quot;bar&quot;</span>));
}
<span class="kw">let </span>headers = req.headers_ref().unwrap();
<span class="macro">assert_eq!</span>( headers[<span class="string">&quot;Accept&quot;</span>], <span class="string">&quot;text/html&quot; </span>);
<span class="macro">assert_eq!</span>( headers[<span class="string">&quot;X-Custom-Foo&quot;</span>], <span class="string">&quot;bar&quot; </span>);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.extension" class="method has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#988-996">source</a><h4 class="code-header">pub fn <a href="#method.extension" class="fnname">extension</a>&lt;T&gt;(self, extension: T) -&gt; <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Any + Send + Sync + 'static,</span></h4></section></summary><div class="docblock"><p>Adds an extension to this builder</p>
<h5 id="examples-8"><a href="#examples-8">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let </span>req = Request::builder()
.extension(<span class="string">&quot;My Extension&quot;</span>)
.body(())
.unwrap();
<span class="macro">assert_eq!</span>(req.extensions().get::&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str&gt;(),
<span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="string">&quot;My Extension&quot;</span>));</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.extensions_ref" class="method has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#1011-1013">source</a><h4 class="code-header">pub fn <a href="#method.extensions_ref" class="fnname">extensions_ref</a>(&amp;self) -&gt; Option&lt;&amp;<a class="struct" href="../struct.Extensions.html" title="struct http::Extensions">Extensions</a>&gt;</h4></section></summary><div class="docblock"><p>Get a reference to the extensions for this request builder.</p>
<p>If the builder has an error, this returns <code>None</code>.</p>
<h5 id="example-2"><a href="#example-2">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>req = Request::builder().extension(<span class="string">&quot;My Extension&quot;</span>).extension(<span class="number">5u32</span>);
<span class="kw">let </span>extensions = req.extensions_ref().unwrap();
<span class="macro">assert_eq!</span>(extensions.get::&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str&gt;(), <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="string">&quot;My Extension&quot;</span>));
<span class="macro">assert_eq!</span>(extensions.get::&lt;u32&gt;(), <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="number">5u32</span>));</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.extensions_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#1029-1031">source</a><h4 class="code-header">pub fn <a href="#method.extensions_mut" class="fnname">extensions_mut</a>(&amp;mut self) -&gt; Option&lt;&amp;mut <a class="struct" href="../struct.Extensions.html" title="struct http::Extensions">Extensions</a>&gt;</h4></section></summary><div class="docblock"><p>Get a mutable reference to the extensions for this request builder.</p>
<p>If the builder has an error, this returns <code>None</code>.</p>
<h5 id="example-3"><a href="#example-3">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>req = Request::builder().extension(<span class="string">&quot;My Extension&quot;</span>);
<span class="kw">let </span><span class="kw-2">mut </span>extensions = req.extensions_mut().unwrap();
<span class="macro">assert_eq!</span>(extensions.get::&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str&gt;(), <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="string">&quot;My Extension&quot;</span>));
extensions.insert(<span class="number">5u32</span>);
<span class="macro">assert_eq!</span>(extensions.get::&lt;u32&gt;(), <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="number">5u32</span>));</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.body" class="method has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#1053-1060">source</a><h4 class="code-header">pub fn <a href="#method.body" class="fnname">body</a>&lt;T&gt;(self, body: T) -&gt; <a class="type" href="../type.Result.html" title="type http::Result">Result</a>&lt;<a class="struct" href="struct.Request.html" title="struct http::request::Request">Request</a>&lt;T&gt;&gt;</h4></section></summary><div class="docblock"><p>“Consumes” this builder, using the provided <code>body</code> to return a
constructed <code>Request</code>.</p>
<h5 id="errors"><a href="#errors">Errors</a></h5>
<p>This function may return an error if any previously configured argument
failed to parse or get converted to the internal representation. For
example if an invalid <code>head</code> was specified via <code>header(&quot;Foo&quot;, &quot;Bar\r\n&quot;)</code> the error will be returned when this function is called
rather than when <code>header</code> was called.</p>
<h5 id="examples-9"><a href="#examples-9">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let </span>request = Request::builder()
.body(())
.unwrap();</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-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#189">source</a><a href="#impl-Debug-for-Builder" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</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/http/request.rs.html#189">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&amp;self, f: &amp;mut Formatter&lt;'_&gt;) -&gt; Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default-for-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#1074-1081">source</a><a href="#impl-Default-for-Builder" class="anchor"></a><h3 class="code-header">impl Default for <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/http/request.rs.html#1076-1080">source</a><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a class="fnname">default</a>() -&gt; <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a></h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a>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-Builder" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Builder" class="anchor"></a><h3 class="code-header">impl !RefUnwindSafe for <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a></h3></section><section id="impl-Send-for-Builder" class="impl has-srclink"><a href="#impl-Send-for-Builder" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a></h3></section><section id="impl-Sync-for-Builder" class="impl has-srclink"><a href="#impl-Sync-for-Builder" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a></h3></section><section id="impl-Unpin-for-Builder" class="impl has-srclink"><a href="#impl-Unpin-for-Builder" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a></h3></section><section id="impl-UnwindSafe-for-Builder" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Builder" class="anchor"></a><h3 class="code-header">impl !UnwindSafe for <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</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-Builder" class="impl has-srclink"><a href="#impl-Any-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?Sized,</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 href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&amp;self) -&gt; TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Builder" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&amp;self) -&gt; &amp;T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Builder" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Builder" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; 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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -&gt; 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-Into%3CU%3E-for-Builder" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,</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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -&gt; 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>[From]&lt;T&gt; 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-Builder" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,</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 class="associatedtype">Error</a> = Infallible</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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</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-Builder" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,</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 class="associatedtype">Error</a> = &lt;U as TryFrom&lt;T&gt;&gt;::Error</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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="http" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>