Struct Streaming 

pub struct Streaming<T = String, E = ()> { /* private fields */ }

A streaming payload.

Frames and Chunking

The streaming payload sends and receives data in discrete chunks or “frames”. The size is converted to hex and sent before each chunk, followed by a CRLF, the chunk data, and another CRLF.

This mimics actual HTTP chunked transfer encoding, but allows us to define our own framing protocol on top of it.

Arbitrary bytes can be encoded between these frames, but the frames do come with some overhead.

Browser Support for Streaming Input

Browser fetch requests do not currently support full request duplexing, which means that that they do not begin handling responses until the full request has been sent.

This means that if you use a streaming input encoding, the input stream needs to end before the output will begin.

Streaming requests are only allowed over HTTP2 or HTTP3.

Also note that not all browsers support streaming bodies to servers.

Implementations

impl<T: 'static + Send, E> Streaming<T, E>

pub fn new(value: impl Stream<Item = T> + Send + 'static) -> Self

Creates a new stream from the given stream.

pub async fn next(&mut self) -> Option<Result<T, StreamingError>>

Returns the next item in the stream, or None if the stream has ended.

pub fn into_inner(self) -> impl Stream<Item = Result<T, StreamingError>> + Send

Consumes the wrapper, returning the inner stream.

Trait Implementations

impl<T> Debug for Streaming<T>

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

Formats the value using the given formatter.

impl<T, E: Encoding> Debug for Streaming<T, E>

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

Formats the value using the given formatter.

impl<T, S, U, E> From<S> for Streaming<T, E>

where S: Stream<Item = U> + Send + 'static, U: Into<T>, T: 'static + Send, E: Encoding,

fn from(value: S) -> Self

Converts to this type from the input type.

impl<S> FromRequest<S> for Streaming<String>

type Rejection = ServerFnError

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

fn from_request( req: Request, _state: &S, ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send

Perform the extraction.

impl<T: DeserializeOwned + Serialize + 'static + Send, E: Encoding, S> FromRequest<S> for Streaming<T, E>

type Rejection = ServerFnError

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

fn from_request( req: Request, _state: &S, ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send

Perform the extraction.

impl FromResponse for Streaming<String>

fn from_response( res: ClientResponse, ) -> impl Future<Output = Result<Self, ServerFnError>>

impl FromResponse for Streaming<Bytes>

fn from_response( res: ClientResponse, ) -> impl Future<Output = Result<Self, ServerFnError>>

impl<T: DeserializeOwned + Serialize + 'static + Send, E: Encoding> FromResponse for Streaming<T, E>

fn from_response( res: ClientResponse, ) -> impl Future<Output = Result<Self, ServerFnError>>

impl IntoRequest for Streaming<String>

fn into_request( self, builder: ClientRequest, ) -> impl Future<Output = Result<ClientResponse, RequestError>> + 'static

impl<T: DeserializeOwned + Serialize + 'static + Send, E: Encoding> IntoRequest for Streaming<T, E>

fn into_request( self, builder: ClientRequest, ) -> impl Future<Output = Result<ClientResponse, RequestError>> + 'static

impl IntoResponse for Streaming<String>

fn into_response(self) -> Response

Create a response.

impl IntoResponse for Streaming<Bytes>

fn into_response(self) -> Response

Create a response.

impl<T: DeserializeOwned + Serialize + 'static, E: Encoding> IntoResponse for Streaming<T, E>

fn into_response(self) -> Response

Create a response.