Struct Response 

pub struct Response { /* private fields */ }

HTTP response.

Implementations

impl Response

pub fn from_read( status: StatusCode, header: HeaderMap, effective_uri: Uri, metrics: Var<Metrics>, read: Box<dyn AsyncRead + Send>, ) -> Response

New with body download pending or ongoing.

pub fn from_done( status: StatusCode, headers: HeaderMap, effective_uri: Uri, metrics: Metrics, body: IpcBytes, ) -> Response

New with body already downloaded.

pub fn from_msg(status: StatusCode, msg: impl ToTxt) -> Response

New with status and message body.

pub fn status(&self) -> StatusCode

Returns the StatusCode.

pub fn header(&self) -> &HeaderMap

Returns a reference to the associated header field map.

pub fn effective_uri(&self) -> &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 fn content_len(&self) -> Option<ByteLength>

Get the body bytes length if it is downloaded or Content-Length value if it is present in the headers.

pub async fn download(&mut self) -> Result<(), Box<dyn Error + Send + Sync>>

Receive the full body to memory.

pub async fn body(&mut self) -> Result<IpcBytes, Box<dyn Error + Send + Sync>>

Download the full body memory cache and returns a reference to it.

pub async fn body_text(&mut self) -> Result<Txt, Box<dyn Error + Send + Sync>>

Download the full body to memory and decode a clone to text.

The text encoding is guessed from header "content-type" and BOM sniffing, otherwise utf-8 is assumed and the replacement character (U+FFFD) is used for invalid chars.

pub async fn body_json<O>(&mut self) -> Result<O, Box<dyn Error + Send + Sync>>

where O: DeserializeOwned + Unpin,

Download the full body to memory and deserialize it from JSON.

pub fn take_stream(&mut self) -> Box<dyn AsyncRead + Send>

Take the body stream.

After this call the body_* methods will return empty.

If the body was already downloaded reads that data from the start.

Note that the metrics var will continue updating for the stream.

pub fn stream_decode(&mut self) -> impl AsyncRead + Send + 'static

Take the body stream and decodes it to UTF-8.

The text encoding is guessed from header "content-type" and BOM sniffing, otherwise utf-8 is assumed and the replacement character (U+FFFD) is used for invalid chars.

pub fn on_sse<F>( &mut self, handler: impl FnMut(Result<SseArgs<'_>, SseDisconnected<'_>>) -> F + Send + 'static, )

where F: Future<Output = bool> + Send,

Take the body stream and decode Server-Sent Events (SSE).

The handler is called for each SseArgs and once at the end with SseDisconnected. The handler is dropped after disconnect, the caller must make a new request to retry if desired.

If the handler returns false it is dropped and disconnected.

pub fn metrics(&self) -> Var<Metrics>

Metrics for the task transfer, if it was enabled in the request.

pub async fn error(&mut self) -> Result<(), HttpError>

Convert failed status to an error.

If the status is not success this will attempt to download the body as text, otherwise the body is not accessed.

Trait Implementations

impl Debug for Response

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

Formats the value using the given formatter.

impl ResponseLike for Response

fn status(&self) -> StatusCode

Same as res.status()

fn headers(&self) -> &HeaderMap

Same as res.headers()