Struct hyper::Body

[+] Show declaration

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

[−] Expand description

A stream of Bytes, used when receiving bodies.

A good default HttpBody to use in many applications.

Methods

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.

pub fn wrap_stream<S, O, E>(stream: S) -> Body where
    S: Stream<Item = Result<O, E>> + Send + Sync + 'static,
    O: Into<Bytes> + 'static,
    E: Into<Box<dyn StdError + Send + Sync>> + 'static, [−]

Wrap a futures Stream in a box inside Body.

Example

let chunks: Vec<Result<_, std::io::Error>> = vec![
    Ok("hello"),
    Ok(" "),
    Ok("world"),
];

let stream = futures_util::stream::iter(chunks);

let body = Body::wrap_stream(stream);

Optional

This function requires enabling the stream feature in your Cargo.toml.

Important traits for OnUpgrade

impl Future for OnUpgrade type Output = Result<Upgraded, Error>;

pub fn on_upgrade(self) -> OnUpgrade[−]

Converts this Body into a Future of a pending HTTP upgrade.

See the upgrade module for more.

Trait Implementations

impl Body for Body[+]

[+] Show hidden undocumented items

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.

fn data(&mut self) -> Data<Self> where
    Self: Unpin, [−]

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

fn trailers(&mut self) -> Trailers<Self> where
    Self: Unpin, [−]

Returns future that resolves to trailers, if any.

impl Debug for Body[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<&'static str> for Body[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<Box<dyn Stream<Item = Result<Bytes, Box<dyn Error + 'static + Sync + Send>>> + 'static + Sync + Send>> for Body[+]

Optional

This function requires enabling the stream feature in your Cargo.toml.

[+] Show hidden undocumented items

fn from(
    stream: Box<dyn Stream<Item = Result<Bytes, Box<dyn StdError + Send + Sync>>> + Send + Sync>
) -> Body[−]

Performs the conversion.

impl From<Bytes> for Body[+]

[+] Show hidden undocumented items

fn from(chunk: Bytes) -> Body[−]

Performs the conversion.

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<String> for Body[+]

[+] Show hidden undocumented items

fn from(s: String) -> Body[−]

Performs the conversion.

impl From<Vec<u8>> for Body[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl Stream for Body[+]

Optional

This function requires enabling the stream feature in your Cargo.toml.

[+] Show hidden undocumented items

type Item = Result<Bytes>

Values yielded by the stream.

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>[−]

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)[−]

Returns the bounds on the remaining length of the stream.