Struct awc::ClientResponse
source · [−]pub struct ClientResponse<S = BoxedPayloadStream> { /* private fields */ }
Expand description
Client Response
Implementations
Get the status from the server.
pub fn map_body<F, U>(self, f: F) -> ClientResponse<U> where
F: FnOnce(&mut ResponseHead, Payload<S>) -> Payload<U>,
pub fn map_body<F, U>(self, f: F) -> ClientResponse<U> where
F: FnOnce(&mut ResponseHead, Payload<S>) -> Payload<U>,
Map the current body type to another using a closure. Returns a new response.
Closure receives the response head and the current body type.
Set a timeout duration for ClientResponse
.
This duration covers the duration of processing the response body stream and would end it as timeout error when deadline met.
Disabled by default.
Load request cookies.
Return request cookie.
pub fn body(&mut self) -> ResponseBody<S>ⓘNotable traits for ResponseBody<S>impl<S> Future for ResponseBody<S> where
S: Stream<Item = Result<Bytes, PayloadError>>, type Output = Result<Bytes, PayloadError>;
pub fn body(&mut self) -> ResponseBody<S>ⓘNotable traits for ResponseBody<S>impl<S> Future for ResponseBody<S> where
S: Stream<Item = Result<Bytes, PayloadError>>, type Output = Result<Bytes, PayloadError>;
impl<S> Future for ResponseBody<S> where
S: Stream<Item = Result<Bytes, PayloadError>>, type Output = Result<Bytes, PayloadError>;
Returns a Future
that consumes the body stream and resolves to Bytes
.
Errors
Future
implementation returns error if:
- content length is greater than limit (default: 2 MiB)
Examples
let client = Client::default();
let mut res = client.get("https://httpbin.org/robots.txt").send().await?;
let body: Bytes = res.body().await?;
pub fn json<T: DeserializeOwned>(&mut self) -> JsonBody<S, T>ⓘNotable traits for JsonBody<S, T>impl<S, T> Future for JsonBody<S, T> where
S: Stream<Item = Result<Bytes, PayloadError>>,
T: DeserializeOwned, type Output = Result<T, JsonPayloadError>;
pub fn json<T: DeserializeOwned>(&mut self) -> JsonBody<S, T>ⓘNotable traits for JsonBody<S, T>impl<S, T> Future for JsonBody<S, T> where
S: Stream<Item = Result<Bytes, PayloadError>>,
T: DeserializeOwned, type Output = Result<T, JsonPayloadError>;
impl<S, T> Future for JsonBody<S, T> where
S: Stream<Item = Result<Bytes, PayloadError>>,
T: DeserializeOwned, type Output = Result<T, JsonPayloadError>;
Returns a Future
consumes the body stream, parses JSON, and resolves to a deserialized
T
value.
Errors
Future returns error if:
- content type is not
application/json
; - content length is greater than limit (default: 2 MiB).
Examples
let client = Client::default();
let mut res = client.get("https://httpbin.org/json").send().await?;
let val = res.json::<serde_json::Value>().await?;
assert!(val.is_object());
Trait Implementations
type Stream = S
type Stream = S
Type of message payload stream
Message payload stream
Returns a reference to the request-local data/extensions container.
Returns a mutable reference to the request-local data/extensions container.
Read the request content type. If request did not contain a Content-Type header, an empty string is returned. Read more
Get content type encoding. Read more
Convert the request content type to a known mime type.
Check if request has chunked transfer encoding.
impl<S> Stream for ClientResponse<S> where
S: Stream<Item = Result<Bytes, PayloadError>> + Unpin,
impl<S> Stream for ClientResponse<S> where
S: Stream<Item = Result<Bytes, PayloadError>> + Unpin,
type Item = Result<Bytes, PayloadError>
type Item = Result<Bytes, PayloadError>
Values yielded by the stream.
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
Auto Trait Implementations
impl<S = Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>> !RefUnwindSafe for ClientResponse<S>
impl<S = Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>> !Send for ClientResponse<S>
impl<S = Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>> !Sync for ClientResponse<S>
impl<S = Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>> !UnwindSafe for ClientResponse<S>
Blanket Implementations
Mutably borrows from an owned value. Read more
Creates a future that resolves to the next item in the stream. Read more
Maps this stream’s items to a different type, returning a new stream of the resulting type. Read more
Creates a stream which gives the current iteration count as well as the next value. Read more
Filters the values produced by this stream according to the provided asynchronous predicate. Read more
Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more
Computes from this stream’s items new items of a different type using an asynchronous closure. Read more
Transforms a stream into a collection, returning a future representing the result of that computation. Read more
Converts a stream of pairs into a future, which resolves to pair of containers. Read more
Concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more
Drives the stream to completion, counting the number of items. Read more
Execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more
Execute predicate over asynchronous stream, and return true
if any element in stream satisfied a predicate. Read more
Execute predicate over asynchronous stream, and return true
if all element in stream satisfied a predicate. Read more
Flattens a stream of streams into just one continuous stream. Read more
Maps a stream like StreamExt::map
but flattens nested Stream
s. Read more
Combinator similar to StreamExt::fold
that holds internal state
and produces a new stream. Read more
Skip elements on this stream while the provided asynchronous predicate
resolves to true
. Read more
Take elements from this stream while the provided asynchronous predicate
resolves to true
. Read more
Take elements from this stream until the provided future resolves. Read more
Runs this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more
fn for_each_concurrent<Fut, F>(
self,
limit: impl Into<Option<usize>>,
f: F
) -> ForEachConcurrent<Self, Fut, F> where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = ()>,
fn for_each_concurrent<Fut, F>(
self,
limit: impl Into<Option<usize>>,
f: F
) -> ForEachConcurrent<Self, Fut, F> where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = ()>,
Runs this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available. Read more
Creates a new stream of at most n
items of the underlying stream. Read more
Creates a new stream which skips n
items of the underlying stream. Read more
Wrap the stream in a Box, pinning it. Read more
Wrap the stream in a Box, pinning it. Read more
An adaptor for creating a buffered list of pending futures. Read more
An adaptor for creating a buffered list of pending futures (unordered). Read more
An adapter for zipping two streams together. Read more
Adapter for chaining two streams. Read more
Creates a new stream which exposes a peek
method. Read more
An adaptor for chunking up items of the stream inside a vector. Read more
An adaptor for chunking up ready items of the stream inside a vector. Read more
A future that completes after the given stream has been fully processed into the sink and the sink has been flushed and closed. Read more
Splits this Stream + Sink
object into separate Sink
and Stream
objects. Read more
Do something with each item of this stream, afterwards passing it on. Read more
Wrap this stream in an Either
stream, making it the left-hand variant
of that Either
. Read more
Wrap this stream in an Either
stream, making it the right-hand variant
of that Either
. Read more
A convenience method for calling Stream::poll_next
on Unpin
stream types. Read more
Wraps the current stream in a new stream which converts the error type into the one provided. Read more
Wraps the current stream in a new stream which maps the success value using the provided closure. Read more
Wraps the current stream in a new stream which maps the error value using the provided closure. Read more
Chain on a computation for when a value is ready, passing the successful
results to the provided closure f
. Read more
Chain on a computation for when an error happens, passing the
erroneous result to the provided closure f
. Read more
Do something with the success value of this stream, afterwards passing it on. Read more
Do something with the error value of this stream, afterwards passing it on. Read more
Creates a future that attempts to resolve the next item in the stream. If an error is encountered before the next item, the error is returned instead. Read more
fn try_for_each<Fut, F>(self, f: F) -> TryForEach<Self, Fut, F> where
F: FnMut(Self::Ok) -> Fut,
Fut: TryFuture<Ok = (), Error = Self::Error>,
fn try_for_each<Fut, F>(self, f: F) -> TryForEach<Self, Fut, F> where
F: FnMut(Self::Ok) -> Fut,
Fut: TryFuture<Ok = (), Error = Self::Error>,
Attempts to run this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more
fn try_skip_while<Fut, F>(self, f: F) -> TrySkipWhile<Self, Fut, F> where
F: FnMut(&Self::Ok) -> Fut,
Fut: TryFuture<Ok = bool, Error = Self::Error>,
fn try_skip_while<Fut, F>(self, f: F) -> TrySkipWhile<Self, Fut, F> where
F: FnMut(&Self::Ok) -> Fut,
Fut: TryFuture<Ok = bool, Error = Self::Error>,
Skip elements on this stream while the provided asynchronous predicate
resolves to true
. Read more
fn try_take_while<Fut, F>(self, f: F) -> TryTakeWhile<Self, Fut, F> where
F: FnMut(&Self::Ok) -> Fut,
Fut: TryFuture<Ok = bool, Error = Self::Error>,
fn try_take_while<Fut, F>(self, f: F) -> TryTakeWhile<Self, Fut, F> where
F: FnMut(&Self::Ok) -> Fut,
Fut: TryFuture<Ok = bool, Error = Self::Error>,
Take elements on this stream while the provided asynchronous predicate
resolves to true
. Read more
Attempts to run this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available, exiting as soon as an error occurs. Read more
Attempt to transform a stream into a collection, returning a future representing the result of that computation. Read more
An adaptor for chunking up successful items of the stream inside a vector. Read more
Attempt to filter the values produced by this stream according to the provided asynchronous closure. Read more
fn try_filter_map<Fut, F, T>(self, f: F) -> TryFilterMap<Self, Fut, F> where
Fut: TryFuture<Ok = Option<T>, Error = Self::Error>,
F: FnMut(Self::Ok) -> Fut,
fn try_filter_map<Fut, F, T>(self, f: F) -> TryFilterMap<Self, Fut, F> where
Fut: TryFuture<Ok = Option<T>, Error = Self::Error>,
F: FnMut(Self::Ok) -> Fut,
Attempt to filter the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more
fn try_flatten(self) -> TryFlatten<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error: From<Self::Error>,
fn try_flatten(self) -> TryFlatten<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error: From<Self::Error>,
Flattens a stream of streams into just one continuous stream. Read more
Attempt to execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more
fn try_concat(self) -> TryConcat<Self> where
Self::Ok: Extend<<Self::Ok as IntoIterator>::Item>,
Self::Ok: IntoIterator,
Self::Ok: Default,
fn try_concat(self) -> TryConcat<Self> where
Self::Ok: Extend<<Self::Ok as IntoIterator>::Item>,
Self::Ok: IntoIterator,
Self::Ok: Default,
Attempt to concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more
fn try_buffer_unordered(self, n: usize) -> TryBufferUnordered<Self> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
fn try_buffer_unordered(self, n: usize) -> TryBufferUnordered<Self> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
Attempt to execute several futures from a stream concurrently (unordered). Read more
fn try_buffered(self, n: usize) -> TryBuffered<Self> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
fn try_buffered(self, n: usize) -> TryBuffered<Self> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
Attempt to execute several futures from a stream concurrently. Read more
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more