Skip to main content

Response

Struct Response 

Source
pub struct Response { /* private fields */ }
Expand description

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§

Source§

impl Response

Source

pub fn status(&self) -> StatusCode

HTTP status code.

Source

pub fn headers(&self) -> &HeaderMap

Response headers.

Source

pub fn bytes(&self) -> &Bytes

Returns a reference to the fully buffered response body.

Source

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

Final request URL when available.

Source

pub fn is_success(&self) -> bool

Returns true for 2xx status codes.

Source

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

Returns an error if the status is not success.

Source

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).

Source

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

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

Source

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.

Source

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

Async alias for into_bytes_checked.

Source

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

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.

Source

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

Async alias for into_json.

Source

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 (BytesT).

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

Source

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.

Source

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

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

Source

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

Async alias for into_json_unchecked.

Source

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

Splits into status, headers, and body.

Trait Implementations§

Source§

impl Clone for Response

Source§

fn clone(&self) -> Response

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Response

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more