Skip to main content

ClientResponse

Struct ClientResponse 

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

An HTTP client response.

Implementations§

Source§

impl ClientResponse

Source

pub fn version(&self) -> Version

Returns the response HTTP version.

Source

pub fn status(&self) -> StatusCode

Returns the response status.

Source

pub fn header<N: AsName>(&self, name: N) -> Option<&HeaderValue>

Returns the first header value associated with name.

Source

pub fn headers(&self) -> &HeaderMap

Returns the response headers.

Source

pub fn headers_mut(&mut self) -> &mut HeaderMap

Returns mutable access to the response headers.

Source

pub fn set_payload(&self, payload: Payload)

Replaces the response payload.

Any unread previous payload is dropped.

Source

pub fn take_payload(&self) -> Payload

Takes the response payload.

Subsequent calls return an empty payload.

Source

pub fn extensions(&self) -> Ref<'_, Extensions>

Returns the response extensions.

Source

pub fn extensions_mut(&self) -> RefMut<'_, Extensions>

Returns mutable access to the response extensions.

Source§

impl ClientResponse

Source

pub fn body(&self) -> MessageBody ⓘ

Returns a future that buffers the response body.

Source

pub fn json<T: DeserializeOwned>(&self) -> JsonBody<T> ⓘ

Returns a future that buffers and deserializes a JSON response body.

The future returns an error when:

  • the content type is not JSON;
  • the body exceeds the configured response payload limit; or
  • reading or deserializing the body fails.

Trait Implementations§

Source§

impl Debug for ClientResponse

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<ServiceResponse> for ClientResponse

Source§

fn from(res: ServiceResponse) -> Self

Converts to this type from the input type.
Source§

impl HttpMessage for ClientResponse

Source§

fn cookies(&self) -> Result<Ref<'_, Vec<Cookie<'static>>>, CookieParseError>

Parses cookies from the response Set-Cookie headers.

Source§

fn message_headers(&self) -> &HeaderMap

Returns the message headers.
Source§

fn message_extensions(&self) -> Ref<'_, Extensions>

Returns the message extensions.
Source§

fn message_extensions_mut(&self) -> RefMut<'_, Extensions>

Returns mutable access to the message extensions.
Source§

fn content_type(&self) -> &str

Returns the media type from the Content-Type header. Read more
Source§

fn encoding(&self) -> Result<&'static Encoding, ContentTypeError>

Returns the character encoding declared by Content-Type. Read more
Source§

fn mime_type(&self) -> Result<Option<Mime>, ContentTypeError>

Parses the Content-Type header as a MIME type. Read more
Source§

fn chunked(&self) -> Result<bool, DecodeError>

Returns whether Transfer-Encoding contains chunked. Read more
Source§

fn cookie(&self, name: &str) -> Option<Cookie<'static>>

Returns the first request cookie with the given name.
Source§

impl Stream for ClientResponse

Source§

type Item = Result<Bytes, Error<ClientPayloadError>>

Values yielded by the stream.
Source§

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted. Read more
§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.
§

impl<S, T, E> TryStream for S
where S: Stream<Item = Result<T, E>> + ?Sized,

§

type Ok = T

The type of successful values yielded by this future
§

type Error = E

The type of failures yielded by this future
§

fn try_poll_next( self: Pin<&mut S>, cx: &mut Context<'_>, ) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this TryStream as if it were a Stream. Read more