Skip to main content

Response

Struct Response 

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

A response, with the methods of reqwest’s Response that generated clients use.

Implementations§

Source§

impl Response

Source

pub fn status(&self) -> StatusCode

The status code.

Source

pub fn headers(&self) -> &HeaderMap

The headers.

Source

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

The headers, to change.

Source

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

Reads the body into memory.

Source

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

Reads the body as text; bytes that are not UTF-8 become U+FFFD.

Source

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

Reads the body as JSON.

Source

pub fn bytes_stream( self, ) -> impl Stream<Item = Result<Bytes, Error>> + MaybeSend + 'static

The body as a stream of chunks, as they arrive. Send, except on WebAssembly (MaybeSend).

Source

pub fn events(self) -> Events

The body as server-sent events (text/event-stream), as they arrive. Events::json decodes their data: as JSON. The status and the content type are not checked.

Source

pub async fn save_to(self, path: impl AsRef<Path>) -> Result<u64, Error>

Available on crate feature fs and non-target_family=wasm only.

Streams the body to the file at path, and returns the number of bytes written.

The body goes to a temporary file in the same directory, which is flushed to disk (fsync) and then renamed to path, replacing any file there: path never holds part of a body. When reading the body or writing the file fails, the temporary file is removed and path is left as it was. The status is not checked.

Source

pub fn into_async_read(self) -> impl AsyncRead + Send + Unpin + 'static

Available on crate feature fs and non-target_family=wasm only.

The body as a tokio AsyncRead, read as it arrives: to copy it somewhere with tokio::io::copy, or to decode it with a reader. A failure reading the body is an std::io::Error whose source is the Error.

Source

pub fn into_http(self) -> Response<Body>

The underlying http::Response.

Trait Implementations§

Source§

impl Debug for Response

Source§

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

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

impl From<Response<Body>> for Response

Source§

fn from(inner: Response<Body>) -> Self

Converts to this type from the input type.

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> 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> MaybeSend for T
where T: Send + ?Sized,

Source§

impl<T> MaybeSync for T
where T: Sync + ?Sized,

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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