[−][src]Struct reqwest::Response
A Response to a submitted Request
.
Methods
impl Response
[src]
pub fn status(&self) -> StatusCode
[src]
Get the StatusCode
of this Response
.
pub fn version(&self) -> Version
[src]
Get the HTTP Version
of this Response
.
pub fn headers(&self) -> &HeaderMap
[src]
Get the Headers
of this Response
.
pub fn headers_mut(&mut self) -> &mut HeaderMap
[src]
Get a mutable reference to the Headers
of this Response
.
pub fn content_length(&self) -> Option<u64>
[src]
Get the content-length of this response, if known.
Reasons it may not be known:
- The server didn't send a
content-length
header. - The response is gzipped and automatically decoded (thus changing the actual decoded length).
pub fn cookies<'a>(&'a self) -> impl Iterator<Item = Cookie<'a>> + 'a
[src]
Retrieve the cookies contained in the response.
Note that invalid 'Set-Cookie' headers will be ignored.
Optional
This requires the optional cookies
feature to be enabled.
pub fn url(&self) -> &Url
[src]
Get the final Url
of this Response
.
pub fn remote_addr(&self) -> Option<SocketAddr>
[src]
Get the remote address used to get this Response
.
pub async fn text(self) -> Result<String>
[src]
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 determinated from the charset
parameter of Content-Type
header,
and defaults to utf-8
if not presented.
Example
let content = reqwest::get("http://httpbin.org/range/26") .await? .text() .await?; println!("text: {:?}", content);
pub async fn text_with_charset<'_>(
self,
default_encoding: &'_ str
) -> Result<String>
[src]
self,
default_encoding: &'_ str
) -> Result<String>
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.
Example
let content = reqwest::get("http://httpbin.org/range/26") .await? .text_with_charset("utf-8") .await?; println!("text: {:?}", content);
pub async fn json<T: DeserializeOwned>(self) -> Result<T>
[src]
Try to deserialize the response body as JSON.
Optional
This requires the optional json
feature enabled.
Examples
#[derive(Deserialize)] struct Ip { origin: String, } let ip = reqwest::get("http://httpbin.org/ip") .await? .json::<Ip>() .await?; println!("ip: {}", ip.origin);
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
.
pub async fn bytes(self) -> Result<Bytes>
[src]
Get the full response body as Bytes
.
Example
let bytes = reqwest::get("http://httpbin.org/ip") .await? .bytes() .await?; println!("bytes: {:?}", bytes);
pub async fn chunk<'_>(&'_ mut self) -> Result<Option<Bytes>>
[src]
Stream a chunk of the response body.
When the response body has been exhausted, this will return None
.
Example
let mut res = reqwest::get("https://hyper.rs").await?; while let Some(chunk) = res.chunk().await? { println!("Chunk: {:?}", chunk); }
pub fn error_for_status(self) -> Result<Self>
[src]
Turn a response into an error if the server returned an error.
Example
fn on_response(res: Response) { match res.error_for_status() { Ok(_res) => (), Err(err) => { // asserting a 400 as an example // it could be any status between 400...599 assert_eq!( err.status(), Some(reqwest::StatusCode::BAD_REQUEST) ); } } }
pub fn error_for_status_ref(&self) -> Result<&Self>
[src]
Turn a reference to a response into an error if the server returned an error.
Example
fn on_response(res: &Response) { match res.error_for_status_ref() { Ok(_res) => (), Err(err) => { // asserting a 400 as an example // it could be any status between 400...599 assert_eq!( err.status(), Some(reqwest::StatusCode::BAD_REQUEST) ); } } }
Trait Implementations
impl<T: Into<Body>> From<Response<T>> for Response
[src]
impl From<Response> for Body
[src]
A Response
can be piped as the Body
of another request.
impl Debug for Response
[src]
Auto Trait Implementations
impl Send for Response
impl Sync for Response
impl Unpin for Response
impl !UnwindSafe for Response
impl !RefUnwindSafe for Response
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,