Struct StreamBody

Source

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

Expand description

A streaming body wrapper for HTTP responses

StreamBody wraps a stream of bytes and converts it to an HTTP response. This is useful for streaming large amounts of data without buffering the entire response in memory.

§Example

use rustapi_core::stream::StreamBody;
use futures_util::stream;
use bytes::Bytes;

async fn stream_data() -> StreamBody<impl Stream<Item = Result<Bytes, std::convert::Infallible>>> {
    let stream = stream::iter(vec![
        Ok(Bytes::from("chunk 1")),
        Ok(Bytes::from("chunk 2")),
    ]);
    StreamBody::new(stream)
}

Implementations§

Source §

impl<S> StreamBody<S>

Source

pub fn new(stream: S) -> StreamBody<S>

Create a new streaming body from a stream

Source

pub fn content_type(self, content_type: impl Into<String>) -> StreamBody<S>

Set the content type for the response

Trait Implementations§

Source §

impl<S, E> IntoResponse for StreamBody<S>
where S: Stream<Item = Result<Bytes, E>> + Send + 'static, E: Error + Send + Sync + 'static,

Source §

fn into_response(self) -> Response<Body>

Convert self into a Response

Auto Trait Implementations§

§

impl<S> UnwindSafe for StreamBody<S>
where S: 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: 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 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §