Struct IncomingRequest 

pub struct IncomingRequest { /* private fields */ }

Available on crate features http and icap only.

An owned ICAP service request with typed HTTP heads and streaming body.

Pulling the body past an incomplete Preview boundary sends 100 Continue. Returning a response before doing so rejects the remainder of the Preview.

Implementations

impl IncomingRequest

pub fn try_into_unchanged(self) -> Result<UnchangedRequest, IncomingRequest>

Convert this request into a checked unchanged-response capability.

The conversion selects a negotiated 204 response when legal. Otherwise it retains the untouched HTTP message for a streaming 200 echo. If mutable access may have changed or consumed data needed by that echo, the original request is returned unchanged.

pub fn respond_no_modification( self, service_tag: ServiceTag, ) -> Result<OutgoingResponse, Error>

Return a 204 response and leave the HTTP message unchanged.

Contract

Do not return 204 after Preview has continued unless the request contains Allow: 204.

pub fn respond_method_not_allowed( self, service_tag: ServiceTag, ) -> Result<OutgoingResponse, Error>

Return a 405 response for this ICAP request method.

pub async fn adapt_response_head( self, service_tag: ServiceTag, ) -> Result<OutgoingResponse, Error>

Return the current RESPMOD response head and preserve its body.

A non-empty body uses offset-zero 206 replay. The request must contain both Allow: 204 and Allow: 206 because reading may continue Preview.

impl IncomingRequest

pub fn from_icap(request: IncomingRequest) -> Result<IncomingRequest, Error>

Convert the protocol service input without buffering its entity body.

pub fn from_icap_with( request: IncomingRequest, parser: &HeadParser, ) -> Result<IncomingRequest, Error>

Convert the protocol input with explicit HTTP head parser bounds.

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

Return the ICAP request metadata.

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

Return the typed encapsulated HTTP metadata, when present.

pub fn encapsulated_mut(&mut self) -> Option<&mut Encapsulated>

Return the mutable typed HTTP metadata, when present.

This conservatively makes a later streaming unchanged echo unavailable, even when the caller only reads through the returned reference. Use Self::encapsulated for read-only inspection.

pub const fn body(&self) -> &Body

Return the streaming encapsulated entity body.

pub fn body_mut(&mut self) -> &mut Body

Return the mutable streaming encapsulated entity body.

This conservatively records the body as exposed because polling through the returned handle may consume bytes. A later Self::try_into_unchanged can then neither use Preview’s 204 shortcut nor stream an unchanged body echo; an independently negotiated outside-Preview 204 remains available. Use Self::body for read-only inspection.

pub fn into_request(self) -> Result<Request, Error>

Turn a REQMOD service input into its streaming HTTP request.

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

Turn a RESPMOD service input into its streaming HTTP response.

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

Split the typed service request into named metadata and its body.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl ExtensionsRef for IncomingRequest

fn extensions(&self) -> &Extensions

Get reference to the underlying Extensions store