Skip to main content

NdjsonResponse

Struct NdjsonResponse 

Source
pub struct NdjsonResponse<S, T> { /* private fields */ }
Expand description

Builder for creating NDJSON streaming responses.

This wraps a stream of serializable items and converts it to an HTTP response with the appropriate Content-Type: application/x-ndjson header.

§Example

use fastapi_core::ndjson::NdjsonResponse;
use fastapi_core::Response;
use asupersync::stream;
use serde::Serialize;

#[derive(Serialize)]
struct Record { id: i64, value: f64 }

async fn export_data() -> Response {
    let records = stream::iter(vec![
        Record { id: 1, value: 1.5 },
        Record { id: 2, value: 2.7 },
        Record { id: 3, value: 3.14 },
    ]);

    NdjsonResponse::new(records).into_response()
}

§Headers Set

  • Content-Type: application/x-ndjson
  • Cache-Control: no-cache (streaming data shouldn’t be cached)
  • Transfer-Encoding: chunked (implicit for streaming)

Implementations§

Source§

impl<S, T> NdjsonResponse<S, T>
where S: Stream<Item = T> + Send + Unpin + 'static, T: Serialize + Send + Unpin + 'static,

Source

pub fn new(stream: S) -> Self

Create a new NDJSON response from a stream of serializable items.

Source

pub fn with_config(stream: S, config: NdjsonConfig) -> Self

Create an NDJSON response with custom configuration.

Source

pub fn into_response(self) -> Response

Convert to an HTTP Response.

Sets the appropriate headers for NDJSON streaming:

  • Content-Type: application/x-ndjson
  • Cache-Control: no-cache
  • X-Accel-Buffering: no (disables nginx buffering)

Auto Trait Implementations§

§

impl<S, T> Freeze for NdjsonResponse<S, T>
where S: Freeze,

§

impl<S, T> RefUnwindSafe for NdjsonResponse<S, T>

§

impl<S, T> Send for NdjsonResponse<S, T>
where S: Send, T: Send,

§

impl<S, T> Sync for NdjsonResponse<S, T>
where S: Sync, T: Sync,

§

impl<S, T> Unpin for NdjsonResponse<S, T>
where S: Unpin, T: Unpin,

§

impl<S, T> UnwindSafe for NdjsonResponse<S, T>
where S: UnwindSafe, T: 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: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

Source§

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<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
Source§

impl<T> ResponseProduces<T> for T