mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
157 lines
44 KiB
HTML
157 lines
44 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 request builder"><title>Builder in http::request - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="http" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../http/index.html">http</a><span class="version">0.2.9</span></h2></div><h2 class="location"><a href="#">Builder</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><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 trait-implementation"><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 synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-Builder">!RefUnwindSafe</a></li><li><a href="#impl-UnwindSafe-for-Builder">!UnwindSafe</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></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-Into%3CU%3E-for-T">Into<U></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></ul></section><h2><a href="index.html">In http::request</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../http/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>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" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/http/request.rs.html#190-192">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct Builder { <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 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="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Builder" class="impl"><a class="src 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="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/http/request.rs.html#758-760">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>() -> <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">"POST"</span>)
|
||
.body(())
|
||
.unwrap();</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.method" class="method"><a class="src rightside" href="../../src/http/request.rs.html#779-789">source</a><h4 class="code-header">pub fn <a href="#method.method" class="fn">method</a><T>(self, method: T) -> <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a><div class="where">where
|
||
<a class="struct" href="../method/struct.Method.html" title="struct http::method::Method">Method</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,
|
||
<<a class="struct" href="../method/struct.Method.html" title="struct http::method::Method">Method</a> as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../struct.Error.html" title="struct http::Error">Error</a>>,</div></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">"POST"</span>)
|
||
.body(())
|
||
.unwrap();</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.method_ref" class="method"><a class="src rightside" href="../../src/http/request.rs.html#806-808">source</a><h4 class="code-header">pub fn <a href="#method.method_ref" class="fn">method_ref</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../method/struct.Method.html" title="struct http::method::Method">Method</a>></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">&</span>Method::GET));
|
||
|
||
req = req.method(<span class="string">"POST"</span>);
|
||
<span class="macro">assert_eq!</span>(req.method_ref(),<span class="prelude-val">Some</span>(<span class="kw-2">&</span>Method::POST));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.uri" class="method"><a class="src rightside" href="../../src/http/request.rs.html#827-836">source</a><h4 class="code-header">pub fn <a href="#method.uri" class="fn">uri</a><T>(self, uri: T) -> <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a><div class="where">where
|
||
<a class="struct" href="../uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,
|
||
<<a class="struct" href="../uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a> as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../struct.Error.html" title="struct http::Error">Error</a>>,</div></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">"https://www.rust-lang.org/"</span>)
|
||
.body(())
|
||
.unwrap();</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.uri_ref" class="method"><a class="src rightside" href="../../src/http/request.rs.html#853-855">source</a><h4 class="code-header">pub fn <a href="#method.uri_ref" class="fn">uri_ref</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>></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">"/" </span>);
|
||
|
||
req = req.uri(<span class="string">"https://www.rust-lang.org/"</span>);
|
||
<span class="macro">assert_eq!</span>(req.uri_ref().unwrap(), <span class="string">"https://www.rust-lang.org/" </span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.version" class="method"><a class="src rightside" href="../../src/http/request.rs.html#874-879">source</a><h4 class="code-header">pub fn <a href="#method.version" class="fn">version</a>(self, version: <a class="struct" href="../version/struct.Version.html" title="struct http::version::Version">Version</a>) -> <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="toggle method-toggle" open><summary><section id="method.version_ref" class="method"><a class="src rightside" href="../../src/http/request.rs.html#896-898">source</a><h4 class="code-header">pub fn <a href="#method.version_ref" class="fn">version_ref</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../version/struct.Version.html" title="struct http::version::Version">Version</a>></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">&</span>Version::HTTP_11 );
|
||
|
||
req = req.version(Version::HTTP_2);
|
||
<span class="macro">assert_eq!</span>(req.version_ref().unwrap(), <span class="kw-2">&</span>Version::HTTP_2 );</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.header" class="method"><a class="src rightside" href="../../src/http/request.rs.html#918-931">source</a><h4 class="code-header">pub fn <a href="#method.header" class="fn">header</a><K, V>(self, key: K, value: V) -> <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a><div class="where">where
|
||
<a class="struct" href="../header/struct.HeaderName.html" title="struct http::header::HeaderName">HeaderName</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><K>,
|
||
<<a class="struct" href="../header/struct.HeaderName.html" title="struct http::header::HeaderName">HeaderName</a> as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><K>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../struct.Error.html" title="struct http::Error">Error</a>>,
|
||
<a class="struct" href="../header/struct.HeaderValue.html" title="struct http::header::HeaderValue">HeaderValue</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><V>,
|
||
<<a class="struct" href="../header/struct.HeaderValue.html" title="struct http::header::HeaderValue">HeaderValue</a> as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><V>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../struct.Error.html" title="struct http::Error">Error</a>>,</div></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">"Accept"</span>, <span class="string">"text/html"</span>)
|
||
.header(<span class="string">"X-Custom-Foo"</span>, <span class="string">"bar"</span>)
|
||
.body(())
|
||
.unwrap();</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.headers_ref" class="method"><a class="src rightside" href="../../src/http/request.rs.html#947-949">source</a><h4 class="code-header">pub fn <a href="#method.headers_ref" class="fn">headers_ref</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../header/struct.HeaderMap.html" title="struct http::header::HeaderMap">HeaderMap</a><<a class="struct" href="../header/struct.HeaderValue.html" title="struct http::header::HeaderValue">HeaderValue</a>>></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">"Accept"</span>, <span class="string">"text/html"</span>)
|
||
.header(<span class="string">"X-Custom-Foo"</span>, <span class="string">"bar"</span>);
|
||
<span class="kw">let </span>headers = req.headers_ref().unwrap();
|
||
<span class="macro">assert_eq!</span>( headers[<span class="string">"Accept"</span>], <span class="string">"text/html" </span>);
|
||
<span class="macro">assert_eq!</span>( headers[<span class="string">"X-Custom-Foo"</span>], <span class="string">"bar" </span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.headers_mut" class="method"><a class="src rightside" href="../../src/http/request.rs.html#969-971">source</a><h4 class="code-header">pub fn <a href="#method.headers_mut" class="fn">headers_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&mut <a class="struct" href="../header/struct.HeaderMap.html" title="struct http::header::HeaderMap">HeaderMap</a><<a class="struct" href="../header/struct.HeaderValue.html" title="struct http::header::HeaderValue">HeaderValue</a>>></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">"Accept"</span>, HeaderValue::from_static(<span class="string">"text/html"</span>));
|
||
headers.insert(<span class="string">"X-Custom-Foo"</span>, HeaderValue::from_static(<span class="string">"bar"</span>));
|
||
}
|
||
<span class="kw">let </span>headers = req.headers_ref().unwrap();
|
||
<span class="macro">assert_eq!</span>( headers[<span class="string">"Accept"</span>], <span class="string">"text/html" </span>);
|
||
<span class="macro">assert_eq!</span>( headers[<span class="string">"X-Custom-Foo"</span>], <span class="string">"bar" </span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.extension" class="method"><a class="src rightside" href="../../src/http/request.rs.html#988-996">source</a><h4 class="code-header">pub fn <a href="#method.extension" class="fn">extension</a><T>(self, extension: T) -> <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,</div></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">"My Extension"</span>)
|
||
.body(())
|
||
.unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(req.extensions().get::<<span class="kw-2">&</span><span class="lifetime">'static </span>str>(),
|
||
<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="string">"My Extension"</span>));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.extensions_ref" class="method"><a class="src rightside" href="../../src/http/request.rs.html#1011-1013">source</a><h4 class="code-header">pub fn <a href="#method.extensions_ref" class="fn">extensions_ref</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../struct.Extensions.html" title="struct http::Extensions">Extensions</a>></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">"My Extension"</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::<<span class="kw-2">&</span><span class="lifetime">'static </span>str>(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="string">"My Extension"</span>));
|
||
<span class="macro">assert_eq!</span>(extensions.get::<u32>(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">5u32</span>));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.extensions_mut" class="method"><a class="src rightside" href="../../src/http/request.rs.html#1029-1031">source</a><h4 class="code-header">pub fn <a href="#method.extensions_mut" class="fn">extensions_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&mut <a class="struct" href="../struct.Extensions.html" title="struct http::Extensions">Extensions</a>></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">"My Extension"</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::<<span class="kw-2">&</span><span class="lifetime">'static </span>str>(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="string">"My Extension"</span>));
|
||
extensions.insert(<span class="number">5u32</span>);
|
||
<span class="macro">assert_eq!</span>(extensions.get::<u32>(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">5u32</span>));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.body" class="method"><a class="src rightside" href="../../src/http/request.rs.html#1053-1060">source</a><h4 class="code-header">pub fn <a href="#method.body" class="fn">body</a><T>(self, body: T) -> <a class="type" href="../type.Result.html" title="type http::Result">Result</a><<a class="struct" href="struct.Request.html" title="struct http::request::Request">Request</a><T>></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("Foo", "Bar\r\n")</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="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-Builder" class="impl"><a class="src rightside" href="../../src/http/request.rs.html#189">source</a><a href="#impl-Debug-for-Builder" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/http/request.rs.html#189">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/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/1.76.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-Builder" class="impl"><a class="src 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 <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../../src/http/request.rs.html#1076-1080">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> <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 href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html#tymethod.default">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-RefUnwindSafe-for-Builder" class="impl"><a href="#impl-RefUnwindSafe-for-Builder" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> 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"><a href="#impl-Send-for-Builder" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> 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"><a href="#impl-Sync-for-Builder" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> 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"><a href="#impl-Unpin-for-Builder" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> 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"><a href="#impl-UnwindSafe-for-Builder" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</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/1.76.0/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/1.76.0/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/1.76.0/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/1.76.0/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/1.76.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/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/1.76.0/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/1.76.0/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/1.76.0/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/1.76.0/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/1.76.0/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/1.76.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/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/1.76.0/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/1.76.0/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/1.76.0/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/1.76.0/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/1.76.0/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/1.76.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/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/1.76.0/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/1.76.0/src/core/convert/mod.rs.html#763">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/1.76.0/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/1.76.0/src/core/convert/mod.rs.html#766">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/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-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#747-749">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/1.76.0/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/1.76.0/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/1.76.0/src/core/convert/mod.rs.html#756">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/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/1.76.0/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-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#803-805">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/1.76.0/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/1.76.0/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/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.76.0/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/1.76.0/src/core/convert/mod.rs.html#810">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/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/1.76.0/src/core/convert/mod.rs.html#788-790">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/1.76.0/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/1.76.0/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/1.76.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/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/1.76.0/src/core/convert/mod.rs.html#795">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/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></div></section></div></main></body></html> |