Struct actix_web_lab::respond::Csv

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

A buffered CSV serializing body stream.

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

Examples

fn streaming_data_source() -> impl Stream<Item = [String; 2]> {
    // get item stream from source
}

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

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

Implementations

impl<S> Csv<S>

pub fn new(stream: S) -> Self

Constructs a new Csv from a stream of rows.

impl<S> Csv<S>

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

Constructs a new Csv from an infallible stream of rows.

impl<S, T, E> Csv<S>where
    S: Stream<Item = Result<T, E>>,
    T: Serialize,
    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 Responderwhere
    S: 'static,
    T: 'static,
    E: 'static,

Creates a Responder type with a serializing stream and correct Content-Type header.

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

Creates a stream of serialized chunks.

impl Csv<Infallible>

pub fn mime() -> Mime

Returns the CSV MIME type (text/csv; charset=utf-8).

Trait Implementations

impl<'__pin, S> Unpin for Csv<S>where
    __Origin<'__pin, S>: Unpin,