Struct Response Copy item path

Get the HTTP status code.

§Examples

let res = surf::get("https://httpbin.org/get").await?;
assert_eq!(res.status(), 200);

Get the HTTP protocol version.

§Examples

use surf::http::Version;

let res = surf::get("https://httpbin.org/get").await?;
assert_eq!(res.version(), Some(Version::Http1_1));

Get a header.

§Examples

let res = surf::get("https://httpbin.org/get").await?;
assert!(res.header("Content-Length").is_some());

Get an HTTP header mutably.

Remove a header.

Insert an HTTP header.

Append an HTTP header.

An iterator visiting all header pairs in arbitrary order.

An iterator visiting all header pairs in arbitrary order, with mutable references to the values.

An iterator visiting all header names in arbitrary order.

An iterator visiting all header values in arbitrary order.

Get a response scoped extension value.

Set a response scoped extension value.

Get the response content type as a Mime.

Gets the Content-Type header and parses it to a Mime type.

Read more on MDN

§Panics

This method will panic if an invalid MIME type was set as a header.

§Examples

use surf::http::mime;
let res = surf::get("https://httpbin.org/json").await?;
assert_eq!(res.content_type(), Some(mime::JSON));

Get the length of the body stream, if it has been set.

This value is set when passing a fixed-size object into as the body. E.g. a string, or a buffer. Consumers of this API should check this value to decide whether to use Chunked encoding, or set the response length.

Returns true if the set length of the body stream is zero, false otherwise.

Set the body reader.

Take the response body as a Body.

This method can be called after the body has already been taken or read, but will return an empty Body.

Useful for adjusting the whole body, such as in middleware.

Swaps the value of the body with another body, without deinitializing either one.

Reads the entire request body into a byte buffer.

This method can be called after the body has already been read, but will produce an empty buffer.

§Errors

Any I/O error encountered while reading the body is immediately returned as an Err.

§Examples

let mut res = surf::get("https://httpbin.org/get").await?;
let bytes: Vec<u8> = res.body_bytes().await?;

Reads the entire response body into a string.

This method can be called after the body has already been read, but will produce an empty buffer.

§Encodings

If the “encoding” feature is enabled, this method tries to decode the body with the encoding that is specified in the Content-Type header. If the header does not specify an encoding, UTF-8 is assumed. If the “encoding” feature is disabled, Surf only supports reading UTF-8 response bodies. The “encoding” feature is enabled by default.

§Errors

Any I/O error encountered while reading the body is immediately returned as an Err.

If the body cannot be interpreted because the encoding is unsupported or incorrect, an Err is returned.

§Examples

let mut res = surf::get("https://httpbin.org/get").await?;
let string: String = res.body_string().await?;

Reads and deserialized the entire request body from json.

§Errors

Any I/O error encountered while reading the body is immediately returned as an Err.

If the body cannot be interpreted as valid json for the target type T, an Err is returned.

§Examples

#[derive(Deserialize, Serialize)]
struct Ip {
    ip: String
}

let mut res = surf::get("https://api.ipify.org?format=json").await?;
let Ip { ip } = res.body_json().await?;

Reads and deserialized the entire request body from form encoding.

§Errors

Any I/O error encountered while reading the body is immediately returned as an Err.

If the body cannot be interpreted as valid json for the target type T, an Err is returned.

§Examples

#[derive(Deserialize, Serialize)]
struct Body {
    apples: u32
}

let mut res = surf::get("https://api.example.com/v1/response").await?;
let Body { apples } = res.body_form().await?;

Returns a reference to the value corresponding to the supplied name.

§Panics

Panics if the name is not present in Response.

Returns a reference to the value corresponding to the supplied name.

§Panics

Panics if the name is not present in Response.

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.