Struct GuardedBody 

pub struct GuardedBody<B, G> { /* private fields */ }

Available on crate features http and std only.

A StreamingBody wrapper that owns an opaque guard and releases it when the body is fully consumed on the wire (StreamingBody::poll_frame returns Poll::Ready(None)), or on drop if the body is abandoned early.

This ties the guard’s lifetime to the body it accompanies rather than to the response headers. The motivating use is a pooled connection handle: the connector returns the response at headers and immediately drops its handle, but the connection is logically still in use until the body has been read. By moving the handle in here, its release (e.g. freeing a stream slot or returning the connection to the pool) happens when the body is done.

The guard is released exactly once: either at end-of-stream or, for an early drop (e.g. a cancelled/aborted read), when this body is dropped.

Implementations

impl<B, G> GuardedBody<B, G>

pub fn new(inner: B, guard: G) -> GuardedBody<B, G>

Wrap inner, holding guard until the body reaches end-of-stream or is dropped.

Trait Implementations

impl<B, G> Body for GuardedBody<B, G>

where B: Body,

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 GuardedBody<B, G>>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<<GuardedBody<B, G> as Body>::Data>, <GuardedBody<B, G> 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, G> Unpin for GuardedBody<B, G>

where <PinnedFieldsOfHelperStruct<__Origin<'__pin, B, G>> as PinnedFieldsOfHelperTrait>::Actual: Unpin,