Struct ByteStream

pub struct ByteStream<CustErr = NoCustomError>(/* private fields */);

A stream of bytes.

A server function can return this type if its output encoding is Streaming.

Browser Support for Streaming Input

Browser fetch requests do not currently support full request duplexing, which means that that they do 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.

Implementations

impl<CustErr> ByteStream<CustErr>

pub fn into_inner( self, ) -> impl Stream<Item = Result<Bytes, ServerFnError<CustErr>>> + Send

Consumes the wrapper, returning a stream of bytes.

impl ByteStream

pub fn new<T>( value: impl Stream<Item = Result<T, ServerFnError>> + Send + 'static, ) -> ByteStream

where T: Into<Bytes>,

Creates a new ByteStream from the given stream.

Trait Implementations

impl<CustErr> Debug for ByteStream<CustErr>

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

Formats the value using the given formatter.

impl<S, T> From<S> for ByteStream

where S: Stream<Item = T> + Send + 'static, T: Into<Bytes>,

fn from(value: S) -> ByteStream

Converts to this type from the input type.

impl<CustErr, Response> FromRes<Streaming, Response, CustErr> for ByteStream

where Response: ClientRes<CustErr> + Send,

async fn from_res(res: Response) -> Result<ByteStream, ServerFnError<CustErr>>

Attempts to deserialize the outputs from a response.

impl<CustErr, Response> IntoRes<Streaming, Response, CustErr> for ByteStream<CustErr>

where Response: Res<CustErr>, CustErr: 'static,

async fn into_res(self) -> Result<Response, ServerFnError<CustErr>>

Attempts to serialize the output into an HTTP response.