Struct Body 

pub struct Body { /* private fields */ }

An implementation for http_body::Body.

Implementations

impl Body

pub fn empty() -> Self

Create an empty body.

pub fn from_incoming(incoming: Incoming) -> Self

Create a body by Incoming.

Compared to Body::from_body, this function avoids overhead of allocating by Box and dynamic dispatch by dyn http_body::Body.

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

where S: Stream<Item = Result<Frame<Bytes>, BoxError>> + Send + Sync + 'static,

Create a body by a Stream with Item = Result<Frame<Bytes>, BoxError>.

pub fn from_body<B>(body: B) -> Self

where B: Body<Data = Bytes> + Send + Sync + 'static, B::Error: Into<BoxError>,

Create a body by another http_body::Body instance.

pub fn try_clone(&self) -> Option<Self>

Try to clone the body.

Only in-memory bodies (created from bytes, string, Body::empty, etc.) can be cloned, and the clone is cheap since the underlying Bytes is reference-counted (a shallow clone, the payload is not copied).

Streaming bodies (Body::from_stream, Body::from_incoming, Body::from_body) are one-shot and cannot be replayed, so this method returns None for them. This is mainly used by redirect-following, where a request may need to be re-sent: a request with a non-cloneable body will not be followed across redirects.

Trait Implementations

impl Body for Body

type Data = Bytes

Values yielded by the Body.

type Error = Box<dyn Error + Sync + Send>

The error type this Body might generate.

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

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

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.

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(value: &'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(value: Bytes) -> Self

Converts to this type from the input type.

impl From<FastStr> for Body

fn from(value: FastStr) -> Self

Converts to this type from the input type.

impl From<LinkedBytes> for Body

fn from(value: LinkedBytes) -> Self

Converts to this type from the input type.

impl From<String> for Body

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Body

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

Converts to this type from the input type.

impl<'pin> Unpin for Body

where PinnedFieldsOf<__Body<'pin>>: Unpin,