mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-26 19:58:50 +01:00
280 lines
70 KiB
HTML
280 lines
70 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `Request` struct in crate `http`."><meta name="keywords" content="rust, rustlang, rust-lang, Request"><title>http::request::Request - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../http/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Struct Request</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.body">body</a><a href="#method.body_mut">body_mut</a><a href="#method.builder">builder</a><a href="#method.connect">connect</a><a href="#method.delete">delete</a><a href="#method.extensions">extensions</a><a href="#method.extensions_mut">extensions_mut</a><a href="#method.from_parts">from_parts</a><a href="#method.get">get</a><a href="#method.head">head</a><a href="#method.headers">headers</a><a href="#method.headers_mut">headers_mut</a><a href="#method.into_body">into_body</a><a href="#method.into_parts">into_parts</a><a href="#method.map">map</a><a href="#method.method">method</a><a href="#method.method_mut">method_mut</a><a href="#method.new">new</a><a href="#method.options">options</a><a href="#method.patch">patch</a><a href="#method.post">post</a><a href="#method.put">put</a><a href="#method.trace">trace</a><a href="#method.uri">uri</a><a href="#method.uri_mut">uri_mut</a><a href="#method.version">version</a><a href="#method.version_mut">version_mut</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">http</a>::<wbr><a href="index.html">request</a></p><div id="sidebar-vars" data-name="Request" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="../index.html">http</a>::<wbr><a href="index.html">request</a>::<wbr><a class="struct" href="">Request</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/http/request.rs.html#157-160" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct Request<T> { /* fields omitted */ }</pre></div><div class="docblock"><p>Represents an HTTP request.</p>
|
||
<p>An HTTP request consists of a head and a potentially optional body. The body
|
||
component is generic, enabling arbitrary types to represent the HTTP body.
|
||
For example, the body could be <code>Vec<u8></code>, a <code>Stream</code> of byte chunks, or a
|
||
value that has been deserialized.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<p>Creating a <code>Request</code> to send</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">http</span>::{<span class="ident">Request</span>, <span class="ident">Response</span>};
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">uri</span>(<span class="string">"https://www.rust-lang.org/"</span>)
|
||
.<span class="ident">header</span>(<span class="string">"User-Agent"</span>, <span class="string">"my-awesome-agent/1.0"</span>);
|
||
|
||
<span class="kw">if</span> <span class="ident">needs_awesome_header</span>() {
|
||
<span class="ident">request</span> <span class="op">=</span> <span class="ident">request</span>.<span class="ident">header</span>(<span class="string">"Awesome"</span>, <span class="string">"yes"</span>);
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">response</span> <span class="op">=</span> <span class="ident">send</span>(<span class="ident">request</span>.<span class="ident">body</span>(()).<span class="ident">unwrap</span>());
|
||
|
||
<span class="kw">fn</span> <span class="ident">send</span>(<span class="ident">req</span>: <span class="ident">Request</span><span class="op"><</span>()<span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">Response</span><span class="op"><</span>()<span class="op">></span> {
|
||
<span class="comment">// ...</span>
|
||
}</pre></div>
|
||
<p>Inspecting a request to see what was sent.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">http</span>::{<span class="ident">Request</span>, <span class="ident">Response</span>, <span class="ident">StatusCode</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">respond_to</span>(<span class="ident">req</span>: <span class="ident">Request</span><span class="op"><</span>()<span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">http</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Response</span><span class="op"><</span>()<span class="op">></span><span class="op">></span> {
|
||
<span class="kw">if</span> <span class="ident">req</span>.<span class="ident">uri</span>() <span class="op">!</span><span class="op">=</span> <span class="string">"/awesome-url"</span> {
|
||
<span class="kw">return</span> <span class="ident">Response</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">status</span>(<span class="ident">StatusCode</span>::<span class="ident">NOT_FOUND</span>)
|
||
.<span class="ident">body</span>(())
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">has_awesome_header</span> <span class="op">=</span> <span class="ident">req</span>.<span class="ident">headers</span>().<span class="ident">contains_key</span>(<span class="string">"Awesome"</span>);
|
||
<span class="kw">let</span> <span class="ident">body</span> <span class="op">=</span> <span class="ident">req</span>.<span class="ident">body</span>();
|
||
|
||
<span class="comment">// ...</span>
|
||
}</pre></div>
|
||
<p>Deserialize a request of bytes via json:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">http</span>::<span class="ident">Request</span>;
|
||
<span class="kw">use</span> <span class="ident">serde</span>::<span class="ident">de</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">deserialize</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="ident">req</span>: <span class="ident">Request</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">serde_json</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Request</span><span class="op"><</span><span class="ident">T</span><span class="op">></span><span class="op">></span>
|
||
<span class="kw">where</span> <span class="kw">for</span><span class="op"><</span><span class="lifetime">'de</span><span class="op">></span> <span class="ident">T</span>: <span class="ident">de</span>::<span class="ident">Deserialize</span><span class="op"><</span><span class="lifetime">'de</span><span class="op">></span>,
|
||
{
|
||
<span class="kw">let</span> (<span class="ident">parts</span>, <span class="ident">body</span>) <span class="op">=</span> <span class="ident">req</span>.<span class="ident">into_parts</span>();
|
||
<span class="kw">let</span> <span class="ident">body</span> <span class="op">=</span> <span class="ident">serde_json</span>::<span class="ident">from_slice</span>(<span class="kw-2">&</span><span class="ident">body</span>)<span class="question-mark">?</span>;
|
||
<span class="prelude-val">Ok</span>(<span class="ident">Request</span>::<span class="ident">from_parts</span>(<span class="ident">parts</span>, <span class="ident">body</span>))
|
||
}</pre></div>
|
||
<p>Or alternatively, serialize the body of a request to json</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">http</span>::<span class="ident">Request</span>;
|
||
<span class="kw">use</span> <span class="ident">serde</span>::<span class="ident">ser</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">serialize</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="ident">req</span>: <span class="ident">Request</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">serde_json</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Request</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span><span class="op">></span><span class="op">></span>
|
||
<span class="kw">where</span> <span class="ident">T</span>: <span class="ident">ser</span>::<span class="ident">Serialize</span>,
|
||
{
|
||
<span class="kw">let</span> (<span class="ident">parts</span>, <span class="ident">body</span>) <span class="op">=</span> <span class="ident">req</span>.<span class="ident">into_parts</span>();
|
||
<span class="kw">let</span> <span class="ident">body</span> <span class="op">=</span> <span class="ident">serde_json</span>::<span class="ident">to_vec</span>(<span class="kw-2">&</span><span class="ident">body</span>)<span class="question-mark">?</span>;
|
||
<span class="prelude-val">Ok</span>(<span class="ident">Request</span>::<span class="ident">from_parts</span>(<span class="ident">parts</span>, <span class="ident">body</span>))
|
||
}</pre></div>
|
||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/http/request.rs.html#194-421" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.builder" class="method"><code>pub fn <a href="#method.builder" class="fnname">builder</a>() -> <a class="struct" href="../../http/request/struct.Builder.html" title="struct http::request::Builder">Builder</a></code><a class="srclink" href="../../src/http/request.rs.html#212-214" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new builder-style object to manufacture a <code>Request</code></p>
|
||
<p>This method returns an instance of <code>Builder</code> which can be used to
|
||
create a <code>Request</code>.</p>
|
||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">method</span>(<span class="string">"GET"</span>)
|
||
.<span class="ident">uri</span>(<span class="string">"https://www.rust-lang.org/"</span>)
|
||
.<span class="ident">header</span>(<span class="string">"X-Custom-Foo"</span>, <span class="string">"Bar"</span>)
|
||
.<span class="ident">body</span>(())
|
||
.<span class="ident">unwrap</span>();</pre></div>
|
||
</div><h4 id="method.get" class="method"><code>pub fn <a href="#method.get" class="fnname">get</a><T>(uri: T) -> <a class="struct" href="../../http/request/struct.Builder.html" title="struct http::request::Builder">Builder</a> <span class="where fmt-newline">where<br> <a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,<br> <<a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" 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/struct.Error.html" title="struct http::Error">Error</a>>, </span></code><a class="srclink" href="../../src/http/request.rs.html#230-237" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new <code>Builder</code> initialized with a GET method and the given URI.</p>
|
||
<p>This method returns an instance of <code>Builder</code> which can be used to
|
||
create a <code>Request</code>.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">get</span>(<span class="string">"https://www.rust-lang.org/"</span>)
|
||
.<span class="ident">body</span>(())
|
||
.<span class="ident">unwrap</span>();</pre></div>
|
||
</div><h4 id="method.put" class="method"><code>pub fn <a href="#method.put" class="fnname">put</a><T>(uri: T) -> <a class="struct" href="../../http/request/struct.Builder.html" title="struct http::request::Builder">Builder</a> <span class="where fmt-newline">where<br> <a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,<br> <<a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" 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/struct.Error.html" title="struct http::Error">Error</a>>, </span></code><a class="srclink" href="../../src/http/request.rs.html#253-260" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new <code>Builder</code> initialized with a PUT method and the given URI.</p>
|
||
<p>This method returns an instance of <code>Builder</code> which can be used to
|
||
create a <code>Request</code>.</p>
|
||
<h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">put</span>(<span class="string">"https://www.rust-lang.org/"</span>)
|
||
.<span class="ident">body</span>(())
|
||
.<span class="ident">unwrap</span>();</pre></div>
|
||
</div><h4 id="method.post" class="method"><code>pub fn <a href="#method.post" class="fnname">post</a><T>(uri: T) -> <a class="struct" href="../../http/request/struct.Builder.html" title="struct http::request::Builder">Builder</a> <span class="where fmt-newline">where<br> <a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,<br> <<a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" 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/struct.Error.html" title="struct http::Error">Error</a>>, </span></code><a class="srclink" href="../../src/http/request.rs.html#276-283" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new <code>Builder</code> initialized with a POST method and the given URI.</p>
|
||
<p>This method returns an instance of <code>Builder</code> which can be used to
|
||
create a <code>Request</code>.</p>
|
||
<h1 id="example-2" class="section-header"><a href="#example-2">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">post</span>(<span class="string">"https://www.rust-lang.org/"</span>)
|
||
.<span class="ident">body</span>(())
|
||
.<span class="ident">unwrap</span>();</pre></div>
|
||
</div><h4 id="method.delete" class="method"><code>pub fn <a href="#method.delete" class="fnname">delete</a><T>(uri: T) -> <a class="struct" href="../../http/request/struct.Builder.html" title="struct http::request::Builder">Builder</a> <span class="where fmt-newline">where<br> <a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,<br> <<a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" 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/struct.Error.html" title="struct http::Error">Error</a>>, </span></code><a class="srclink" href="../../src/http/request.rs.html#299-306" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new <code>Builder</code> initialized with a DELETE method and the given URI.</p>
|
||
<p>This method returns an instance of <code>Builder</code> which can be used to
|
||
create a <code>Request</code>.</p>
|
||
<h1 id="example-3" class="section-header"><a href="#example-3">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">delete</span>(<span class="string">"https://www.rust-lang.org/"</span>)
|
||
.<span class="ident">body</span>(())
|
||
.<span class="ident">unwrap</span>();</pre></div>
|
||
</div><h4 id="method.options" class="method"><code>pub fn <a href="#method.options" class="fnname">options</a><T>(uri: T) -> <a class="struct" href="../../http/request/struct.Builder.html" title="struct http::request::Builder">Builder</a> <span class="where fmt-newline">where<br> <a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,<br> <<a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" 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/struct.Error.html" title="struct http::Error">Error</a>>, </span></code><a class="srclink" href="../../src/http/request.rs.html#323-330" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new <code>Builder</code> initialized with an OPTIONS method and the given URI.</p>
|
||
<p>This method returns an instance of <code>Builder</code> which can be used to
|
||
create a <code>Request</code>.</p>
|
||
<h1 id="example-4" class="section-header"><a href="#example-4">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">options</span>(<span class="string">"https://www.rust-lang.org/"</span>)
|
||
.<span class="ident">body</span>(())
|
||
.<span class="ident">unwrap</span>();</pre></div>
|
||
</div><h4 id="method.head" class="method"><code>pub fn <a href="#method.head" class="fnname">head</a><T>(uri: T) -> <a class="struct" href="../../http/request/struct.Builder.html" title="struct http::request::Builder">Builder</a> <span class="where fmt-newline">where<br> <a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,<br> <<a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" 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/struct.Error.html" title="struct http::Error">Error</a>>, </span></code><a class="srclink" href="../../src/http/request.rs.html#346-353" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new <code>Builder</code> initialized with a HEAD method and the given URI.</p>
|
||
<p>This method returns an instance of <code>Builder</code> which can be used to
|
||
create a <code>Request</code>.</p>
|
||
<h1 id="example-5" class="section-header"><a href="#example-5">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">head</span>(<span class="string">"https://www.rust-lang.org/"</span>)
|
||
.<span class="ident">body</span>(())
|
||
.<span class="ident">unwrap</span>();</pre></div>
|
||
</div><h4 id="method.connect" class="method"><code>pub fn <a href="#method.connect" class="fnname">connect</a><T>(uri: T) -> <a class="struct" href="../../http/request/struct.Builder.html" title="struct http::request::Builder">Builder</a> <span class="where fmt-newline">where<br> <a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,<br> <<a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" 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/struct.Error.html" title="struct http::Error">Error</a>>, </span></code><a class="srclink" href="../../src/http/request.rs.html#369-376" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new <code>Builder</code> initialized with a CONNECT method and the given URI.</p>
|
||
<p>This method returns an instance of <code>Builder</code> which can be used to
|
||
create a <code>Request</code>.</p>
|
||
<h1 id="example-6" class="section-header"><a href="#example-6">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">connect</span>(<span class="string">"https://www.rust-lang.org/"</span>)
|
||
.<span class="ident">body</span>(())
|
||
.<span class="ident">unwrap</span>();</pre></div>
|
||
</div><h4 id="method.patch" class="method"><code>pub fn <a href="#method.patch" class="fnname">patch</a><T>(uri: T) -> <a class="struct" href="../../http/request/struct.Builder.html" title="struct http::request::Builder">Builder</a> <span class="where fmt-newline">where<br> <a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,<br> <<a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" 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/struct.Error.html" title="struct http::Error">Error</a>>, </span></code><a class="srclink" href="../../src/http/request.rs.html#392-398" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new <code>Builder</code> initialized with a PATCH method and the given URI.</p>
|
||
<p>This method returns an instance of <code>Builder</code> which can be used to
|
||
create a <code>Request</code>.</p>
|
||
<h1 id="example-7" class="section-header"><a href="#example-7">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">patch</span>(<span class="string">"https://www.rust-lang.org/"</span>)
|
||
.<span class="ident">body</span>(())
|
||
.<span class="ident">unwrap</span>();</pre></div>
|
||
</div><h4 id="method.trace" class="method"><code>pub fn <a href="#method.trace" class="fnname">trace</a><T>(uri: T) -> <a class="struct" href="../../http/request/struct.Builder.html" title="struct http::request::Builder">Builder</a> <span class="where fmt-newline">where<br> <a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,<br> <<a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" 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/struct.Error.html" title="struct http::Error">Error</a>>, </span></code><a class="srclink" href="../../src/http/request.rs.html#414-420" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new <code>Builder</code> initialized with a TRACE method and the given URI.</p>
|
||
<p>This method returns an instance of <code>Builder</code> which can be used to
|
||
create a <code>Request</code>.</p>
|
||
<h1 id="example-8" class="section-header"><a href="#example-8">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">trace</span>(<span class="string">"https://www.rust-lang.org/"</span>)
|
||
.<span class="ident">body</span>(())
|
||
.<span class="ident">unwrap</span>();</pre></div>
|
||
</div></div><h3 id="impl-1" class="impl"><code class="in-band">impl<T> <a class="struct" href="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><T></code><a href="#impl-1" class="anchor"></a><a class="srclink" href="../../src/http/request.rs.html#423-696" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>(body: T) -> <a class="struct" href="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><T></code><a class="srclink" href="../../src/http/request.rs.html#439-444" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new blank <code>Request</code> with the body</p>
|
||
<p>The component parts of this request will be set to their default, e.g.
|
||
the GET method, no headers, etc.</p>
|
||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">new</span>(<span class="string">"hello world"</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">request</span>.<span class="ident">method</span>(), <span class="ident">Method</span>::<span class="ident">GET</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">request</span>.<span class="ident">body</span>(), <span class="string">"hello world"</span>);</pre></div>
|
||
</div><h4 id="method.from_parts" class="method"><code>pub fn <a href="#method.from_parts" class="fnname">from_parts</a>(parts: <a class="struct" href="../../http/request/struct.Parts.html" title="struct http::request::Parts">Parts</a>, body: T) -> <a class="struct" href="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><T></code><a class="srclink" href="../../src/http/request.rs.html#459-464" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new <code>Request</code> with the given components parts and body.</p>
|
||
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">new</span>(<span class="string">"hello world"</span>);
|
||
<span class="kw">let</span> (<span class="kw-2">mut</span> <span class="ident">parts</span>, <span class="ident">body</span>) <span class="op">=</span> <span class="ident">request</span>.<span class="ident">into_parts</span>();
|
||
<span class="ident">parts</span>.<span class="ident">method</span> <span class="op">=</span> <span class="ident">Method</span>::<span class="ident">POST</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">from_parts</span>(<span class="ident">parts</span>, <span class="ident">body</span>);</pre></div>
|
||
</div><h4 id="method.method" class="method"><code>pub fn <a href="#method.method" class="fnname">method</a>(&self) -> &<a class="struct" href="../../http/method/struct.Method.html" title="struct http::method::Method">Method</a></code><a class="srclink" href="../../src/http/request.rs.html#476-478" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a reference to the associated HTTP method.</p>
|
||
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">request</span>: <span class="ident">Request</span><span class="op"><</span>()<span class="op">></span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">default</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">request</span>.<span class="ident">method</span>(), <span class="ident">Method</span>::<span class="ident">GET</span>);</pre></div>
|
||
</div><h4 id="method.method_mut" class="method"><code>pub fn <a href="#method.method_mut" class="fnname">method_mut</a>(&mut self) -> &mut <a class="struct" href="../../http/method/struct.Method.html" title="struct http::method::Method">Method</a></code><a class="srclink" href="../../src/http/request.rs.html#491-493" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a mutable reference to the associated HTTP method.</p>
|
||
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">request</span>: <span class="ident">Request</span><span class="op"><</span>()<span class="op">></span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">default</span>();
|
||
<span class="kw-2">*</span><span class="ident">request</span>.<span class="ident">method_mut</span>() <span class="op">=</span> <span class="ident">Method</span>::<span class="ident">PUT</span>;
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">request</span>.<span class="ident">method</span>(), <span class="ident">Method</span>::<span class="ident">PUT</span>);</pre></div>
|
||
</div><h4 id="method.uri" class="method"><code>pub fn <a href="#method.uri" class="fnname">uri</a>(&self) -> &<a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a></code><a class="srclink" href="../../src/http/request.rs.html#505-507" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a reference to the associated URI.</p>
|
||
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">request</span>: <span class="ident">Request</span><span class="op"><</span>()<span class="op">></span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">default</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">request</span>.<span class="ident">uri</span>(), <span class="kw-2">*</span><span class="string">"/"</span>);</pre></div>
|
||
</div><h4 id="method.uri_mut" class="method"><code>pub fn <a href="#method.uri_mut" class="fnname">uri_mut</a>(&mut self) -> &mut <a class="struct" href="../../http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a></code><a class="srclink" href="../../src/http/request.rs.html#520-522" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a mutable reference to the associated URI.</p>
|
||
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">request</span>: <span class="ident">Request</span><span class="op"><</span>()<span class="op">></span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">default</span>();
|
||
<span class="kw-2">*</span><span class="ident">request</span>.<span class="ident">uri_mut</span>() <span class="op">=</span> <span class="string">"/hello"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">request</span>.<span class="ident">uri</span>(), <span class="kw-2">*</span><span class="string">"/hello"</span>);</pre></div>
|
||
</div><h4 id="method.version" class="method"><code>pub fn <a href="#method.version" class="fnname">version</a>(&self) -> <a class="struct" href="../../http/version/struct.Version.html" title="struct http::version::Version">Version</a></code><a class="srclink" href="../../src/http/request.rs.html#534-536" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns the associated version.</p>
|
||
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">request</span>: <span class="ident">Request</span><span class="op"><</span>()<span class="op">></span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">default</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">request</span>.<span class="ident">version</span>(), <span class="ident">Version</span>::<span class="ident">HTTP_11</span>);</pre></div>
|
||
</div><h4 id="method.version_mut" class="method"><code>pub fn <a href="#method.version_mut" class="fnname">version_mut</a>(&mut self) -> &mut <a class="struct" href="../../http/version/struct.Version.html" title="struct http::version::Version">Version</a></code><a class="srclink" href="../../src/http/request.rs.html#549-551" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a mutable reference to the associated version.</p>
|
||
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">request</span>: <span class="ident">Request</span><span class="op"><</span>()<span class="op">></span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">default</span>();
|
||
<span class="kw-2">*</span><span class="ident">request</span>.<span class="ident">version_mut</span>() <span class="op">=</span> <span class="ident">Version</span>::<span class="ident">HTTP_2</span>;
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">request</span>.<span class="ident">version</span>(), <span class="ident">Version</span>::<span class="ident">HTTP_2</span>);</pre></div>
|
||
</div><h4 id="method.headers" class="method"><code>pub fn <a href="#method.headers" class="fnname">headers</a>(&self) -> &<a class="struct" href="../../http/header/struct.HeaderMap.html" title="struct http::header::HeaderMap">HeaderMap</a><<a class="struct" href="../../http/header/struct.HeaderValue.html" title="struct http::header::HeaderValue">HeaderValue</a>></code><a class="srclink" href="../../src/http/request.rs.html#563-565" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a reference to the associated header field map.</p>
|
||
<h1 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">request</span>: <span class="ident">Request</span><span class="op"><</span>()<span class="op">></span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">default</span>();
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">request</span>.<span class="ident">headers</span>().<span class="ident">is_empty</span>());</pre></div>
|
||
</div><h4 id="method.headers_mut" class="method"><code>pub fn <a href="#method.headers_mut" class="fnname">headers_mut</a>(&mut self) -> &mut <a class="struct" href="../../http/header/struct.HeaderMap.html" title="struct http::header::HeaderMap">HeaderMap</a><<a class="struct" href="../../http/header/struct.HeaderValue.html" title="struct http::header::HeaderValue">HeaderValue</a>></code><a class="srclink" href="../../src/http/request.rs.html#579-581" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a mutable reference to the associated header field map.</p>
|
||
<h1 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">request</span>: <span class="ident">Request</span><span class="op"><</span>()<span class="op">></span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">default</span>();
|
||
<span class="ident">request</span>.<span class="ident">headers_mut</span>().<span class="ident">insert</span>(<span class="ident">HOST</span>, <span class="ident">HeaderValue</span>::<span class="ident">from_static</span>(<span class="string">"world"</span>));
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">request</span>.<span class="ident">headers</span>().<span class="ident">is_empty</span>());</pre></div>
|
||
</div><h4 id="method.extensions" class="method"><code>pub fn <a href="#method.extensions" class="fnname">extensions</a>(&self) -> &<a class="struct" href="../../http/struct.Extensions.html" title="struct http::Extensions">Extensions</a></code><a class="srclink" href="../../src/http/request.rs.html#593-595" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a reference to the associated extensions.</p>
|
||
<h1 id="examples-12" class="section-header"><a href="#examples-12">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">request</span>: <span class="ident">Request</span><span class="op"><</span>()<span class="op">></span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">default</span>();
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">request</span>.<span class="ident">extensions</span>().<span class="ident">get</span>::<span class="op"><</span><span class="ident">i32</span><span class="op">></span>().<span class="ident">is_none</span>());</pre></div>
|
||
</div><h4 id="method.extensions_mut" class="method"><code>pub fn <a href="#method.extensions_mut" class="fnname">extensions_mut</a>(&mut self) -> &mut <a class="struct" href="../../http/struct.Extensions.html" title="struct http::Extensions">Extensions</a></code><a class="srclink" href="../../src/http/request.rs.html#609-611" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a mutable reference to the associated extensions.</p>
|
||
<h1 id="examples-13" class="section-header"><a href="#examples-13">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">request</span>: <span class="ident">Request</span><span class="op"><</span>()<span class="op">></span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">default</span>();
|
||
<span class="ident">request</span>.<span class="ident">extensions_mut</span>().<span class="ident">insert</span>(<span class="string">"hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">request</span>.<span class="ident">extensions</span>().<span class="ident">get</span>(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="string">"hello"</span>));</pre></div>
|
||
</div><h4 id="method.body" class="method"><code>pub fn <a href="#method.body" class="fnname">body</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="../../src/http/request.rs.html#623-625" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a reference to the associated HTTP body.</p>
|
||
<h1 id="examples-14" class="section-header"><a href="#examples-14">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">request</span>: <span class="ident">Request</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">default</span>();
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">request</span>.<span class="ident">body</span>().<span class="ident">is_empty</span>());</pre></div>
|
||
</div><h4 id="method.body_mut" class="method"><code>pub fn <a href="#method.body_mut" class="fnname">body_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="../../src/http/request.rs.html#638-640" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a mutable reference to the associated HTTP body.</p>
|
||
<h1 id="examples-15" class="section-header"><a href="#examples-15">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">request</span>: <span class="ident">Request</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">default</span>();
|
||
<span class="ident">request</span>.<span class="ident">body_mut</span>().<span class="ident">push_str</span>(<span class="string">"hello world"</span>);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">request</span>.<span class="ident">body</span>().<span class="ident">is_empty</span>());</pre></div>
|
||
</div><h4 id="method.into_body" class="method"><code>pub fn <a href="#method.into_body" class="fnname">into_body</a>(self) -> T</code><a class="srclink" href="../../src/http/request.rs.html#653-655" title="goto source code">[src]</a></h4><div class="docblock"><p>Consumes the request, returning just the body.</p>
|
||
<h1 id="examples-16" class="section-header"><a href="#examples-16">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">new</span>(<span class="number">10</span>);
|
||
<span class="kw">let</span> <span class="ident">body</span> <span class="op">=</span> <span class="ident">request</span>.<span class="ident">into_body</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">body</span>, <span class="number">10</span>);</pre></div>
|
||
</div><h4 id="method.into_parts" class="method"><code>pub fn <a href="#method.into_parts" class="fnname">into_parts</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../../http/request/struct.Parts.html" title="struct http::request::Parts">Parts</a>, T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class="srclink" href="../../src/http/request.rs.html#668-670" title="goto source code">[src]</a></h4><div class="docblock"><p>Consumes the request returning the head and body parts.</p>
|
||
<h1 id="examples-17" class="section-header"><a href="#examples-17">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">new</span>(());
|
||
<span class="kw">let</span> (<span class="ident">parts</span>, <span class="ident">body</span>) <span class="op">=</span> <span class="ident">request</span>.<span class="ident">into_parts</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">parts</span>.<span class="ident">method</span>, <span class="ident">Method</span>::<span class="ident">GET</span>);</pre></div>
|
||
</div><h4 id="method.map" class="method"><code>pub fn <a href="#method.map" class="fnname">map</a><F, U>(self, f: F) -> <a class="struct" href="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><U> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(T) -> U, </span></code><a class="srclink" href="../../src/http/request.rs.html#687-695" title="goto source code">[src]</a></h4><div class="docblock"><p>Consumes the request returning a new request with body mapped to the
|
||
return type of the passed in function.</p>
|
||
<h1 id="examples-18" class="section-header"><a href="#examples-18">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">builder</span>().<span class="ident">body</span>(<span class="string">"some string"</span>).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">mapped_request</span>: <span class="ident">Request</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">u8</span>]<span class="op">></span> <span class="op">=</span> <span class="ident">request</span>.<span class="ident">map</span>(<span class="op">|</span><span class="ident">b</span><span class="op">|</span> {
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">b</span>, <span class="string">"some string"</span>);
|
||
<span class="ident">b</span>.<span class="ident">as_bytes</span>()
|
||
});
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mapped_request</span>.<span class="ident">body</span>(), <span class="kw-2">&</span><span class="string">"some string"</span>.<span class="ident">as_bytes</span>());</pre></div>
|
||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Debug" class="impl"><code class="in-band">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <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="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><T></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/http/request.rs.html#704-715" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>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></code><a class="srclink" href="../../src/http/request.rs.html#705-714" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>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></p>
|
||
</div></div><h3 id="impl-Default" class="impl"><code class="in-band">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><T></code><a href="#impl-Default" class="anchor"></a><a class="srclink" href="../../src/http/request.rs.html#698-702" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.default" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> <a class="struct" href="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><T></code><a class="srclink" href="../../src/http/request.rs.html#699-701" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></div></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"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl<T> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><T></code><a href="#impl-RefUnwindSafe" class="anchor"></a><a class="srclink" href="../../src/http/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl<T> <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="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href="#impl-Send" class="anchor"></a><a class="srclink" href="../../src/http/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl<T> <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="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code><a href="#impl-Sync" class="anchor"></a><a class="srclink" href="../../src/http/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl<T> <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="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a href="#impl-Unpin" class="anchor"></a><a class="srclink" href="../../src/http/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl<T> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../http/request/struct.Request.html" title="struct http::request::Request">Request</a><T></code><a href="#impl-UnwindSafe" class="anchor"></a><a class="srclink" href="../../src/http/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">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></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub 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></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>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></p>
|
||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">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></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub 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</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">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></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub 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</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>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></p>
|
||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">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</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">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></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">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></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_from" class="method hidden"><code>pub 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="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">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></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">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="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_into" class="method hidden"><code>pub 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="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="http"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |