Enum Body 

pub enum Body {
    Bytes(Bytes),
    Stream(Pin<Box<dyn Stream<Item = Result<Bytes>> + Send + 'static>>),
}

A response body.

Construct buffered bodies with From (Body::from(bytes), "text".into()), an empty body with Body::empty, or a streaming body with Body::from_stream. The engine sends buffered bodies in one shot and streamed bodies frame-by-frame.

Variants

Bytes(Bytes)

A fully-buffered, in-memory body.

Stream(Pin<Box<dyn Stream<Item = Result<Bytes>> + Send + 'static>>)

A lazily-produced stream of byte chunks.

Implementations

impl Body

pub fn empty() -> Self

An empty buffered body.

pub fn from_stream<S, E>(stream: S) -> Self

where S: Stream<Item = Result<Bytes, E>> + Send + 'static, E: Display,

Build a streaming body from any Stream of byte chunks. Chunk errors are converted into Error and surface when the body is read/collected.

pub fn as_bytes(&self) -> Option<&Bytes>

Borrow the buffered bytes, or None if this body is a stream. Used by middleware that only post-processes already-materialized bodies.

pub fn as_slice(&self) -> Option<&[u8]>

Borrow the buffered bytes as a slice, or None for a stream.

pub fn is_empty(&self) -> bool

True if this is a buffered, empty body. A stream is never reported empty (its length is unknown until read).

pub async fn into_bytes(self) -> Result<Bytes>

Collect the whole body into Bytes (returns the buffer directly when already buffered, or drains the stream).

Trait Implementations

impl Body for Body

Body is an http_body::Body, so it can be handed to anything written against the http/http-body crates — which is what makes the tower adapter possible without a wrapper type at every boundary.

type Data = Bytes

Values yielded by the Body.

type Error = Error

The error type this Body might generate.

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

Attempt to pull out the next frame of this stream.

fn size_hint(&self) -> SizeHint

A hint that returns the bounds on the remaining length of the stream.

fn is_end_stream(&self) -> bool

A hint that may return true when the end of stream has been reached.

impl Debug for Body

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

Formats the value using the given formatter.

impl Default for Body

fn default() -> Self

Returns the “default value” for a type.

impl From<&'static str> for Body

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

Converts to this type from the input type.

impl From<Bytes> for Body

fn from(b: Bytes) -> Self

Converts to this type from the input type.

impl From<String> for Body

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Body

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

Converts to this type from the input type.

impl PartialEq<Bytes> for Body

Compare a body to Bytes (true only when buffered and equal). Lets tests and callers assert on buffered bodies ergonomically.

fn eq(&self, other: &Bytes) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.