Struct TextStream

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

A stream of text.

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

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 TextStream

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

Creates a new ByteStream from the given stream.

impl<CustErr> TextStream<CustErr>

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

Consumes the wrapper, returning a stream of text.

Trait Implementations

impl<CustErr> Debug for TextStream<CustErr>

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

Formats the value using the given formatter.

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

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

fn from(value: S) -> TextStream

Converts to this type from the input type.

impl<CustErr, Response> FromRes<StreamingText, Response, CustErr> for TextStream

where Response: ClientRes<CustErr> + Send,

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

Attempts to deserialize the outputs from a response.

impl<CustErr, Response> IntoRes<StreamingText, Response, CustErr> for TextStream<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.