Skip to main content

Response

Struct Response 

Source
pub struct Response<T = Value> { /* private fields */ }
Expand description

A successful response. T is the type json decodes into.

Non-success statuses never reach this type; send turns them into Error::Api. A failure while reading the body keeps the status and headers: Error::Body for an interrupted body and Error::ResponseTooLarge above the transport limit.

The body is read only when a consuming method is called. Choose one reader; capture any headers needed afterward before consuming the response. A successful HTTP status alone does not establish that the body is valid or an import fully succeeded.

Implementations§

Source§

impl<T> Response<T>

Source

pub fn status_code(&self) -> StatusCode

Source

pub fn headers(&self) -> &HeaderMap

Source

pub fn content_length(&self) -> Option<u64>

Source

pub fn url(&self) -> &Url

The requested URL, including query values. Debug omits them.

Source

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

Reads the whole body, failing with Error::ResponseTooLarge above the transport limit.

Source

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

Reads the body as UTF-8, replacing invalid sequences.

Source

pub fn bytes_stream(self) -> impl Stream<Item = Result<Bytes>> + Send

Streams the body without the transport’s size limit. Failures return Error::Body with the status, headers and number of bytes delivered before the failure. No body trace event is emitted.

Source

pub async fn json_as<U: DeserializeOwned>(self) -> Result<U>

Decodes the body into a type other than the endpoint’s default.

Source§

impl<T: DeserializeOwned> Response<T>

Source

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

Reads and decodes the body into the endpoint’s response type. Invalid JSON or a mismatched shape returns Error::Decode with response status and headers. Reading remains subject to the transport’s size limit.

Trait Implementations§

Source§

impl<T> Debug for Response<T>

Omits query values, which can carry filters or tokens.

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T = Value> !RefUnwindSafe for Response<T>

§

impl<T = Value> !UnwindSafe for Response<T>

§

impl<T> Freeze for Response<T>
where PhantomData<fn() -> T>: Freeze,

§

impl<T> Send for Response<T>
where PhantomData<fn() -> T>: Send,

§

impl<T> Sync for Response<T>
where PhantomData<fn() -> T>: Sync,

§

impl<T> Unpin for Response<T>
where PhantomData<fn() -> T>: Unpin,

§

impl<T> UnsafeUnpin for Response<T>
where PhantomData<fn() -> T>: UnsafeUnpin,

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