Struct SubResponseBody 

pub struct SubResponseBody { /* private fields */ }

Opaque handle to a streaming sub-request response body.

Pull-based: call next_chunk() to receive the next body chunk. Returns Ok(None) at clean EOF.

Owns the live Pingora HTTP session, admission permit, connector (for session release), and all streaming deadlines. No background tasks or channels — downstream backpressure naturally paces upstream reads.

Implementations

impl SubResponseBody

pub fn is_done(&self) -> bool

Whether this body has completed (EOF, error, or cancel).

pub fn received_bytes(&self) -> usize

Total bytes received so far.

pub fn chunk_count(&self) -> u64

Number of chunks received so far.

pub async fn next_chunk(&mut self) -> Result<Option<Bytes>, SubRequestError>

Pull the next body chunk from the upstream.

Returns:

• Ok(Some(chunk)) — a data chunk.
• Ok(None) — clean EOF; the session has been released to the pool.

Errors

• Err(StreamIdleTimeout) — upstream stalled for idle_timeout.
• Err(DeadlineExceeded) — max_stream_duration expired.
• Err(ResponseTooLarge) — cumulative bytes exceeded max_total_bytes.
• Err(Io) — transport error or unclean EOF.

Panics

Panics if the session is None when done is false (internal invariant violation).

pub async fn cancel(self)

Explicitly cancel the streaming response.

Shuts down the upstream session and releases the admission permit. Consumes self. No-op if the body is already done (EOF, error, or prior cancel).

Trait Implementations

impl Drop for SubResponseBody

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.