Enum xitca_http::body::ResponseBody

pub enum ResponseBody<B = BoxBody> {
    None,
    Bytes {
        bytes: Bytes,
    },
    Stream {
        stream: B,
    },
}

A unified response body type. Generic type is for custom pinned response body(type implement Stream).

Variants

None

Bytes

Fields

bytes: Bytes

Stream

Fields

stream: B

Implementations

impl ResponseBody

pub fn box_stream<B, E>(stream: B) -> Self

where B: Stream<Item = Result<Bytes, E>> + 'static, E: Into<BodyError>,

Construct a new Stream variant of ResponseBody with default type as BoxBody

impl<B> ResponseBody<B>

pub const fn none() -> Self

indicate no body is attached to response. content-length and transfer-encoding headers would not be added to response when BodySize is used for inferring response body type.

pub const fn empty() -> Self

indicate empty body is attached to response. content-length: 0 header would be added to response when BodySize is used for inferring response body type.

pub fn stream(stream: B) -> Self

Construct a new Stream variant of ResponseBody

pub fn bytes<B2>(bytes: B2) -> Self

where Bytes: From<B2>,

Construct a new Bytes variant of ResponseBody

pub fn into_boxed<E>(self) -> ResponseBody

where B: Stream<Item = Result<Bytes, E>> + 'static, E: Error + Send + Sync + 'static,

erase generic body type by boxing the variant.

Trait Implementations

impl<B> Default for ResponseBody<B>

fn default() -> Self

Returns the “default value” for a type.

impl<B> From<&'static [u8]> for ResponseBody<B>

fn from(item: &'static [u8]) -> Self

Converts to this type from the input type.

impl<B> From<&'static str> for ResponseBody<B>

fn from(item: &'static str) -> Self

Converts to this type from the input type.

impl<B> From<Box<[u8]>> for ResponseBody<B>

fn from(item: Box<[u8]>) -> Self

Converts to this type from the input type.

impl<B> From<Box<str>> for ResponseBody<B>

fn from(str: Box<str>) -> Self

Converts to this type from the input type.

impl From<BoxBody> for ResponseBody

fn from(stream: BoxBody) -> Self

Converts to this type from the input type.

impl<B> From<Bytes> for ResponseBody<B>

fn from(item: Bytes) -> Self

Converts to this type from the input type.

impl<B> From<BytesMut> for ResponseBody<B>

fn from(item: BytesMut) -> Self

Converts to this type from the input type.

impl<B> From<Cow<'static, str>> for ResponseBody<B>

fn from(str: Cow<'static, str>) -> Self

Converts to this type from the input type.

impl<B> From<NoneBody<B>> for ResponseBody

fn from(_: NoneBody<B>) -> Self

Converts to this type from the input type.

impl<B> From<Once<B>> for ResponseBody

where B: Into<Bytes>,

fn from(once: Once<B>) -> Self

Converts to this type from the input type.

impl<B> From<String> for ResponseBody<B>

fn from(item: String) -> Self

Converts to this type from the input type.

impl<B> From<Vec<u8>> for ResponseBody<B>

fn from(item: Vec<u8>) -> Self

Converts to this type from the input type.

impl<B, E> Stream for ResponseBody<B>

where B: Stream<Item = Result<Bytes, E>>,

type Item = Result<Bytes, 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.

impl<'__pin, B> Unpin for ResponseBody<B>

where __Origin<'__pin, B>: Unpin,