Struct StatusCodeError 

pub struct StatusCodeError { /* private fields */ }

A non-success HTTP response, captured without exposing the response type of the underlying HTTP client.

Status, URL, and headers are available synchronously. The body is not read up front: the failed response is kept alive and body streams it on demand, so constructing the error is pure and does no I/O. Since the response is consumed to read the body, body takes self.

Reading stops at MAX_ERROR_BODY bytes: an error response belongs to the server, and a hostile or misconfigured one must not be able to make this allocate an unbounded buffer.

Implementations

impl StatusCodeError

pub fn status(&self) -> u16

The HTTP status code of the failed response.

pub fn url(&self) -> &Url

The URL the failed response came from.

pub fn header(&self, name: &str) -> Option<&str>

A header value from the failed response, if present and valid UTF-8.

pub fn into_response(self) -> Response

Take back the raw failed response for full access to the underlying HTTP client.

This is an opt-in escape hatch: the signature names reqwest::Response, but only callers who use it need to depend on reqwest. Code that does not call it is unaffected and can keep using body / body_text without naming the client crate.

Consumes the error, since a response body can only be read once.

pub async fn body(self) -> Vec<u8>

Read the body of the failed response, capped at MAX_ERROR_BODY bytes.

Consumes the response; a body can only be read once. Stops once the cap is reached instead of trusting a remote Content-Length, so a hostile server cannot force an unbounded allocation.

pub async fn body_text(self) -> String

Read the body of the failed response and decode it as UTF-8, lossily.

Trait Implementations

impl Debug for StatusCodeError

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

Formats the value using the given formatter.

impl Display for StatusCodeError

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

Formats the value using the given formatter.

impl Error for StatusCodeError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.