Struct ClientResponse 

pub struct ClientResponse<'a, IO> { /* private fields */ }

Available on crate features http and icap only.

A typed, streaming response to an HTTP adaptation request.

Adapted HTTP heads retain zero-copy header-value slices from their ICAP wire buffers. Entity data is exposed as ref-counted Bytes chunks. For a negotiated 204 or 206 response, the stream transparently replays the retained original body bytes required to produce the final HTTP message.

Implementations

impl<'a, IO> ClientResponse<'a, IO>

where IO: Io + Unpin + ExtensionsRef,

pub const fn icap(&self) -> &Response

Return the ICAP response metadata.

pub const fn encapsulated(&self) -> Option<&Encapsulated>

Return the typed encapsulated HTTP metadata, when present.

pub fn original_request(&self) -> Option<&Request<()>>

Return the original HTTP request head for a REQMOD transaction.

pub fn original_response(&self) -> Option<&Response<()>>

Return the original HTTP response head for a RESPMOD transaction.

pub fn request(&self) -> Option<&Request<()>>

Return the resulting HTTP request head for a REQMOD transaction.

A 204 response reuses the retained original head. A body-only adapted result also reuses that head, while a headed result uses the encapsulated head. Proxy credentials promoted to the outer ICAP response are restored on the resulting HTTP request.

pub fn response(&self) -> Option<&Response<()>>

Return the resulting HTTP response head for a RESPMOD transaction.

A 204 response or body-only adapted result reuses the retained original head. Proxy challenges promoted to the outer ICAP response are restored on the resulting HTTP response.

pub async fn next_data(&mut self) -> Result<Option<Bytes>, Error>

Read the next zero-copy data segment of the resulting HTTP body.

Trailer frames are consumed and remain available through trailers. Use next_frame to receive trailers as a frame.

pub async fn next_frame(&mut self) -> Result<Option<Frame<Bytes>>, Error>

Read the next data or trailer frame of the resulting HTTP body.

This includes original-body replay for 204 and 206 responses.

pub const fn body_end(&self) -> Option<BodyEnd>

Return the terminal ICAP body state after the data stream completes.

pub const fn trailers(&self) -> Option<&HeaderMap>

Return trailers of the resulting HTTP body after it completes.

pub fn icap_trailers(&self) -> Option<&TrailerBlock>

Return negotiated outer ICAP trailers after the ICAP body completes.

These fields are ICAP metadata and are never emitted as HTTP trailer frames by next_frame.

pub const fn original_body_bytes_sent(&self) -> u64

Return original entity-body bytes sent in complete ICAP chunks.

pub const fn original_body_len(&self) -> Option<u64>

Return the exact original entity-body length, when known.

pub const fn original_body_offset_is_verified(&self) -> Option<bool>

Return whether a 206 original-body offset was locally verified.

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

Drain and discard the resulting HTTP entity body.

pub fn into_icap(self) -> Result<Response, Error>

Return the ICAP response after its body has completed.

Trait Implementations

impl<IO> Debug for ClientResponse<'_, IO>

where IO: Io + Unpin + ExtensionsRef,

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

Formats the value using the given formatter.

impl<IO> ExtensionsRef for ClientResponse<'_, IO>

fn extensions(&self) -> &Extensions

Get reference to the underlying Extensions store