Struct hyper::body::Body

#[must_use = "streams do nothing unless polled"]pub struct Body { /* fields omitted */ }

A stream of Bytes, used when receiving bodies.

A good default HttpBody to use in many applications.

Implementations

impl Body

pub fn empty() -> Body

Create an empty Body stream.

Example

use hyper::{Body, Request};

// create a `GET /` request
let get = Request::new(Body::empty());

pub fn channel() -> (Sender, Body)

Create a Body stream with an associated sender half.

Useful when wanting to stream chunks from another thread.

Trait Implementations

impl Body for Body

type Data = Bytes

Values yielded by the Body.

type Error = Error

The error type this Body might generate.

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

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

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

Poll for an optional single HeaderMap of trailers.

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.

pub fn data(&mut self) -> Data<'_, Self> where
    Self: Unpin, 

Returns future that resolves to next data chunk, if any.

pub fn trailers(&mut self) -> Trailers<'_, Self> where
    Self: Unpin, 

Returns future that resolves to trailers, if any.

pub fn map_data<F, B>(self, f: F) -> MapData<Self, F> where
    F: FnMut(Self::Data) -> B,
    B: Buf, 

Maps this body's data value to a different value.

pub fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnMut(Self::Error) -> E, 

Maps this body's error value to a different value.

pub fn boxed(self) -> BoxBody<Self::Data, Self::Error> where
    Self: Send + Sync + 'static, 

Turn this body into a boxed trait object.

impl Debug for Body

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

Formats the value using the given formatter.

impl Default for Body

fn default() -> Body

Returns Body::empty().

impl From<&'static [u8]> for Body

fn from(slice: &'static [u8]) -> Body

Performs the conversion.

impl From<&'static str> for Body

fn from(slice: &'static str) -> Body

Performs the conversion.

impl From<Bytes> for Body

fn from(chunk: Bytes) -> Body

Performs the conversion.

impl From<Cow<'static, [u8]>> for Body

fn from(cow: Cow<'static, [u8]>) -> Body

Performs the conversion.

impl From<Cow<'static, str>> for Body

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

Performs the conversion.

impl From<String> for Body

fn from(s: String) -> Body

Performs the conversion.

impl From<Vec<u8, Global>> for Body

fn from(vec: Vec<u8>) -> Body

Performs the conversion.