Struct NdjsonStream 

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

The NDJSON lines of a byte stream, such as an HttpResponse body.

Yields each non-blank line, without its line ending, once the line is complete (see the module docs for the framing rules). After the first error, a failed read (NdjsonError::Transport), a line that is not UTF-8 (NdjsonError::InvalidUtf8) or a line past the size cap (NdjsonError::LineTooLarge, see max_line_size), the stream ends. It polls the body only when no complete line is buffered, so transport-level idle bounds (StreamTimeouts) see the same waits as before.

Drive an adapter’s decoder over it with FramedChatStream::new, which classifies a failure with NdjsonError::into_error.

Implementations

impl<S> NdjsonStream<S>

pub fn new(body: S) -> Self

Frame body into NDJSON lines, with the default size cap (NdjsonDecoder::DEFAULT_MAX_LINE_SIZE).

pub fn max_line_size(self, limit: usize) -> Self

Set the size cap, in bytes: see NdjsonDecoder::max_line_size. Provider crates set it from their builder’s max_stream_event_size.

Trait Implementations

impl<S: Debug> Debug for NdjsonStream<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S, B, E> Stream for NdjsonStream<S>

where S: Stream<Item = Result<B, E>> + Unpin, B: AsRef<[u8]>,

type Item = Result<String, NdjsonError<E>>

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, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

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

Returns the bounds on the remaining length of the stream.