Struct RequestStream 

pub struct RequestStream { /* private fields */ }

A streamed request body (issue #585). Extracted by a handler on a route its module declared in Module::streaming_routes; the router has already put it in the request extensions and emptied the buffered body.

It is Clone, and clones share one cursor: the router’s request layer inserts one handle and a handler may clone it, but they read the same underlying stream. It is one-shot — once the source ends (or is refused), every later poll answers None forever.

Implementations

impl RequestStream

pub fn new<S, O, E>(stream: S, max_bytes: usize) -> Self

where S: Stream<Item = Result<O, E>> + Send + 'static, O: Into<Bytes> + 'static, E: Display + 'static,

Wraps stream, enforcing max_bytes as chunks are read. Accepts any Send stream of Result<O, E> where O converts into Bytes and E renders — an axum Body::into_data_stream(), a runtime’s own body stream, or a test’s synthetic one.

pub fn empty() -> Self

A stream that ends immediately. The empty exchange a test or a runtime hands a route that has no body of its own.

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

The next chunk, or None once the source has ended (or was refused). A convenience for core callers, who have no StreamExt: it is futures_core::Stream::poll_next behind std::future::poll_fn.

Trait Implementations

impl Clone for RequestStream

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Send + Sync> FromRequestParts<S> for RequestStream

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<Self, Self::Rejection>

Removes the router-inserted stream from the request extensions. A route that was not declared in Module::streaming_routes has none, and extracting here is a programming error — never a client one — so it answers a 500 internal naming the declaration that is missing.

type Rejection = Problem

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

impl Stream for RequestStream

type Item = Result<Bytes, StreamError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.