mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 04:35:18 +01:00
203 lines
58 KiB
HTML
203 lines
58 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="Represents an HTTP response"><title>Response in hyper - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="hyper" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../hyper/index.html">hyper</a><span class="version">0.14.27</span></h2></div><h2 class="location"><a href="#">Response</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.body">body</a></li><li><a href="#method.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 trait-implementation"><li><a href="#impl-Body-for-Response%3CB%3E">Body</a></li><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 synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-Response%3CT%3E">!RefUnwindSafe</a></li><li><a href="#impl-UnwindSafe-for-Response%3CT%3E">!UnwindSafe</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></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T">From<T></a></li><li><a href="#impl-Instrument-for-T">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-T">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto<U></a></li><li><a href="#impl-WithSubscriber-for-T">WithSubscriber</a></li></ul></section><h2><a href="index.html">In crate hyper</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../hyper/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="index.html">hyper</a>::<wbr><a class="struct" href="#">Response</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/http/response.rs.html#179">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct Response<T> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>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="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Response%3C()%3E" class="impl"><a class="src rightside" href="../src/http/response.rs.html#213">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 hyper::Response">Response</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.builder" class="method"><a class="src rightside" href="../src/http/response.rs.html#230">source</a><h4 class="code-header">pub fn <a href="#method.builder" class="fn">builder</a>() -> <a class="struct" href="../http/response/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="toggle implementors-toggle" open><summary><section id="impl-Response%3CT%3E" class="impl"><a class="src rightside" href="../src/http/response.rs.html#235">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 hyper::Response">Response</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/http/response.rs.html#251">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(body: T) -> <a class="struct" href="struct.Response.html" title="struct hyper::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="toggle method-toggle" open><summary><section id="method.from_parts" class="method"><a class="src rightside" href="../src/http/response.rs.html#274">source</a><h4 class="code-header">pub fn <a href="#method.from_parts" class="fn">from_parts</a>(parts: <a class="struct" href="../http/response/struct.Parts.html" title="struct http::response::Parts">Parts</a>, body: T) -> <a class="struct" href="struct.Response.html" title="struct hyper::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="toggle method-toggle" open><summary><section id="method.status" class="method"><a class="src rightside" href="../src/http/response.rs.html#291">source</a><h4 class="code-header">pub fn <a href="#method.status" class="fn">status</a>(&self) -> <a class="struct" href="struct.StatusCode.html" title="struct hyper::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="toggle method-toggle" open><summary><section id="method.status_mut" class="method"><a class="src rightside" href="../src/http/response.rs.html#306">source</a><h4 class="code-header">pub fn <a href="#method.status_mut" class="fn">status_mut</a>(&mut self) -> &mut <a class="struct" href="struct.StatusCode.html" title="struct hyper::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="toggle method-toggle" open><summary><section id="method.version" class="method"><a class="src rightside" href="../src/http/response.rs.html#320">source</a><h4 class="code-header">pub fn <a href="#method.version" class="fn">version</a>(&self) -> <a class="struct" href="struct.Version.html" title="struct hyper::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="toggle method-toggle" open><summary><section id="method.version_mut" class="method"><a class="src rightside" href="../src/http/response.rs.html#335">source</a><h4 class="code-header">pub fn <a href="#method.version_mut" class="fn">version_mut</a>(&mut self) -> &mut <a class="struct" href="struct.Version.html" title="struct hyper::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="toggle method-toggle" open><summary><section id="method.headers" class="method"><a class="src rightside" href="../src/http/response.rs.html#349">source</a><h4 class="code-header">pub fn <a href="#method.headers" class="fn">headers</a>(&self) -> &<a class="struct" href="header/struct.HeaderMap.html" title="struct hyper::header::HeaderMap">HeaderMap</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="toggle method-toggle" open><summary><section id="method.headers_mut" class="method"><a class="src rightside" href="../src/http/response.rs.html#365">source</a><h4 class="code-header">pub fn <a href="#method.headers_mut" class="fn">headers_mut</a>(&mut self) -> &mut <a class="struct" href="header/struct.HeaderMap.html" title="struct hyper::header::HeaderMap">HeaderMap</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="toggle method-toggle" open><summary><section id="method.extensions" class="method"><a class="src rightside" href="../src/http/response.rs.html#379">source</a><h4 class="code-header">pub fn <a href="#method.extensions" class="fn">extensions</a>(&self) -> &<a class="struct" href="../http/extensions/struct.Extensions.html" title="struct http::extensions::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="toggle method-toggle" open><summary><section id="method.extensions_mut" class="method"><a class="src rightside" href="../src/http/response.rs.html#395">source</a><h4 class="code-header">pub fn <a href="#method.extensions_mut" class="fn">extensions_mut</a>(&mut self) -> &mut <a class="struct" href="../http/extensions/struct.Extensions.html" title="struct http::extensions::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="toggle method-toggle" open><summary><section id="method.body" class="method"><a class="src rightside" href="../src/http/response.rs.html#409">source</a><h4 class="code-header">pub fn <a href="#method.body" class="fn">body</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&T</a></h4></section></summary><div class="docblock"><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="toggle method-toggle" open><summary><section id="method.body_mut" class="method"><a class="src rightside" href="../src/http/response.rs.html#424">source</a><h4 class="code-header">pub fn <a href="#method.body_mut" class="fn">body_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class="docblock"><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="toggle method-toggle" open><summary><section id="method.into_body" class="method"><a class="src rightside" href="../src/http/response.rs.html#439">source</a><h4 class="code-header">pub fn <a href="#method.into_body" class="fn">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="toggle method-toggle" open><summary><section id="method.into_parts" class="method"><a class="src rightside" href="../src/http/response.rs.html#454">source</a><h4 class="code-header">pub fn <a href="#method.into_parts" class="fn">into_parts</a>(self) -> (<a class="struct" href="../http/response/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="toggle method-toggle" open><summary><section id="method.map" class="method"><a class="src rightside" href="../src/http/response.rs.html#473-475">source</a><h4 class="code-header">pub fn <a href="#method.map" class="fn">map</a><F, U>(self, f: F) -> <a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><U><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(T) -> U,</div></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="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Body-for-Response%3CB%3E" class="impl"><a class="src rightside" href="../src/http_body/lib.rs.html#256">source</a><a href="#impl-Body-for-Response%3CB%3E" class="anchor">§</a><h3 class="code-header">impl<B> <a class="trait" href="body/trait.HttpBody.html" title="trait hyper::body::HttpBody">Body</a> for <a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><B><div class="where">where
|
||
B: <a class="trait" href="body/trait.HttpBody.html" title="trait hyper::body::HttpBody">Body</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Data" class="associatedtype trait-impl"><a href="#associatedtype.Data" class="anchor">§</a><h4 class="code-header">type <a href="body/trait.HttpBody.html#associatedtype.Data" class="associatedtype">Data</a> = <B as <a class="trait" href="body/trait.HttpBody.html" title="trait hyper::body::HttpBody">Body</a>>::<a class="associatedtype" href="body/trait.HttpBody.html#associatedtype.Data" title="type hyper::body::HttpBody::Data">Data</a></h4></section></summary><div class='docblock'>Values yielded by the <code>Body</code>.</div></details><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="body/trait.HttpBody.html#associatedtype.Error" class="associatedtype">Error</a> = <B as <a class="trait" href="body/trait.HttpBody.html" title="trait hyper::body::HttpBody">Body</a>>::<a class="associatedtype" href="body/trait.HttpBody.html#associatedtype.Error" title="type hyper::body::HttpBody::Error">Error</a></h4></section></summary><div class='docblock'>The error type this <code>Body</code> might generate.</div></details><details class="toggle method-toggle" open><summary><section id="method.poll_data" class="method trait-impl"><a class="src rightside" href="../src/http_body/lib.rs.html#260-263">source</a><a href="#method.poll_data" class="anchor">§</a><h4 class="code-header">fn <a href="body/trait.HttpBody.html#tymethod.poll_data" class="fn">poll_data</a>(
|
||
self: <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut <a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><B>>,
|
||
cx: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<<a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><B> as <a class="trait" href="body/trait.HttpBody.html" title="trait hyper::body::HttpBody">Body</a>>::<a class="associatedtype" href="body/trait.HttpBody.html#associatedtype.Data" title="type hyper::body::HttpBody::Data">Data</a>, <<a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><B> as <a class="trait" href="body/trait.HttpBody.html" title="trait hyper::body::HttpBody">Body</a>>::<a class="associatedtype" href="body/trait.HttpBody.html#associatedtype.Error" title="type hyper::body::HttpBody::Error">Error</a>>>></h4></section></summary><div class='docblock'>Attempt to pull out the next data buffer of this stream.</div></details><details class="toggle method-toggle" open><summary><section id="method.poll_trailers" class="method trait-impl"><a class="src rightside" href="../src/http_body/lib.rs.html#270-273">source</a><a href="#method.poll_trailers" class="anchor">§</a><h4 class="code-header">fn <a href="body/trait.HttpBody.html#tymethod.poll_trailers" class="fn">poll_trailers</a>(
|
||
self: <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut <a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><B>>,
|
||
cx: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="header/struct.HeaderMap.html" title="struct hyper::header::HeaderMap">HeaderMap</a>>, <<a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><B> as <a class="trait" href="body/trait.HttpBody.html" title="trait hyper::body::HttpBody">Body</a>>::<a class="associatedtype" href="body/trait.HttpBody.html#associatedtype.Error" title="type hyper::body::HttpBody::Error">Error</a>>></h4></section></summary><div class='docblock'>Poll for an optional <strong>single</strong> <code>HeaderMap</code> of trailers. <a href="body/trait.HttpBody.html#tymethod.poll_trailers">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.is_end_stream" class="method trait-impl"><a class="src rightside" href="../src/http_body/lib.rs.html#280">source</a><a href="#method.is_end_stream" class="anchor">§</a><h4 class="code-header">fn <a href="body/trait.HttpBody.html#method.is_end_stream" class="fn">is_end_stream</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Returns <code>true</code> when the end of stream has been reached. <a href="body/trait.HttpBody.html#method.is_end_stream">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.size_hint" class="method trait-impl"><a class="src rightside" href="../src/http_body/lib.rs.html#284">source</a><a href="#method.size_hint" class="anchor">§</a><h4 class="code-header">fn <a href="body/trait.HttpBody.html#method.size_hint" class="fn">size_hint</a>(&self) -> <a class="struct" href="body/struct.SizeHint.html" title="struct hyper::body::SizeHint">SizeHint</a></h4></section></summary><div class='docblock'>Returns the bounds on the remaining length of the stream. <a href="body/trait.HttpBody.html#method.size_hint">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.map_data" class="method trait-impl"><a class="src rightside" href="../src/http_body/lib.rs.html#103-107">source</a><a href="#method.map_data" class="anchor">§</a><h4 class="code-header">fn <a href="body/trait.HttpBody.html#method.map_data" class="fn">map_data</a><F, B>(self, f: F) -> <a class="struct" href="../http_body/combinators/map_data/struct.MapData.html" title="struct http_body::combinators::map_data::MapData">MapData</a><Self, F><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="associatedtype" href="body/trait.HttpBody.html#associatedtype.Data" title="type hyper::body::HttpBody::Data">Data</a>) -> B,
|
||
B: <a class="trait" href="body/trait.Buf.html" title="trait hyper::body::Buf">Buf</a>,</div></h4></section></summary><div class='docblock'>Maps this body’s data value to a different value.</div></details><details class="toggle method-toggle" open><summary><section id="method.map_err" class="method trait-impl"><a class="src rightside" href="../src/http_body/lib.rs.html#113-116">source</a><a href="#method.map_err" class="anchor">§</a><h4 class="code-header">fn <a href="body/trait.HttpBody.html#method.map_err" class="fn">map_err</a><F, E>(self, f: F) -> <a class="struct" href="../http_body/combinators/map_err/struct.MapErr.html" title="struct http_body::combinators::map_err::MapErr">MapErr</a><Self, F><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="associatedtype" href="body/trait.HttpBody.html#associatedtype.Error" title="type hyper::body::HttpBody::Error">Error</a>) -> E,</div></h4></section></summary><div class='docblock'>Maps this body’s error value to a different value.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Response%3CT%3E" class="impl"><a class="src rightside" href="../src/http/response.rs.html#491">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/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/http/response.rs.html#492">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-Response%3CT%3E" class="impl"><a class="src rightside" href="../src/http/response.rs.html#484">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/1.76.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../src/http/response.rs.html#486">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> <a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><T></h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Response%3CT%3E" class="impl"><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/1.76.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><T></h3></section><section id="impl-Send-for-Response%3CT%3E" class="impl"><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/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-Response%3CT%3E" class="impl"><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/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-Response%3CT%3E" class="impl"><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/1.76.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-Response%3CT%3E" class="impl"><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/1.76.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Response.html" title="struct hyper::Response">Response</a><T></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.76.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#763">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#766">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Instrument-for-T" class="impl"><a class="src rightside" href="../src/tracing/instrument.rs.html#325">source</a><a href="#impl-Instrument-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl"><a class="src rightside" href="../src/tracing/instrument.rs.html#86">source</a><a href="#method.instrument" class="anchor">§</a><h4 class="code-header">fn <a href="../tracing/instrument/trait.Instrument.html#method.instrument" class="fn">instrument</a>(self, span: <a class="struct" href="../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><div class='docblock'>Instruments this type with the provided <a href="../tracing/span/struct.Span.html" title="struct tracing::span::Span"><code>Span</code></a>, returning an
|
||
<code>Instrumented</code> wrapper. <a href="../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl"><a class="src rightside" href="../src/tracing/instrument.rs.html#128">source</a><a href="#method.in_current_span" class="anchor">§</a><h4 class="code-header">fn <a href="../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fn">in_current_span</a>(self) -> <a class="struct" href="../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><div class='docblock'>Instruments this type with the <a href="../tracing/span/struct.Span.html#method.current" title="associated function tracing::span::Span::current">current</a> <a href="../tracing/span/struct.Span.html" title="struct tracing::span::Span"><code>Span</code></a>, returning an
|
||
<code>Instrumented</code> wrapper. <a href="../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#747-749">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#756">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#803-805">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-2" class="associatedtype trait-impl"><a href="#associatedtype.Error-2" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#810">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#788-790">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#795">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-WithSubscriber-for-T" class="impl"><a class="src rightside" href="../src/tracing/instrument.rs.html#393">source</a><a href="#impl-WithSubscriber-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="../tracing/instrument/trait.WithSubscriber.html" title="trait tracing::instrument::WithSubscriber">WithSubscriber</a> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.with_subscriber" class="method trait-impl"><a class="src rightside" href="../src/tracing/instrument.rs.html#176-178">source</a><a href="#method.with_subscriber" class="anchor">§</a><h4 class="code-header">fn <a href="../tracing/instrument/trait.WithSubscriber.html#method.with_subscriber" class="fn">with_subscriber</a><S>(self, subscriber: S) -> <a class="struct" href="../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self><div class="where">where
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../tracing_core/dispatcher/struct.Dispatch.html" title="struct tracing_core::dispatcher::Dispatch">Dispatch</a>>,</div></h4></section></summary><div class='docblock'>Attaches the provided <a href="../tracing_core/subscriber/trait.Subscriber.html" title="trait tracing_core::subscriber::Subscriber"><code>Subscriber</code></a> to this type, returning a
|
||
<a href="../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="../tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl"><a class="src rightside" href="../src/tracing/instrument.rs.html#228">source</a><a href="#method.with_current_subscriber" class="anchor">§</a><h4 class="code-header">fn <a href="../tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber" class="fn">with_current_subscriber</a>(self) -> <a class="struct" href="../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><div class='docblock'>Attaches the current <a href="../tracing/dispatcher/index.html#setting-the-default-subscriber" title="mod tracing::dispatcher">default</a> <a href="../tracing_core/subscriber/trait.Subscriber.html" title="trait tracing_core::subscriber::Subscriber"><code>Subscriber</code></a> to this type, returning a
|
||
<a href="../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="../tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber">Read more</a></div></details></div></details></div></section></div></main></body></html> |