Struct reqwest::async::Response

source · [−]

pub struct Response { /* private fields */ }

Expand description

A Response to a submitted Request.

Implementations

source

impl Response

source

pub fn status(&self) -> StatusCode

Get the StatusCode of this Response.

source

pub fn headers(&self) -> &HeaderMap

Get the Headers of this Response.

source

pub fn headers_mut(&mut self) -> &mut HeaderMap

Get a mutable reference to the Headers of this Response.

source

pub fn cookies<'a>(&'a self) -> impl Iterator<Item = Cookie<'a>> + 'a

Retrieve the cookies contained in the response.

Note that invalid ‘Set-Cookie’ headers will be ignored.

source

pub fn url(&self) -> &Url

Get the final Url of this Response.

source

pub fn remote_addr(&self) -> Option<SocketAddr>

Get the remote address used to get this Response.

source

pub fn content_length(&self) -> Option<u64>

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).

source

pub fn into_body(self) -> Decoder

Consumes the response, returning the body

source

pub fn body(&self) -> &Decoder

Get a reference to the response body.

source

pub fn body_mut(&mut self) -> &mut Decoder

Get a mutable reference to the response body.

The chunks from the body may be decoded, depending on the gzip option on the ClientBuilder.

source

pub fn version(&self) -> Version

Get the HTTP Version of this Response.

source

pub fn text(&mut self) -> impl Future<Item = String, Error = Error>

Get the response text

source

pub fn text_with_charset(
&mut self,
default_encoding: &str
) -> impl Future<Item = String, Error = Error>

Get the response text given a specific encoding

source

pub fn json<T: DeserializeOwned>(
&mut self
) -> impl Future<Item = T, Error = Error>

Try to deserialize the response body as JSON using serde.

source

pub fn error_for_status(self) -> Result<Self>

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)
            );
        }
    }
}

source

pub fn error_for_status_ref(&self) -> Result<&Self>

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)
            );
        }
    }
}