Struct axum::body::StreamBody

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

An http_body::Body created from a Stream.

The purpose of this type is to be used in responses. If you want to extract the request body as a stream consider using BodyStream.

Example

use axum::{
    Router,
    routing::get,
    body::StreamBody,
    response::IntoResponse,
};
use futures::stream::{self, Stream};
use std::io;

async fn handler() -> StreamBody<impl Stream<Item = io::Result<&'static str>>> {
    let chunks: Vec<io::Result<_>> = vec![
        Ok("Hello,"),
        Ok(" "),
        Ok("world!"),
    ];
    let stream = stream::iter(chunks);
    StreamBody::new(stream)
}

let app = Router::new().route("/", get(handler));

Implementations

impl<S> StreamBody<S>

pub fn new(stream: S) -> Self where
    S: TryStream + Send + 'static,
    S::Ok: Into<Bytes>,
    S::Error: Into<BoxError>, 

Create a new StreamBody from a Stream.

Trait Implementations

impl<S> Body for StreamBody<S> where
    S: TryStream,
    S::Ok: Into<Bytes>,
    S::Error: Into<BoxError>, 

type Data = Bytes

Values yielded by the Body.

type Error = Error

The error type this Body might generate.

fn poll_data(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Data, Self::Error>>>

Attempt to pull out the next data buffer of this stream.

fn poll_trailers(
    self: Pin<&mut Self>,
    _cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap>, Self::Error>>

Poll for an optional single HeaderMap of trailers.

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached.

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream.

fn data(&mut self) -> Data<'_, Self> where
    Self: Unpin, 

Returns future that resolves to next data chunk, if any.

fn trailers(&mut self) -> Trailers<'_, Self> where
    Self: Unpin, 

Returns future that resolves to trailers, if any.

fn map_data<F, B>(self, f: F) -> MapData<Self, F> where
    F: FnMut(Self::Data) -> B,
    B: Buf, 

Maps this body’s data value to a different value.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnMut(Self::Error) -> E, 

Maps this body’s error value to a different value.

fn boxed(self) -> BoxBody<Self::Data, Self::Error> where
    Self: 'static + Send + Sync, 

Turn this body into a boxed trait object.

fn boxed_unsync(self) -> UnsyncBoxBody<Self::Data, Self::Error> where
    Self: 'static + Send, 

Turn this body into a boxed trait object that is !Sync.

impl<S> Debug for StreamBody<S>

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

Formats the value using the given formatter.

impl Default for StreamBody<Empty<Result<Bytes, Error>>>

fn default() -> Self

Returns the “default value” for a type.

impl<S> From<S> for StreamBody<S> where
    S: TryStream + Send + 'static,
    S::Ok: Into<Bytes>,
    S::Error: Into<BoxError>, 

fn from(stream: S) -> Self

Converts to this type from the input type.

impl<S> IntoResponse for StreamBody<S> where
    S: TryStream + Send + 'static,
    S::Ok: Into<Bytes>,
    S::Error: Into<BoxError>, 

fn into_response(self) -> Response

Create a response.

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