Struct Body 

pub struct Body { /* private fields */ }

The body of a request or a response: bytes held in memory, a stream, or a stream that can be made again.

A body held in memory can be cloned (Body::try_clone), which is what lets a retry layer send a request again. So can a body made from a replayable Upload, such as a file, which is opened again for each attempt. Any other stream can be read once.

Implementations

impl Body

pub fn empty() -> Self

An empty body.

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

where B: Body + MaybeSend + MaybeSync + 'static, B::Data: Into<Bytes>, B::Error: Into<BoxError>,

A body that wraps another http_body::Body, such as the body of a hyper or reqwest response. It must be Send and Sync, except on WebAssembly (MaybeSend, MaybeSync).

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

where S: TryStream + MaybeSend + 'static, S::Ok: Into<Bytes>, S::Error: Into<BoxError>,

A body that reads the chunks of a stream, such as a file read with tokio_util::io::ReaderStream. It must be Send, except on WebAssembly (MaybeSend).

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

A copy of the body: a body held in memory, or a fresh start of one that can be made again (a file Upload, say); None for a stream that can be read once.

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

The bytes of a body held in memory; None for a stream.

pub async fn collect_bytes(self) -> Result<Bytes, BoxError>

Reads the whole body into memory.

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 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 [u8]> for Body

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

Converts to this type from the input type.

impl From<&'static str> for Body

fn from(text: &'static str) -> 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<Upload> for Body

fn from(upload: Upload) -> 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.