Struct NdjsonStream 

pub struct NdjsonStream<S, T> { /* private fields */ }

A wrapper that converts an async stream of serializable items into NDJSON format.

Each item from the inner stream is serialized to JSON, followed by a newline. The resulting bytes are suitable for sending over HTTP as a streaming response.

Type Parameters

• S: The underlying stream type
• T: The item type that implements Serialize

Example

use fastapi_core::ndjson::NdjsonStream;
use asupersync::stream;
use serde::Serialize;

#[derive(Serialize)]
struct Item { id: i64, name: String }

let items = stream::iter(vec![
    Item { id: 1, name: "Alice".into() },
    Item { id: 2, name: "Bob".into() },
]);

let ndjson_stream = NdjsonStream::new(items);
// Yields: b'{"id":1,"name":"Alice"}\n' then b'{"id":2,"name":"Bob"}\n'

Implementations

impl<S, T> NdjsonStream<S, T>

pub fn new(stream: S) -> Self

Create a new NDJSON stream wrapper with default configuration.

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

Create a new NDJSON stream wrapper with custom configuration.

Trait Implementations

impl<S, T> Stream for NdjsonStream<S, T>

where S: Stream<Item = T> + Unpin, T: Serialize + Unpin,

type Item = Vec<u8>

The type of values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.