Struct ResponseStream 

pub struct ResponseStream { /* private fields */ }

A streamed response body: chunks plus optional trailers. The explicit streaming contract that replaced Body::Stream. Ride it on Response.stream; the buffered case leaves that field None.

Implementations

impl ResponseStream

pub fn new<S>(stream: S) -> Self

where S: Stream<Item = Result<Bytes, ProximaError>> + Send + 'static,

Build from any Send chunk stream.

pub fn from_chunk_stream(stream: ChunkStream) -> Self

Build from an already-boxed ChunkStream.

pub fn once(bytes: Bytes) -> Self

One-chunk stream wrapping a complete Bytes — the buffered -> streaming bridge.

pub fn with_trailers_slot(self, slot: TrailersSlot) -> Self

Attach a trailers slot a chunked producer will populate at end.

pub fn with_trailers(self, trailers: HeaderList) -> Self

Attach trailers known up front.

pub fn trailers(&self) -> Option<HeaderList>

Read captured trailers, if any. None until a stream-end producer has populated the slot.

pub fn trailers_slot(&self) -> Option<&TrailersSlot>

Borrow the trailers slot — handed to a producer (e.g. the H1 chunked-decoder pump) before the stream completes.

pub fn into_chunk_stream(self) -> ChunkStream

Take the underlying chunk stream (drops trailers metadata).

pub fn chunk_stream_mut(&mut self) -> &mut ChunkStream

Borrow the chunk stream mutably (listener pump path).

pub async fn drain(self) -> Result<(), ProximaError>

Consume the body stream without materializing any Bytes — read and discard all chunks until the stream ends. The framing decoder still runs (the caller must exhaust the body to reach the keep-alive message boundary); only the per-chunk allocation and copy are skipped.

pub async fn collect( self, cancel: Option<&Signal>, ) -> Result<Bytes, ProximaError>

Drain the stream to a single Bytes. Under std, races the supplied request-scoped cancel token; the first to resolve wins.

Trait Implementations

impl Debug for ResponseStream

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

Formats the value using the given formatter.