Struct zng::task::http::Response

pub struct Response(/* private fields */);

HTTP response.

Implementations

impl Response

pub fn status(&self) -> StatusCode

Returns the StatusCode.

pub fn headers(&self) -> &HeaderMap

Returns a reference to the associated header field map.

pub fn content_len(&self) -> Option<ByteLength>

Decode content-length value if it is present in the headers.

pub fn cookie_jar(&self) -> Option<&CookieJar>

Get the configured cookie jar used for persisting cookies from this response, if any.

Only returns None if the default_client was replaced by one with cookies disabled.

pub async fn text(&mut self) -> Result<Txt, Error>

Read the response body as a string.

pub fn effective_uri(&self) -> Option<&Uri>

Get the effective URI of this response. This value differs from the original URI provided when making the request if at least one redirect was followed.

pub async fn bytes(&mut self) -> Result<Vec<u8>, Error>

Read the response body as raw bytes.

pub async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Read some bytes from the body, returns how many bytes where read.

pub async fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the from the body to exactly fill the buffer.

pub async fn json<O>(&mut self) -> Result<O, Error>

where O: DeserializeOwned + Unpin,

Deserialize the response body as JSON.

pub fn metrics(&self) -> Metrics

Metrics for the task transfer.

Metrics are enabled in the default_client and can be toggled for each request using the RequestBuilder::metrics method. If disabled returns Metrics::zero.

pub async fn consume(&mut self) -> Result<(), Error>

Drop the request without dropping the connection.

This receives and discards any remaining bytes in the response stream. When a response is dropped without finishing the connection is discarded so it cannot be reused for connections older then HTTP/2.

You should call this method before dropping if you expect the remaining bytes to be consumed quickly and don’t known that HTTP/2 or newer is being used.

pub fn new_message( status: impl Into<StatusCode>, msg: impl Into<String>, ) -> Response

Create a response with the given status and text body message.

pub fn new(status: StatusCode, headers: HeaderMap, body: Body) -> Response

New response.

pub fn into_parts(self) -> (Parts, Body)

Consumes the response returning the head and body parts.

pub fn from_parts(parts: Parts, body: Body) -> Response

New response from given head and body.

Trait Implementations

impl Debug for Response

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

Formats the value using the given formatter.