Struct crimp::Response

pub struct Response<T> {
    pub status: u32,
    pub headers: HashMap<String, String>,
    pub body: T,
}

HTTP responses structure containing response data and headers.

By default the send() function of the Request structure will return a Response<Vec<u8>>. Convenience helpers exist for decoding a string via Response::as_string or to a serde-compatible type with Response::as_json (if the json-feature is enabled).

Fields

status: u32

HTTP status code of the response.

headers: HashMap<String, String>

HTTP headers returned from the remote.

body: T

Body data from the HTTP response.

Methods

impl<T> Response<T>

pub fn is_success(&self) -> bool

Check whether the status code of this HTTP response is a success (i.e. in the 200-299 range).

pub fn error_for_status<F, E>(self, closure: F) -> Result<Self, E> where
    F: FnOnce(Self) -> E, 

Check whether a request succeeded using Request::is_success and let users provide a closure that creates a custom error from the request if it did not.

This function exists for convenience to avoid having to write repetitive if !response.is_success() { ... } blocks.

impl Response<Vec<u8>>

pub fn as_string(self) -> Result<Response<String>, FromUtf8Error>

Attempt to parse the HTTP response body as a UTF-8 encoded string.

pub fn as_json<T: DeserializeOwned>(self) -> Result<Response<T>, Error>

Attempt to deserialize the HTTP response body from JSON.

Trait Implementations

impl<T: PartialEq> PartialEq<Response<T>> for Response<T>

fn eq(&self, other: &Response<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Response<T>) -> bool

This method tests for !=.

impl<T: Debug> Debug for Response<T>

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

Formats the value using the given formatter.