Struct actix_web_lab::respond::NdJson

source ·
pub struct NdJson<S> { /* private fields */ }
Expand description

A buffered NDJSON serializing body stream.

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

§Examples

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

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

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

Implementations§

source§

impl<S> NdJson<S>

source

pub fn new(stream: S) -> Self

Constructs a new NdJson from a stream of items.

source§

impl<S> NdJson<S>

source

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

Constructs a new NdJson from an infallible stream of items.

source§

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

source

pub fn into_body_stream(self) -> impl MessageBody

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

source

pub fn into_responder(self) -> impl Responder
where S: 'static, T: 'static, E: 'static,

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

source

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

Creates a stream of serialized chunks.

source§

impl NdJson<Infallible>

source

pub fn mime() -> Mime

Returns the NDJSON MIME type (application/x-ndjson).

Trait Implementations§

source§

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

Auto Trait Implementations§

§

impl<S> Freeze for NdJson<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for NdJson<S>
where S: RefUnwindSafe,

§

impl<S> Send for NdJson<S>
where S: Send,

§

impl<S> Sync for NdJson<S>
where S: Sync,

§

impl<S> UnwindSafe for NdJson<S>
where S: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more