Struct Response 

pub struct Response { /* private fields */ }

HTTP response wrapper.

The full body is already buffered in memory as Bytes when you receive this type. Methods named into_* perform parsing synchronously; the async counterparts (text, json, …) delegate to into_* without additional I/O and exist for ergonomics in async code (e.g. RequestBuilder::send_json). Prefer into_json, into_text, and into_bytes_checked on hot paths.

This model suits typical JSON APIs. For large or chunked bodies, use StreamingResponse via send_stream.

Implementations

impl Response

pub fn status(&self) -> StatusCode

HTTP status code.

pub fn headers(&self) -> &HeaderMap

Response headers.

pub fn bytes(&self) -> &Bytes

Returns a reference to the fully buffered response body.

pub fn url(&self) -> Option<&Url>

Final request URL when available.

pub fn is_success(&self) -> bool

Returns true for 2xx status codes.

pub fn error_for_status(&self) -> Result<(), Error>

Returns an error if the status is not success.

pub fn into_text(self) -> Result<String, Error>

Reads the body as UTF-8 after checking for a success status.

Prefer this over text when you do not need an .await (no extra I/O).

pub async fn text(self) -> Result<String, Error>

Async alias for into_text; does not perform additional I/O.

pub fn into_bytes_checked(self) -> Result<Bytes, Error>

Returns the body after checking for a success status.

Prefer this over bytes_checked on hot paths.

pub async fn bytes_checked(self) -> Result<Bytes, Error>

Async alias for into_bytes_checked.

pub fn into_json<T>(self) -> Result<T, Error>

where T: DeserializeOwned,

Deserializes JSON after checking for a success status, using the client or request JsonParserFn when configured.

Prefer this over json on hot paths. See crate::json_parser for the default single-step path vs a custom two-step parser.

pub async fn json<T>(self) -> Result<T, Error>

where T: DeserializeOwned,

Async alias for into_json.

pub fn into_json_with<T, F>(self, parse: F) -> Result<T, Error>

where T: DeserializeOwned, F: FnOnce(&Bytes) -> Result<T, String>,

Deserializes JSON in one step with a custom closure (Bytes → T).

Ignores any client- or request-level JsonParserFn. Use this for BOM stripping or other transforms without the Value intermediate required by ClientBuilder::json_parser.

pub async fn json_with<T, F>(self, parse: F) -> Result<T, Error>

where T: DeserializeOwned, F: FnOnce(&Bytes) -> Result<T, String>,

Async alias for into_json_with.

pub fn into_json_unchecked<T>(self) -> Result<T, Error>

where T: DeserializeOwned,

Deserializes JSON without checking HTTP status, using the configured JsonParserFn when set.

pub async fn json_unchecked<T>(self) -> Result<T, Error>

where T: DeserializeOwned,

Async alias for into_json_unchecked.

pub fn into_parts(self) -> (StatusCode, HeaderMap, Bytes)

Splits into status, headers, and body.

pub fn body_by_content_type(&self) -> ResponseBodyKind

Classifies the body using the Content-Type header (does not check HTTP status).

pub fn into_body_by_content_type(self) -> Result<ResponseBodyKind, Error>

Like body_by_content_type after verifying a 2xx status.

Trait Implementations

impl ApiResponseExt for Response

Available on crate feature json only.

fn into_api_result<T, E>(self) -> Result<Result<T, E>, Error>

where T: DeserializeOwned, E: DeserializeOwned,

See into_api_result.

impl Clone for Response

fn clone(&self) -> Response

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Response

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.