Struct axum_extra::json_lines::JsonLines

pub struct JsonLines<S, T = AsExtractor> { /* private fields */ }

Available on crate feature json-lines only.

A stream of newline delimited JSON.

This can be used both as an extractor and as a response.

As extractor

use axum_extra::json_lines::JsonLines;
use futures::stream::StreamExt;

async fn handler(mut stream: JsonLines<serde_json::Value>) {
    while let Some(value) = stream.next().await {
        // ...
    }
}

As response

use axum::{BoxError, response::{IntoResponse, Response}};
use axum_extra::json_lines::JsonLines;
use futures::stream::Stream;

fn stream_of_values() -> impl Stream<Item = Result<serde_json::Value, BoxError>> {
}

async fn handler() -> Response {
    JsonLines::new(stream_of_values()).into_response()
}

Implementations

impl<S> JsonLines<S, AsResponse>

pub fn new(stream: S) -> Self

Create a new JsonLines from a stream of items.

Trait Implementations

impl<B, T> FromRequest<B> for JsonLines<T, AsExtractor> where
    B: HttpBody + Send + 'static,
    B::Data: Into<Bytes>,
    B::Error: Into<BoxError>,
    T: DeserializeOwned, 

type Rejection = BodyAlreadyExtracted

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request<'life0, 'async_trait>(
    req: &'life0 mut RequestParts<B>
) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Perform the extraction.

impl<S> IntoResponse for JsonLines<S, AsResponse> where
    S: TryStream + Send + 'static,
    S::Ok: Serialize + Send,
    S::Error: Into<BoxError>, 

fn into_response(self) -> Response

Create a response.

impl<T> Stream for JsonLines<T, AsExtractor>

type Item = Result<T, Error>

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.

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