| <!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="Represents an HTTP response"><meta name="keywords" content="rust, rustlang, rust-lang, Response"><title>Response in http::response - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../http/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../http/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Response</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.body">body</a></li><li><a href="#method.body_mut">body_mut</a></li><li><a href="#method.builder">builder</a></li><li><a href="#method.extensions">extensions</a></li><li><a href="#method.extensions_mut">extensions_mut</a></li><li><a href="#method.from_parts">from_parts</a></li><li><a href="#method.headers">headers</a></li><li><a href="#method.headers_mut">headers_mut</a></li><li><a href="#method.into_body">into_body</a></li><li><a href="#method.into_parts">into_parts</a></li><li><a href="#method.map">map</a></li><li><a href="#method.new">new</a></li><li><a href="#method.status">status</a></li><li><a href="#method.status_mut">status_mut</a></li><li><a href="#method.version">version</a></li><li><a href="#method.version_mut">version_mut</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-Response%3CT%3E">Debug</a></li><li><a href="#impl-Default-for-Response%3CT%3E">Default</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Response%3CT%3E">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-Response%3CT%3E">Send</a></li><li><a href="#impl-Sync-for-Response%3CT%3E">Sync</a></li><li><a href="#impl-Unpin-for-Response%3CT%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Response%3CT%3E">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Response%3CT%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Response%3CT%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Response%3CT%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Response%3CT%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Response%3CT%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-Response%3CT%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Response%3CT%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In http::response</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">http</a>::<wbr><a href="index.html">response</a>::<wbr><a class="struct" href="#">Response</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/http/response.rs.html#179-182">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Response<T> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Represents an HTTP response</p> |
| <p>An HTTP response 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> |
| <p>Typically you’ll work with responses on the client side as the result of |
| sending a <code>Request</code> and on the server you’ll be generating a <code>Response</code> to |
| send back to the client.</p> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <p>Creating a <code>Response</code> to return</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>http::{Request, Response, StatusCode}; |
| |
| <span class="kw">fn </span>respond_to(req: Request<()>) -> http::Result<Response<()>> { |
| <span class="kw">let </span><span class="kw-2">mut </span>builder = Response::builder() |
| .header(<span class="string">"Foo"</span>, <span class="string">"Bar"</span>) |
| .status(StatusCode::OK); |
| |
| <span class="kw">if </span>req.headers().contains_key(<span class="string">"Another-Header"</span>) { |
| builder = builder.header(<span class="string">"Another-Header"</span>, <span class="string">"Ack"</span>); |
| } |
| |
| builder.body(()) |
| }</code></pre></div> |
| <p>A simple 404 handler</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>http::{Request, Response, StatusCode}; |
| |
| <span class="kw">fn </span>not_found(_req: Request<()>) -> http::Result<Response<()>> { |
| Response::builder() |
| .status(StatusCode::NOT_FOUND) |
| .body(()) |
| }</code></pre></div> |
| <p>Or otherwise inspecting the result of a request:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>http::{Request, Response}; |
| |
| <span class="kw">fn </span>get(url: <span class="kw-2">&</span>str) -> http::Result<Response<()>> { |
| <span class="comment">// ... |
| </span>} |
| |
| <span class="kw">let </span>response = get(<span class="string">"https://www.rust-lang.org/"</span>).unwrap(); |
| |
| <span class="kw">if </span>!response.status().is_success() { |
| <span class="macro">panic!</span>(<span class="string">"failed to get a successful response status!"</span>); |
| } |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(date) = response.headers().get(<span class="string">"Date"</span>) { |
| <span class="comment">// we've got a `Date` header! |
| </span>} |
| |
| <span class="kw">let </span>body = response.body(); |
| <span class="comment">// ...</span></code></pre></div> |
| <p>Deserialize a response of bytes via json:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>http::Response; |
| <span class="kw">use </span>serde::de; |
| |
| <span class="kw">fn </span>deserialize<T>(res: Response<Vec<u8>>) -> serde_json::Result<Response<T>> |
| <span class="kw">where for</span><<span class="lifetime">'de</span>> T: de::Deserialize<<span class="lifetime">'de</span>>, |
| { |
| <span class="kw">let </span>(parts, body) = res.into_parts(); |
| <span class="kw">let </span>body = serde_json::from_slice(<span class="kw-2">&</span>body)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(Response::from_parts(parts, body)) |
| }</code></pre></div> |
| <p>Or alternatively, serialize the body of a response to json</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>http::Response; |
| <span class="kw">use </span>serde::ser; |
| |
| <span class="kw">fn </span>serialize<T>(res: Response<T>) -> serde_json::Result<Response<Vec<u8>>> |
| <span class="kw">where </span>T: ser::Serialize, |
| { |
| <span class="kw">let </span>(parts, body) = res.into_parts(); |
| <span class="kw">let </span>body = serde_json::to_vec(<span class="kw-2">&</span>body)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(Response::from_parts(parts, body)) |
| }</code></pre></div> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Response%3C()%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#213-233">source</a><a href="#impl-Response%3C()%3E" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.Response.html" title="struct http::response::Response">Response</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.builder" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#230-232">source</a><h4 class="code-header">pub fn <a href="#method.builder" class="fnname">builder</a>() -> <a class="struct" href="struct.Builder.html" title="struct http::response::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Creates a new builder-style object to manufacture a <code>Response</code></p> |
| <p>This method returns an instance of <code>Builder</code> which can be used to |
| create a <code>Response</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>response = Response::builder() |
| .status(<span class="number">200</span>) |
| .header(<span class="string">"X-Custom-Foo"</span>, <span class="string">"Bar"</span>) |
| .body(()) |
| .unwrap();</code></pre></div> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Response%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#235-482">source</a><a href="#impl-Response%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="struct" href="struct.Response.html" title="struct http::response::Response">Response</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#251-256">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>(body: T) -> <a class="struct" href="struct.Response.html" title="struct http::response::Response">Response</a><T></h4></section></summary><div class="docblock"><p>Creates a new blank <code>Response</code> with the body</p> |
| <p>The component ports of this response will be set to their default, e.g. |
| the ok status, no headers, etc.</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>response = Response::new(<span class="string">"hello world"</span>); |
| |
| <span class="macro">assert_eq!</span>(response.status(), StatusCode::OK); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>response.body(), <span class="string">"hello world"</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_parts" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#274-279">source</a><h4 class="code-header">pub fn <a href="#method.from_parts" class="fnname">from_parts</a>(parts: <a class="struct" href="struct.Parts.html" title="struct http::response::Parts">Parts</a>, body: T) -> <a class="struct" href="struct.Response.html" title="struct http::response::Response">Response</a><T></h4></section></summary><div class="docblock"><p>Creates a new <code>Response</code> with the given head and body</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>response = Response::new(<span class="string">"hello world"</span>); |
| <span class="kw">let </span>(<span class="kw-2">mut </span>parts, body) = response.into_parts(); |
| |
| parts.status = StatusCode::BAD_REQUEST; |
| <span class="kw">let </span>response = Response::from_parts(parts, body); |
| |
| <span class="macro">assert_eq!</span>(response.status(), StatusCode::BAD_REQUEST); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>response.body(), <span class="string">"hello world"</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.status" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#291-293">source</a><h4 class="code-header">pub fn <a href="#method.status" class="fnname">status</a>(&self) -> <a class="struct" href="../status/struct.StatusCode.html" title="struct http::status::StatusCode">StatusCode</a></h4></section></summary><div class="docblock"><p>Returns the <code>StatusCode</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>response: Response<()> = Response::default(); |
| <span class="macro">assert_eq!</span>(response.status(), StatusCode::OK);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.status_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#306-308">source</a><h4 class="code-header">pub fn <a href="#method.status_mut" class="fnname">status_mut</a>(&mut self) -> &mut <a class="struct" href="../status/struct.StatusCode.html" title="struct http::status::StatusCode">StatusCode</a></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the associated <code>StatusCode</code>.</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><span class="kw-2">mut </span>response: Response<()> = Response::default(); |
| <span class="kw-2">*</span>response.status_mut() = StatusCode::CREATED; |
| <span class="macro">assert_eq!</span>(response.status(), StatusCode::CREATED);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.version" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#320-322">source</a><h4 class="code-header">pub fn <a href="#method.version" class="fnname">version</a>(&self) -> <a class="struct" href="../version/struct.Version.html" title="struct http::version::Version">Version</a></h4></section></summary><div class="docblock"><p>Returns a reference to the associated version.</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>response: Response<()> = Response::default(); |
| <span class="macro">assert_eq!</span>(response.version(), Version::HTTP_11);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.version_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#335-337">source</a><h4 class="code-header">pub fn <a href="#method.version_mut" class="fnname">version_mut</a>(&mut self) -> &mut <a class="struct" href="../version/struct.Version.html" title="struct http::version::Version">Version</a></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the associated version.</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><span class="kw-2">mut </span>response: Response<()> = Response::default(); |
| <span class="kw-2">*</span>response.version_mut() = Version::HTTP_2; |
| <span class="macro">assert_eq!</span>(response.version(), Version::HTTP_2);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.headers" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#349-351">source</a><h4 class="code-header">pub fn <a href="#method.headers" class="fnname">headers</a>(&self) -> &<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>Returns a reference to the associated header field map.</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>response: Response<()> = Response::default(); |
| <span class="macro">assert!</span>(response.headers().is_empty());</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.headers_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#365-367">source</a><h4 class="code-header">pub fn <a href="#method.headers_mut" class="fnname">headers_mut</a>(&mut self) -> &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>Returns a mutable reference to the associated header field map.</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><span class="kw-2">mut </span>response: Response<()> = Response::default(); |
| response.headers_mut().insert(HOST, HeaderValue::from_static(<span class="string">"world"</span>)); |
| <span class="macro">assert!</span>(!response.headers().is_empty());</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.extensions" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#379-381">source</a><h4 class="code-header">pub fn <a href="#method.extensions" class="fnname">extensions</a>(&self) -> &<a class="struct" href="../struct.Extensions.html" title="struct http::Extensions">Extensions</a></h4></section></summary><div class="docblock"><p>Returns a reference to the associated extensions.</p> |
| <h5 id="examples-10"><a href="#examples-10">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>response: Response<()> = Response::default(); |
| <span class="macro">assert!</span>(response.extensions().get::<i32>().is_none());</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.extensions_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#395-397">source</a><h4 class="code-header">pub fn <a href="#method.extensions_mut" class="fnname">extensions_mut</a>(&mut self) -> &mut <a class="struct" href="../struct.Extensions.html" title="struct http::Extensions">Extensions</a></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the associated extensions.</p> |
| <h5 id="examples-11"><a href="#examples-11">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>response: Response<()> = Response::default(); |
| response.extensions_mut().insert(<span class="string">"hello"</span>); |
| <span class="macro">assert_eq!</span>(response.extensions().get(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="string">"hello"</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.body" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#409-411">source</a><h4 class="code-header">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</h4></section></summary><div class="docblock"><p>Returns a reference to the associated HTTP body.</p> |
| <h5 id="examples-12"><a href="#examples-12">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>response: Response<String> = Response::default(); |
| <span class="macro">assert!</span>(response.body().is_empty());</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.body_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#424-426">source</a><h4 class="code-header">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</h4></section></summary><div class="docblock"><p>Returns a mutable reference to the associated HTTP body.</p> |
| <h5 id="examples-13"><a href="#examples-13">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>response: Response<String> = Response::default(); |
| response.body_mut().push_str(<span class="string">"hello world"</span>); |
| <span class="macro">assert!</span>(!response.body().is_empty());</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_body" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#439-441">source</a><h4 class="code-header">pub fn <a href="#method.into_body" class="fnname">into_body</a>(self) -> T</h4></section></summary><div class="docblock"><p>Consumes the response, returning just the body.</p> |
| <h5 id="examples-14"><a href="#examples-14">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>response = Response::new(<span class="number">10</span>); |
| <span class="kw">let </span>body = response.into_body(); |
| <span class="macro">assert_eq!</span>(body, <span class="number">10</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_parts" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#454-456">source</a><h4 class="code-header">pub fn <a href="#method.into_parts" class="fnname">into_parts</a>(self) -> (<a class="struct" href="struct.Parts.html" title="struct http::response::Parts">Parts</a>, T)</h4></section></summary><div class="docblock"><p>Consumes the response returning the head and body parts.</p> |
| <h5 id="examples-15"><a href="#examples-15">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>response: Response<()> = Response::default(); |
| <span class="kw">let </span>(parts, body) = response.into_parts(); |
| <span class="macro">assert_eq!</span>(parts.status, StatusCode::OK);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map" class="method has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#473-481">source</a><h4 class="code-header">pub fn <a href="#method.map" class="fnname">map</a><F, U>(self, f: F) -> <a class="struct" href="struct.Response.html" title="struct http::response::Response">Response</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></h4></section></summary><div class="docblock"><p>Consumes the response returning a new response with body mapped to the |
| return type of the passed in function.</p> |
| <h5 id="examples-16"><a href="#examples-16">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>response = Response::builder().body(<span class="string">"some string"</span>).unwrap(); |
| <span class="kw">let </span>mapped_response: Response<<span class="kw-2">&</span>[u8]> = response.map(|b| { |
| <span class="macro">assert_eq!</span>(b, <span class="string">"some string"</span>); |
| b.as_bytes() |
| }); |
| <span class="macro">assert_eq!</span>(mapped_response.body(), <span class="kw-2">&</span><span class="string">"some string"</span>.as_bytes());</code></pre></div> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Response%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#491-501">source</a><a href="#impl-Debug-for-Response%3CT%3E" class="anchor"></a><h3 class="code-header">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="struct.Response.html" title="struct http::response::Response">Response</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#492-500">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default-for-Response%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#484-489">source</a><a href="#impl-Default-for-Response%3CT%3E" class="anchor"></a><h3 class="code-header">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="struct.Response.html" title="struct http::response::Response">Response</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/http/response.rs.html#486-488">source</a><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> <a class="struct" href="struct.Response.html" title="struct http::response::Response">Response</a><T></h4></section></summary><div class='docblock'>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></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Response%3CT%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Response%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Response.html" title="struct http::response::Response">Response</a><T></h3></section><section id="impl-Send-for-Response%3CT%3E" class="impl has-srclink"><a href="#impl-Send-for-Response%3CT%3E" class="anchor"></a><h3 class="code-header">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="struct.Response.html" title="struct http::response::Response">Response</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></h3></section><section id="impl-Sync-for-Response%3CT%3E" class="impl has-srclink"><a href="#impl-Sync-for-Response%3CT%3E" class="anchor"></a><h3 class="code-header">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="struct.Response.html" title="struct http::response::Response">Response</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></h3></section><section id="impl-Unpin-for-Response%3CT%3E" class="impl has-srclink"><a href="#impl-Unpin-for-Response%3CT%3E" class="anchor"></a><h3 class="code-header">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="struct.Response.html" title="struct http::response::Response">Response</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></h3></section><section id="impl-UnwindSafe-for-Response%3CT%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Response%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Response.html" title="struct http::response::Response">Response</a><T></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Response%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#200">source</a><a href="#impl-Any-for-Response%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#201">source</a><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Response%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211">source</a><a href="#impl-Borrow%3CT%3E-for-Response%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Response%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220">source</a><a href="#impl-BorrowMut%3CT%3E-for-Response%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Response%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#733">source</a><a href="#impl-From%3CT%3E-for-Response%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#736">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Response%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-Response%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Response%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-Response%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#781">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Response%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#760">source</a><a href="#impl-TryInto%3CU%3E-for-Response%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="http" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
