Struct OnIncompleteBody 

pub struct OnIncompleteBody<B, F>
where
    F: FnOnce(),
{ /* private fields */ }

Available on crate features http and std only.

A StreamingBody wrapper that calls a closure as soon as it is known the body will not complete: an error frame is observed, or the body is dropped before end-of-stream.

Unlike OnDropBody (which only reacts to drops), this fires at error-observation time and treats a body whose StreamingBody::is_end_stream already reports completion as complete, both at construction (e.g. an empty body that is never polled) and after its final frame (e.g. a content-length body read to its last byte, or a chunked body whose terminal trailers frame was read, dropped before the trailing poll_frame -> Ready(None)).

The closure is called at most once. The motivating use is connection reuse: a transport whose response was abandoned or errored mid-message must be marked non-reusable synchronously, before whatever guard releases it (e.g. back into a connection pool) runs — an asynchronous observer on the connection task loses that race to the next request.

Implementations

impl<B, F> OnIncompleteBody<B, F>

where B: Body, F: FnOnce(),

pub fn new(body: B, on_incomplete: F) -> OnIncompleteBody<B, F>

Wrap body, calling on_incomplete once if it errors or is abandoned before end-of-stream.

Trait Implementations

impl<B, F> Body for OnIncompleteBody<B, F>

where B: Body, F: FnOnce(),

type Data = <B as Body>::Data

Values yielded by the Body.

type Error = <B as Body>::Error

The error type this Body might generate.

fn poll_frame( self: Pin<&mut OnIncompleteBody<B, F>>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<<OnIncompleteBody<B, F> as Body>::Data>, <OnIncompleteBody<B, F> as Body>::Error>>>

Attempt to pull out the next frame of this stream.

fn is_end_stream(&self) -> bool

A hint that may return true when the end of stream has been reached.

fn size_hint(&self) -> SizeHint

A hint that returns the bounds on the remaining length of the stream.

impl<'__pin, B, F> Unpin for OnIncompleteBody<B, F>

where F: FnOnce(), <PinnedFieldsOfHelperStruct<__Origin<'__pin, B, F>> as PinnedFieldsOfHelperTrait>::Actual: Unpin,