Struct hyper::Body

[+] Show declaration

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

[−] Expand description

A stream of Chunks, used when receiving bodies.

A good default Payload to use in many applications.

Also implements futures::Stream, so stream combinators may be used.

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>(stream: S) -> Body where
    S: Stream + Send + 'static,
    S::Error: Into<Box<dyn Error + Send + Sync>>,
    Chunk: From<S::Item>, [−]

Wrap a futures Stream in a box inside Body.

Example

let chunks = vec![
    "hello",
    " ",
    "world",
];

let stream = futures::stream::iter_ok::<_, ::std::io::Error>(chunks);

let body = Body::wrap_stream(stream);

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

[+] Show hidden undocumented items

type Data = Chunk

A buffer of bytes representing a single chunk of a body.

type Error = Error

The error type of this stream.

fn poll_data(&mut self) -> Poll<Option<Self::Data>, Self::Error>[−]

Poll for a Data buffer.

fn poll_trailers(&mut self) -> Poll<Option<HeaderMap>, Self::Error>[−]

Poll for an optional single HeaderMap of trailers.

fn is_end_stream(&self) -> bool[−]

A hint that the Body is complete, and doesn't need to be polled more.

fn content_length(&self) -> Option<u64>[−]

Return a length of the total bytes that will be streamed, if known.

impl Default for Body[+]

fn default() -> Body[−]

Returns Body::empty().

impl From<Chunk> for Body[+]

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

fn from(
    stream: Box<dyn Stream<Item = Chunk, Error = Box<dyn Error + Send + Sync>> + Send + 'static>
) -> Body[−]

Performs the conversion.

impl From<Bytes> for Body[+]

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

fn from(slice: &'static [u8]) -> 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<String> for Body[+]

[+] Show hidden undocumented items

fn from(s: String) -> 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<Cow<'static, str>> for Body[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl Debug for Body[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Stream for Body[+]

[+] Show hidden undocumented items

type Item = Chunk

The type of item this stream will yield on success.

type Error = Error

The type of error this stream may generate.

fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error>[−]

Attempt to pull out the next value of this stream, returning None if the stream is finished.

fn wait(self) -> Wait<Self>[−]

Creates an iterator which blocks the current thread until each item of this stream is resolved.

fn into_future(self) -> StreamFuture<Self>[−]

Converts this stream into a Future.

fn map<U, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> U, [−]

Converts a stream of type T to a stream of type U.

fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
    F: FnMut(Self::Error) -> U, [−]

Converts a stream of error type T to a stream of error type U.

fn filter<F>(self, f: F) -> Filter<Self, F> where
    F: FnMut(&Self::Item) -> bool, [−]

Filters the values produced by this stream according to the provided predicate.

fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, [−]

Filters the values produced by this stream while simultaneously mapping them to a different type.

fn then<F, U>(self, f: F) -> Then<Self, F, U> where
    F: FnMut(Result<Self::Item, Self::Error>) -> U,
    U: IntoFuture, [−]

Chain on a computation for when a value is ready, passing the resulting item to the provided closure f.

fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Error = Self::Error>, [−]

Chain on a computation for when a value is ready, passing the successful results to the provided closure f.

fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U> where
    F: FnMut(Self::Error) -> U,
    U: IntoFuture<Item = Self::Item>, [−]

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f.

fn collect(self) -> Collect<Self>[−]

Collect all of the values of this stream into a vector, returning a future representing the result of that computation.

fn concat2(self) -> Concat2<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator,
    Self::Item: Default, [−]

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result.

fn concat(self) -> Concat<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator, [−]

Deprecated since 0.1.14:

please use Stream::concat2 instead

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result.

fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T> where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: IntoFuture<Item = T>,
    Self::Error: From<<Fut as IntoFuture>::Error>, [−]

Execute an accumulating computation over a stream, collecting all the values into one final result.

fn flatten(self) -> Flatten<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error: From<Self::Error>, [−]

Flattens a stream of streams into just one continuous stream.

fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R> where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>, [−]

Skip elements on this stream while the predicate provided resolves to true.

fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R> where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>, [−]

Take elements from this stream while the predicate provided resolves to true.

fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Item = (), Error = Self::Error>, [−]

Runs this stream to completion, executing the provided closure for each element on the stream.

fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, [−]

Map this stream's error to any error implementing From for this stream's Error, returning a new stream.

fn take(self, amt: u64) -> Take<Self>[−]

Creates a new stream of at most amt items of the underlying stream.

fn skip(self, amt: u64) -> Skip<Self>[−]

Creates a new stream which skips amt items of the underlying stream.

fn fuse(self) -> Fuse<Self>[−]

Fuse a stream such that poll will never again be called once it has finished.

fn by_ref(&mut self) -> &mut Self[−]

Borrows a stream, rather than consuming it.

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, [−]

Catches unwinding panics while polling the stream.

fn buffered(self, amt: usize) -> Buffered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error, [−]

An adaptor for creating a buffered list of pending futures.

fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error, [−]

An adaptor for creating a buffered list of pending futures (unordered).

fn merge<S>(self, other: S) -> Merge<Self, S> where
    S: Stream<Error = Self::Error>, [−]

Deprecated:

functionality provided by select now

An adapter for merging the output of two streams.

fn zip<S>(self, other: S) -> Zip<Self, S> where
    S: Stream<Error = Self::Error>, [−]

An adapter for zipping two streams together.

fn chain<S>(self, other: S) -> Chain<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, [−]

Adapter for chaining two stream.

fn peekable(self) -> Peekable<Self>[−]

Creates a new stream which exposes a peek method.

fn chunks(self, capacity: usize) -> Chunks<Self>[−]

An adaptor for chunking up items of the stream inside a vector.

fn select<S>(self, other: S) -> Select<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, [−]

Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first.

fn forward<S>(self, sink: S) -> Forward<Self, S> where
    S: Sink<SinkItem = Self::Item>,
    Self::Error: From<<S as Sink>::SinkError>, [−]

A future that completes after the given stream has been fully processed into the sink, including flushing.

fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
    Self: Sink, [−]

Splits this Stream + Sink object into separate Stream and Sink objects.

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), [−]

Do something with each item of this stream, afterwards passing it on.

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
    F: FnMut(&Self::Error), [−]

Do something with the error of this stream, afterwards passing it on.