Struct DisplayStream

pub struct DisplayStream<S> { /* private fields */ }

A buffered line formatting body stream.

Each item yielded by the stream will be written to the response body using its Display implementation.

This has significant memory efficiency advantages over returning an array of lines when the data set is very large because it avoids buffering the entire response.

Examples

fn streaming_data_source() -> impl Stream<Item = u32> {
    // get item stream from source
}

async fn handler() -> impl Responder {
    let data_stream = streaming_data_source();

    DisplayStream::new_infallible(data_stream)
        .into_responder()
}

Implementations

impl<S> DisplayStream<S>

pub fn new(stream: S) -> Self

Constructs a new DisplayStream from a stream of lines.

impl<S> DisplayStream<S>

pub fn new_infallible(stream: S) -> DisplayStream<InfallibleStream<S>>

Constructs a new DisplayStream from an infallible stream of lines.

impl<S, T, E> DisplayStream<S>

where S: Stream<Item = Result<T, E>>, T: Display, E: Into<Box<dyn StdError>> + 'static,

pub fn into_body_stream(self) -> impl MessageBody

Creates a chunked body stream that serializes as CSV on-the-fly.

pub fn into_responder(self) -> impl Responder

where S: 'static, T: 'static, E: 'static,

Creates a Responder type with a line-by-line serializing stream and text/plain content-type header.

pub fn into_chunk_stream(self) -> impl Stream<Item = Result<Bytes, E>>

Creates a stream of serialized chunks.

Trait Implementations

impl<'__pin, S> Unpin for DisplayStream<S>

where PinnedFieldsOf<__Origin<'__pin, S>>: Unpin,