blob: 4bfc68362e5a0f9d55db5a8f027bfc536dea5e79 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/reqwest-0.11.18/src/async_impl/response.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>response.rs - source</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="../../../source-script.js"></script><script defer src="../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../reqwest/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../reqwest/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::borrow::Cow;
<span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::net::SocketAddr;
<span class="kw">use </span>std::pin::Pin;
<span class="kw">use </span>bytes::Bytes;
<span class="kw">use </span>encoding_rs::{Encoding, UTF_8};
<span class="kw">use </span>futures_util::stream::StreamExt;
<span class="kw">use </span>hyper::client::connect::HttpInfo;
<span class="kw">use </span>hyper::{HeaderMap, StatusCode, Version};
<span class="kw">use </span>mime::Mime;
<span class="attribute">#[cfg(feature = <span class="string">&quot;json&quot;</span>)]
</span><span class="kw">use </span>serde::de::DeserializeOwned;
<span class="attribute">#[cfg(feature = <span class="string">&quot;json&quot;</span>)]
</span><span class="kw">use </span>serde_json;
<span class="kw">use </span>tokio::time::Sleep;
<span class="kw">use </span>url::Url;
<span class="kw">use </span><span class="kw">super</span>::body::Body;
<span class="kw">use </span><span class="kw">super</span>::decoder::{Accepts, Decoder};
<span class="attribute">#[cfg(feature = <span class="string">&quot;cookies&quot;</span>)]
</span><span class="kw">use </span><span class="kw">crate</span>::cookie;
<span class="kw">use </span><span class="kw">crate</span>::response::ResponseUrl;
<span class="doccomment">/// A Response to a submitted `Request`.
</span><span class="kw">pub struct </span>Response {
<span class="kw">pub</span>(<span class="kw">super</span>) res: hyper::Response&lt;Decoder&gt;,
<span class="comment">// Boxed to save space (11 words to 1 word), and it&#39;s not accessed
// frequently internally.
</span>url: Box&lt;Url&gt;,
}
<span class="kw">impl </span>Response {
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(
res: hyper::Response&lt;hyper::Body&gt;,
url: Url,
accepts: Accepts,
timeout: <span class="prelude-ty">Option</span>&lt;Pin&lt;Box&lt;Sleep&gt;&gt;&gt;,
) -&gt; Response {
<span class="kw">let </span>(<span class="kw-2">mut </span>parts, body) = res.into_parts();
<span class="kw">let </span>decoder = Decoder::detect(<span class="kw-2">&amp;mut </span>parts.headers, Body::response(body, timeout), accepts);
<span class="kw">let </span>res = hyper::Response::from_parts(parts, decoder);
Response {
res,
url: Box::new(url),
}
}
<span class="doccomment">/// Get the `StatusCode` of this `Response`.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>status(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; StatusCode {
<span class="self">self</span>.res.status()
}
<span class="doccomment">/// Get the HTTP `Version` of this `Response`.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>version(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Version {
<span class="self">self</span>.res.version()
}
<span class="doccomment">/// Get the `Headers` of this `Response`.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>headers(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>HeaderMap {
<span class="self">self</span>.res.headers()
}
<span class="doccomment">/// Get a mutable reference to the `Headers` of this `Response`.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>headers_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>HeaderMap {
<span class="self">self</span>.res.headers_mut()
}
<span class="doccomment">/// Get the content-length of this response, if known.
///
/// Reasons it may not be known:
///
/// - The server didn&#39;t send a `content-length` header.
/// - The response is compressed and automatically decoded (thus changing
/// the actual decoded length).
</span><span class="kw">pub fn </span>content_length(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;u64&gt; {
<span class="kw">use </span>hyper::body::HttpBody;
HttpBody::size_hint(<span class="self">self</span>.res.body()).exact()
}
<span class="doccomment">/// Retrieve the cookies contained in the response.
///
/// Note that invalid &#39;Set-Cookie&#39; headers will be ignored.
///
/// # Optional
///
/// This requires the optional `cookies` feature to be enabled.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;cookies&quot;</span>)]
#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">&quot;cookies&quot;</span>)))]
</span><span class="kw">pub fn </span>cookies&lt;<span class="lifetime">&#39;a</span>&gt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="self">self</span>) -&gt; <span class="kw">impl </span>Iterator&lt;Item = cookie::Cookie&lt;<span class="lifetime">&#39;a</span>&gt;&gt; + <span class="lifetime">&#39;a </span>{
cookie::extract_response_cookies(<span class="self">self</span>.res.headers()).filter_map(Result::ok)
}
<span class="doccomment">/// Get the final `Url` of this `Response`.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>url(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>Url {
<span class="kw-2">&amp;</span><span class="self">self</span>.url
}
<span class="doccomment">/// Get the remote address used to get this `Response`.
</span><span class="kw">pub fn </span>remote_addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;SocketAddr&gt; {
<span class="self">self</span>.res
.extensions()
.get::&lt;HttpInfo&gt;()
.map(|info| info.remote_addr())
}
<span class="doccomment">/// Returns a reference to the associated extensions.
</span><span class="kw">pub fn </span>extensions(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>http::Extensions {
<span class="self">self</span>.res.extensions()
}
<span class="doccomment">/// Returns a mutable reference to the associated extensions.
</span><span class="kw">pub fn </span>extensions_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>http::Extensions {
<span class="self">self</span>.res.extensions_mut()
}
<span class="comment">// body methods
</span><span class="doccomment">/// Get the full response text.
///
/// This method decodes the response body with BOM sniffing
/// and with malformed sequences replaced with the REPLACEMENT CHARACTER.
/// Encoding is determined from the `charset` parameter of `Content-Type` header,
/// and defaults to `utf-8` if not presented.
///
/// # Example
///
/// ```
/// # async fn run() -&gt; Result&lt;(), Box&lt;dyn std::error::Error&gt;&gt; {
/// let content = reqwest::get(&quot;http://httpbin.org/range/26&quot;)
/// .await?
/// .text()
/// .await?;
///
/// println!(&quot;text: {:?}&quot;, content);
/// # Ok(())
/// # }
/// ```
</span><span class="kw">pub async fn </span>text(<span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;String&gt; {
<span class="self">self</span>.text_with_charset(<span class="string">&quot;utf-8&quot;</span>).<span class="kw">await
</span>}
<span class="doccomment">/// Get the full response text given a specific encoding.
///
/// This method decodes the response body with BOM sniffing
/// and with malformed sequences replaced with the REPLACEMENT CHARACTER.
/// You can provide a default encoding for decoding the raw message, while the
/// `charset` parameter of `Content-Type` header is still prioritized. For more information
/// about the possible encoding name, please go to [`encoding_rs`] docs.
///
/// [`encoding_rs`]: https://docs.rs/encoding_rs/0.8/encoding_rs/#relationship-with-windows-code-pages
///
/// # Example
///
/// ```
/// # async fn run() -&gt; Result&lt;(), Box&lt;dyn std::error::Error&gt;&gt; {
/// let content = reqwest::get(&quot;http://httpbin.org/range/26&quot;)
/// .await?
/// .text_with_charset(&quot;utf-8&quot;)
/// .await?;
///
/// println!(&quot;text: {:?}&quot;, content);
/// # Ok(())
/// # }
/// ```
</span><span class="kw">pub async fn </span>text_with_charset(<span class="self">self</span>, default_encoding: <span class="kw-2">&amp;</span>str) -&gt; <span class="kw">crate</span>::Result&lt;String&gt; {
<span class="kw">let </span>content_type = <span class="self">self
</span>.headers()
.get(<span class="kw">crate</span>::header::CONTENT_TYPE)
.and_then(|value| value.to_str().ok())
.and_then(|value| value.parse::&lt;Mime&gt;().ok());
<span class="kw">let </span>encoding_name = content_type
.as_ref()
.and_then(|mime| mime.get_param(<span class="string">&quot;charset&quot;</span>).map(|charset| charset.as_str()))
.unwrap_or(default_encoding);
<span class="kw">let </span>encoding = Encoding::for_label(encoding_name.as_bytes()).unwrap_or(UTF_8);
<span class="kw">let </span>full = <span class="self">self</span>.bytes().<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let </span>(text, <span class="kw">_</span>, <span class="kw">_</span>) = encoding.decode(<span class="kw-2">&amp;</span>full);
<span class="kw">if let </span>Cow::Owned(s) = text {
<span class="kw">return </span><span class="prelude-val">Ok</span>(s);
}
<span class="kw">unsafe </span>{
<span class="comment">// decoding returned Cow::Borrowed, meaning these bytes
// are already valid utf8
</span><span class="prelude-val">Ok</span>(String::from_utf8_unchecked(full.to_vec()))
}
}
<span class="doccomment">/// Try to deserialize the response body as JSON.
///
/// # Optional
///
/// This requires the optional `json` feature enabled.
///
/// # Examples
///
/// ```
/// # extern crate reqwest;
/// # extern crate serde;
/// #
/// # use reqwest::Error;
/// # use serde::Deserialize;
/// #
/// // This `derive` requires the `serde` dependency.
/// #[derive(Deserialize)]
/// struct Ip {
/// origin: String,
/// }
///
/// # async fn run() -&gt; Result&lt;(), Error&gt; {
/// let ip = reqwest::get(&quot;http://httpbin.org/ip&quot;)
/// .await?
/// .json::&lt;Ip&gt;()
/// .await?;
///
/// println!(&quot;ip: {}&quot;, ip.origin);
/// # Ok(())
/// # }
/// #
/// # fn main() { }
/// ```
///
/// # Errors
///
/// This method fails whenever the response body is not in JSON format
/// or it cannot be properly deserialized to target type `T`. For more
/// details please see [`serde_json::from_reader`].
///
/// [`serde_json::from_reader`]: https://docs.serde.rs/serde_json/fn.from_reader.html
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;json&quot;</span>)]
#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">&quot;json&quot;</span>)))]
</span><span class="kw">pub async fn </span>json&lt;T: DeserializeOwned&gt;(<span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;T&gt; {
<span class="kw">let </span>full = <span class="self">self</span>.bytes().<span class="kw">await</span><span class="question-mark">?</span>;
serde_json::from_slice(<span class="kw-2">&amp;</span>full).map_err(<span class="kw">crate</span>::error::decode)
}
<span class="doccomment">/// Get the full response body as `Bytes`.
///
/// # Example
///
/// ```
/// # async fn run() -&gt; Result&lt;(), Box&lt;dyn std::error::Error&gt;&gt; {
/// let bytes = reqwest::get(&quot;http://httpbin.org/ip&quot;)
/// .await?
/// .bytes()
/// .await?;
///
/// println!(&quot;bytes: {:?}&quot;, bytes);
/// # Ok(())
/// # }
/// ```
</span><span class="kw">pub async fn </span>bytes(<span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;Bytes&gt; {
hyper::body::to_bytes(<span class="self">self</span>.res.into_body()).<span class="kw">await
</span>}
<span class="doccomment">/// Stream a chunk of the response body.
///
/// When the response body has been exhausted, this will return `None`.
///
/// # Example
///
/// ```
/// # async fn run() -&gt; Result&lt;(), Box&lt;dyn std::error::Error&gt;&gt; {
/// let mut res = reqwest::get(&quot;https://hyper.rs&quot;).await?;
///
/// while let Some(chunk) = res.chunk().await? {
/// println!(&quot;Chunk: {:?}&quot;, chunk);
/// }
/// # Ok(())
/// # }
/// ```
</span><span class="kw">pub async fn </span>chunk(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;<span class="prelude-ty">Option</span>&lt;Bytes&gt;&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(item) = <span class="self">self</span>.res.body_mut().next().<span class="kw">await </span>{
<span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(item<span class="question-mark">?</span>))
} <span class="kw">else </span>{
<span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>)
}
}
<span class="doccomment">/// Convert the response into a `Stream` of `Bytes` from the body.
///
/// # Example
///
/// ```
/// use futures_util::StreamExt;
///
/// # async fn run() -&gt; Result&lt;(), Box&lt;dyn std::error::Error&gt;&gt; {
/// let mut stream = reqwest::get(&quot;http://httpbin.org/ip&quot;)
/// .await?
/// .bytes_stream();
///
/// while let Some(item) = stream.next().await {
/// println!(&quot;Chunk: {:?}&quot;, item?);
/// }
/// # Ok(())
/// # }
/// ```
///
/// # Optional
///
/// This requires the optional `stream` feature to be enabled.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;stream&quot;</span>)]
#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">&quot;stream&quot;</span>)))]
</span><span class="kw">pub fn </span>bytes_stream(<span class="self">self</span>) -&gt; <span class="kw">impl </span>futures_core::Stream&lt;Item = <span class="kw">crate</span>::Result&lt;Bytes&gt;&gt; {
<span class="self">self</span>.res.into_body()
}
<span class="comment">// util methods
</span><span class="doccomment">/// Turn a response into an error if the server returned an error.
///
/// # Example
///
/// ```
/// # use reqwest::Response;
/// fn on_response(res: Response) {
/// match res.error_for_status() {
/// Ok(_res) =&gt; (),
/// Err(err) =&gt; {
/// // asserting a 400 as an example
/// // it could be any status between 400...599
/// assert_eq!(
/// err.status(),
/// Some(reqwest::StatusCode::BAD_REQUEST)
/// );
/// }
/// }
/// }
/// # fn main() {}
/// ```
</span><span class="kw">pub fn </span>error_for_status(<span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;<span class="self">Self</span>&gt; {
<span class="kw">let </span>status = <span class="self">self</span>.status();
<span class="kw">if </span>status.is_client_error() || status.is_server_error() {
<span class="prelude-val">Err</span>(<span class="kw">crate</span>::error::status_code(<span class="kw-2">*</span><span class="self">self</span>.url, status))
} <span class="kw">else </span>{
<span class="prelude-val">Ok</span>(<span class="self">self</span>)
}
}
<span class="doccomment">/// Turn a reference to a response into an error if the server returned an error.
///
/// # Example
///
/// ```
/// # use reqwest::Response;
/// fn on_response(res: &amp;Response) {
/// match res.error_for_status_ref() {
/// Ok(_res) =&gt; (),
/// Err(err) =&gt; {
/// // asserting a 400 as an example
/// // it could be any status between 400...599
/// assert_eq!(
/// err.status(),
/// Some(reqwest::StatusCode::BAD_REQUEST)
/// );
/// }
/// }
/// }
/// # fn main() {}
/// ```
</span><span class="kw">pub fn </span>error_for_status_ref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">crate</span>::Result&lt;<span class="kw-2">&amp;</span><span class="self">Self</span>&gt; {
<span class="kw">let </span>status = <span class="self">self</span>.status();
<span class="kw">if </span>status.is_client_error() || status.is_server_error() {
<span class="prelude-val">Err</span>(<span class="kw">crate</span>::error::status_code(<span class="kw-2">*</span><span class="self">self</span>.url.clone(), status))
} <span class="kw">else </span>{
<span class="prelude-val">Ok</span>(<span class="self">self</span>)
}
}
<span class="comment">// private
// The Response&#39;s body is an implementation detail.
// You no longer need to get a reference to it, there are async methods
// on the `Response` itself.
//
// This method is just used by the blocking API.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;blocking&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>body_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>Decoder {
<span class="self">self</span>.res.body_mut()
}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Response {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
f.debug_struct(<span class="string">&quot;Response&quot;</span>)
.field(<span class="string">&quot;url&quot;</span>, <span class="self">self</span>.url())
.field(<span class="string">&quot;status&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.status())
.field(<span class="string">&quot;headers&quot;</span>, <span class="self">self</span>.headers())
.finish()
}
}
<span class="kw">impl</span>&lt;T: Into&lt;Body&gt;&gt; From&lt;http::Response&lt;T&gt;&gt; <span class="kw">for </span>Response {
<span class="kw">fn </span>from(r: http::Response&lt;T&gt;) -&gt; Response {
<span class="kw">let </span>(<span class="kw-2">mut </span>parts, body) = r.into_parts();
<span class="kw">let </span>body = body.into();
<span class="kw">let </span>decoder = Decoder::detect(<span class="kw-2">&amp;mut </span>parts.headers, body, Accepts::none());
<span class="kw">let </span>url = parts
.extensions
.remove::&lt;ResponseUrl&gt;()
.unwrap_or_else(|| ResponseUrl(Url::parse(<span class="string">&quot;http://no.url.provided.local&quot;</span>).unwrap()));
<span class="kw">let </span>url = url.<span class="number">0</span>;
<span class="kw">let </span>res = hyper::Response::from_parts(parts, decoder);
Response {
res,
url: Box::new(url),
}
}
}
<span class="doccomment">/// A `Response` can be piped as the `Body` of another request.
</span><span class="kw">impl </span>From&lt;Response&gt; <span class="kw">for </span>Body {
<span class="kw">fn </span>from(r: Response) -&gt; Body {
Body::stream(r.res.into_body())
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::Response;
<span class="kw">use </span><span class="kw">crate</span>::ResponseBuilderExt;
<span class="kw">use </span>http::response::Builder;
<span class="kw">use </span>url::Url;
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_from_http_response() {
<span class="kw">let </span>url = Url::parse(<span class="string">&quot;http://example.com&quot;</span>).unwrap();
<span class="kw">let </span>response = Builder::new()
.status(<span class="number">200</span>)
.url(url.clone())
.body(<span class="string">&quot;foo&quot;</span>)
.unwrap();
<span class="kw">let </span>response = Response::from(response);
<span class="macro">assert_eq!</span>(response.status(), <span class="number">200</span>);
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>response.url(), url);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="reqwest" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>