Struct surf::Response

pub struct Response { /* fields omitted */ }

An HTTP response, returned by Request.

Methods

impl Response

pub fn status(&self) -> StatusCode

Get the HTTP status code.

Examples

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

pub fn version(&self) -> Version

Get the HTTP protocol version.

Examples

use surf::http::version::Version;

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

pub fn header(&self, key: &'static str) -> Option<&str>

Get a header.

Examples

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

pub fn headers(&mut self) -> Headers

Get all headers.

Examples

let mut res = surf::post("https://httpbin.org/get").await?;
for (name, value) in res.headers() {
    println!("{}: {}", name, value);
}

pub fn mime(&self) -> Option<Mime>

Get the request 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::mime;
let res = surf::get("https://httpbin.org/json").await?;
assert_eq!(res.mime(), Some(mime::APPLICATION_JSON));

pub async fn body_bytes<'_>(&'_ mut self) -> Result<Vec<u8>>

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?;

pub async fn body_string<'_>(&'_ mut self) -> Result<String, Exception>

Reads the entire request body into a string.

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.

If the body cannot be interpreted as valid UTF-8, an Err is returned.

Examples

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

pub async fn body_json<'_, T: DeserializeOwned>(&'_ mut self) -> Result<T>

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?;

pub async fn body_form<'_, T: DeserializeOwned>(
    &'_ mut self
) -> Result<T, Exception>

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?;

Trait Implementations

impl Debug for Response

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl AsyncRead for Response

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context,
    bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.