Get the StatusCode of this Response.

Get the HTTP Version of this Response.

Get the Headers of this Response.

Get a mutable reference to the Headers of this Response.

Get the content length of the response, if it is known.

This value does not directly represents the value of the Content-Length header, but rather the size of the response's body. To read the header's value, please use the Response::headers method instead.

Reasons it may not be known:

• The response does not include a body (e.g. it responds to a HEAD request).
• The response is gzipped and automatically decoded (thus changing the actual decoded length).

Get the final Url of this Response.

Get the remote address used to get this Response.

Returns a reference to the associated extensions.

Returns a mutable reference to the associated extensions.

Get the full response text.

This method decodes the response body with BOM sniffing and with malformed sequences replaced with the char::REPLACEMENT_CHARACTER. Encoding is determined from the charset parameter of Content-Type header, and defaults to utf-8 if not presented.

Note that the BOM is stripped from the returned String.

Note

If the charset feature is disabled the method will only attempt to decode the response as UTF-8, regardless of the given Content-Type

Example

# async fn run() -> Result<(), Box<dyn std::error::Error>> {
let content = reqwest::get("http://httpbin.org/range/26")
    .await?
    .text()
    .await?;

println!("text: {content:?}");
# Ok(())
# }

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 char::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.

Note that the BOM is stripped from the returned String.

Optional

This requires the optional encoding_rs feature enabled.

Example

# async fn run() -> Result<(), Box<dyn std::error::Error>> {
let content = reqwest::get("http://httpbin.org/range/26")
    .await?
    .text_with_charset("utf-8")
    .await?;

println!("text: {content:?}");
# Ok(())
# }

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() -> Result<(), Error> {
let ip = reqwest::get("http://httpbin.org/ip")
    .await?
    .json::<Ip>()
    .await?;

println!("ip: {}", 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.

Get the full response body as Bytes.

Example

# async fn run() -> Result<(), Box<dyn std::error::Error>> {
let bytes = reqwest::get("http://httpbin.org/ip")
    .await?
    .bytes()
    .await?;

println!("bytes: {bytes:?}");
# Ok(())
# }

Stream a chunk of the response body.

When the response body has been exhausted, this will return None.

Example

# async fn run() -> Result<(), Box<dyn std::error::Error>> {
let mut res = reqwest::get("https://hyper.rs").await?;

while let Some(chunk) = res.chunk().await? {
    println!("Chunk: {chunk:?}");
}
# Ok(())
# }

Convert the response into a Stream of Bytes from the body.

Example

use futures_util::StreamExt;

# async fn run() -> Result<(), Box<dyn std::error::Error>> {
let mut stream = reqwest::get("http://httpbin.org/ip")
    .await?
    .bytes_stream();

while let Some(item) = stream.next().await {
    println!("Chunk: {:?}", item?);
}
# Ok(())
# }

Optional

This requires the optional stream feature to be enabled.

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) => (),
        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)
            );
        }
    }
}
# fn main() {}

Turn a reference to 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_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)
            );
        }
    }
}
# fn main() {}

Consumes the response and returns a future for a possible HTTP upgrade.