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.

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.

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<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.