Enum Body 

pub enum Body {
    Empty,
    Bytes(Bytes),
    Stream(BodyStream),
}

An HTTP response body: nothing, some bytes, or a stream of chunks.

Variants

Empty

No body at all — distinct from a zero-length one, so 204 No Content can omit Content-Length entirely.

Bytes(Bytes)

A body already in memory. Its length is known, so Content-Length can be set.

Stream(BodyStream)

A body produced incrementally. Its length is unknown, so it goes out chunked.

Implementations

impl Body

pub fn empty() -> Self

An empty body.

pub fn from_bytes(bytes: impl Into<Bytes>) -> Self

A body from anything byte-like.

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

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

A streaming body.

pub fn size_hint(&self) -> Option<u64>

The body’s length in bytes, when it is known up front. None for a stream.

pub fn is_empty(&self) -> bool

Whether this body is definitely empty. false for a stream, which may yet yield nothing — we cannot know without polling it.

pub async fn collect(self) -> Result<Bytes, Error>

Collect the whole body into memory.

Drains a stream to completion, so only call it on a body you know is bounded — in tests, or on a response you are about to assert against.

Trait Implementations

impl Body for Body

Lets a Body be handed straight to hyper, which writes responses through the http-body trait.

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 is_end_stream(&self) -> bool

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

fn size_hint(&self) -> SizeHint

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

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(text: &'static str) -> Self

Converts to this type from the input type.

impl From<()> for Body

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<Bytes> for Body

fn from(bytes: Bytes) -> Self

Converts to this type from the input type.

impl From<String> for Body

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Body

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

Converts to this type from the input type.

impl IntoResponse for Body

fn into_response(self) -> Response

Build the response.