Struct ResponseBody 

pub struct ResponseBody { /* private fields */ }

Incoming response frames. Completion or abandonment is reported to the client driver; response reads do not drive request upload or socket I/O.

A pending read can be dropped without losing a frame, so reads can race other futures such as a command channel or timer. See polling reads alongside other I/O.

Trait Implementations

impl Drop for ResponseBody

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl ReadableBody for ResponseBody

type Data = Vec<u8>

Application data, without imposing completion-I/O buffer requirements.

type Error = BodyError

fn is_ready(&self) -> bool

Whether another read can proceed without waiting for produced data.

fn is_empty(&self) -> bool

Whether no unread payload frames remain. False can mean unknown; an open queue with no frames is not exhausted. This does not suppress read errors.

fn length(&self) -> Option<u64>

Total representation length, independent of the current read position.

fn may_have_trailers(&self) -> bool

Whether this body can emit trailing headers. An HTTP/1.1 response needs this before reading to choose chunked framing, even when the data length is known. An HTTP/1 request of known length uses Content-Length and drops any trailers whatever this reports. Returning false promises that no Headers frame will be produced.

fn close(&mut self, error: Option<BodyError>)

Abandon further application reads, optionally reporting their failure.

async fn read( &mut self, cancellation: &Cancellation, ) -> Result<BodyFrame<Vec<u8>>, BodyError>

Read one owned frame. Pre-cancellation prevents consumption. The caller stops after frame.is_end(); subsequent reads return BodyFrame::End. Headers occur at most once, after all data. Dropping a pending read is not transport retirement, and must not lose an unreturned queued frame.

fn is_rewindable(&self) -> bool

fn rewind(&mut self) -> bool

Restore the read position when supported, reporting success.