Struct JsonStream

pub struct JsonStream<T, CustErr = NoCustomError>(/* private fields */);

A stream of typed data encoded as JSON.

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

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<T> JsonStream<T>

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

Creates a new ByteStream from the given stream.

impl<T, CustErr> JsonStream<T, CustErr>

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

Consumes the wrapper, returning a stream of text.

Trait Implementations

impl<T, CustErr> Debug for JsonStream<T, CustErr>

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

Formats the value using the given formatter.

impl<S, T, CustErr> From<S> for JsonStream<T, CustErr>

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

fn from(value: S) -> JsonStream<T, CustErr>

Converts to this type from the input type.

impl<CustErr, T, Response> FromRes<StreamingJson, Response, CustErr> for JsonStream<T>

where Response: ClientRes<CustErr> + Send, T: DeserializeOwned,

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

Attempts to deserialize the outputs from a response.

impl<CustErr, T, Response> IntoRes<StreamingJson, Response, CustErr> for JsonStream<T, CustErr>

where Response: Res<CustErr>, CustErr: 'static, T: Serialize + 'static,

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

Attempts to serialize the output into an HTTP response.